Function PaymentTransferApiFactory

PaymentTransferApi - factory interface export

  • PaymentTransferApiFactory(configuration?, basePath?, axios?): {
        apiPaymentTransferCancelPut(paymentTransferReadDeets?: PaymentTransferReadDeets, options?: RawAxiosRequestConfig): AxiosPromise<PaymentTransfer>;
        getTransferDetails(id: string, userId?: string, options?: RawAxiosRequestConfig): AxiosPromise<PaymentTransfer>;
        initiateTransfer(paymentTransferCreateDeets?: PaymentTransferCreateDeets, options?: RawAxiosRequestConfig): AxiosPromise<PaymentTransfer>;
        listPaymentTransfers(status?: string, limit?: number, page?: number, userId?: string, options?: RawAxiosRequestConfig): AxiosPromise<PaymentTransferListResponse>;
    }

  • Parameters

    • Optionalconfiguration: Configuration
    • OptionalbasePath: string
    • Optionalaxios: AxiosInstance

    Returns {
        apiPaymentTransferCancelPut(paymentTransferReadDeets?: PaymentTransferReadDeets, options?: RawAxiosRequestConfig): AxiosPromise<PaymentTransfer>;
        getTransferDetails(id: string, userId?: string, options?: RawAxiosRequestConfig): AxiosPromise<PaymentTransfer>;
        initiateTransfer(paymentTransferCreateDeets?: PaymentTransferCreateDeets, options?: RawAxiosRequestConfig): AxiosPromise<PaymentTransfer>;
        listPaymentTransfers(status?: string, limit?: number, page?: number, userId?: string, options?: RawAxiosRequestConfig): AxiosPromise<PaymentTransferListResponse>;
    }

    • apiPaymentTransferCancelPut:function
    • getTransferDetails:function
      • getTransferDetails(id, userId?, options?): AxiosPromise<PaymentTransfer>

      • summary Retrieve a payment transfer by ID

        Parameters

        • id: string

          The id of the record you wish to retrieve

        • OptionaluserId: string

          The user id to operate on their behalf (tenants only)

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns AxiosPromise<PaymentTransfer>

        Throws

    • initiateTransfer:function
    • listPaymentTransfers:function
      • listPaymentTransfers(status?, limit?, page?, userId?, options?): AxiosPromise<PaymentTransferListResponse>

      • summary Retrieve a list of payment transfers

        Parameters

        • Optionalstatus: string
        • Optionallimit: number

          A limit of the number of objects to be returned for the next page, between 1 and 100. The default is 25

        • Optionalpage: number

          1-based page index for paginated results

        • OptionaluserId: string

          The user id to operate on their behalf (tenants only)

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns AxiosPromise<PaymentTransferListResponse>

        Throws

Settings

Member Visibility