Function PaymentTransferApiAxiosParamCreator

PaymentTransferApi - axios parameter creator export

  • PaymentTransferApiAxiosParamCreator(configuration?): {
        apiPaymentTransferCancelPut: ((paymentTransferReadDeets?: PaymentTransferReadDeets, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        getTransferDetails: ((id: string, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        initiateTransfer: ((paymentTransferCreateDeets?: PaymentTransferCreateDeets, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        listPaymentTransfers: ((status?: string, limit?: number, page?: number, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    }

  • Parameters

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

    • apiPaymentTransferCancelPut: ((paymentTransferReadDeets?: PaymentTransferReadDeets, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      summary Cancel pending transfer

      Throws

    • getTransferDetails: ((id: string, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      summary Retrieve a payment transfer by ID

      Throws

        • (id, userId?, options?): Promise<RequestArgs>

        • 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<RequestArgs>

    • initiateTransfer: ((paymentTransferCreateDeets?: PaymentTransferCreateDeets, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      summary Initiate balance withdrawal

      Throws

    • listPaymentTransfers: ((status?: string, limit?: number, page?: number, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      summary Retrieve a list of payment transfers

      Throws

        • (status?, limit?, page?, userId?, options?): Promise<RequestArgs>

        • 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 Promise<RequestArgs>

Settings

Member Visibility