Function PaymentTransferApiFp

PaymentTransferApi - functional programming interface export

  • PaymentTransferApiFp(configuration?): {
        apiPaymentTransfersCancelPut(paymentTransferReadDeets?: PaymentTransferReadDeets, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentTransfer>)>;
        getTransferDetails(id: string, userId?: string, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentTransfer>)>;
        initiateTransfer(paymentTransferCreateDeets?: PaymentTransferCreateDeets, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentTransfer>)>;
        listPaymentTransfers(status?: string, direction?: PaymentDirection, limit?: number, page?: number, userId?: string, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentTransferListResponse>)>;
        retryPayout(id: string, paymentTransferRetryDeets?: PaymentTransferRetryDeets, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentTransfer>)>;
    }

  • Parameters

    Returns {
        apiPaymentTransfersCancelPut(paymentTransferReadDeets?: PaymentTransferReadDeets, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentTransfer>)>;
        getTransferDetails(id: string, userId?: string, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentTransfer>)>;
        initiateTransfer(paymentTransferCreateDeets?: PaymentTransferCreateDeets, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentTransfer>)>;
        listPaymentTransfers(status?: string, direction?: PaymentDirection, limit?: number, page?: number, userId?: string, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentTransferListResponse>)>;
        retryPayout(id: string, paymentTransferRetryDeets?: PaymentTransferRetryDeets, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentTransfer>)>;
    }

    • apiPaymentTransfersCancelPut:function
      • apiPaymentTransfersCancelPut(paymentTransferReadDeets?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentTransfer>)>

      • summary Cancel pending transfer

        Parameters

        • OptionalpaymentTransferReadDeets: PaymentTransferReadDeets
        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentTransfer>)>

        Throws

    • getTransferDetails:function
      • getTransferDetails(id, userId?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => 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 Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentTransfer>)>

        Throws

    • initiateTransfer:function
      • initiateTransfer(paymentTransferCreateDeets?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentTransfer>)>

      • summary Initiate balance withdrawal

        Parameters

        • OptionalpaymentTransferCreateDeets: PaymentTransferCreateDeets
        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentTransfer>)>

        Throws

    • listPaymentTransfers:function
      • listPaymentTransfers(status?, direction?, limit?, page?, userId?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentTransferListResponse>)>

      • summary Retrieve a list of payment transfers

        Parameters

        • Optionalstatus: string
        • Optionaldirection: PaymentDirection

          push request smartContract paymentCycle transfer payout

        • 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 Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentTransferListResponse>)>

        Throws

    • retryPayout:function
      • retryPayout(id, paymentTransferRetryDeets?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentTransfer>)>

      • summary Retry Failed Payout Transfers

        Parameters

        • id: string
        • OptionalpaymentTransferRetryDeets: PaymentTransferRetryDeets
        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentTransfer>)>

        Throws

Settings

Member Visibility