Class PaymentPushesApi

PaymentPushesApi - object-oriented interface export PaymentPushesApi

Hierarchy (view full)

Constructors

constructor

Properties

axios basePath configuration

Methods

apiPaymentPushesBulkPost apiPaymentPushesFeesPost createPaymentPush getBulkFees getPaymentPushesById updatePushPayment

Constructors

constructor

Properties

Protectedaxios

axios: AxiosInstance = globalAxios

ProtectedbasePath

basePath: string = BASE_PATH

Protectedconfiguration

configuration: undefined | Configuration

Methods

apiPaymentPushesBulkPost

  • apiPaymentPushesBulkPost(paymentPushBulkCreateDeets?, options?): Promise<AxiosResponse<PaymentBulkResultResponseListResponse, any>>

  • Creates PaymentPushes in bulk, which send payments to the specified recipients. In order to create PaymentPushes on behalf of someone other than the logged in account the sender must be registered as a Tenant and have PaymentPush create scope.

    Create scope permissions for the sending user. The PaymentPush workflow is high-level payment api abstracting many details about how The funds are flowing. For more information see Understanding Payments in Mozaic

    summary Create payment pushes in bulk

    Parameters

    • OptionalpaymentPushBulkCreateDeets: PaymentPushBulkCreateDeets

      PaymentPushBulk_CreateDeets

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<PaymentBulkResultResponseListResponse, any>>

    Throws

    memberof PaymentPushesApi

apiPaymentPushesFeesPost

  • apiPaymentPushesFeesPost(paymentPushCreateDeets?, options?): Promise<AxiosResponse<Fees, any>>

  • Parameters

    • OptionalpaymentPushCreateDeets: PaymentPushCreateDeets
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<Fees, any>>

    Throws

    memberof PaymentPushesApi

createPaymentPush

  • createPaymentPush(paymentPushCreateDeets?, options?): Promise<AxiosResponse<Payment, any>>

  • Creates a PaymentPush which sends a payment to the specified recipient. In order to create PaymentPushes on behalf of someone other than the logged in account the sender must be registered as a Tenant and have PaymentPush create scope.

    Create scope permissions for the sending user. The PaymentPush workflow is high-level payment api abstracting many details about how The funds are flowing. For more information see Understanding Payments in Mozaic

    summary Create a PaymentPush

    Parameters

    • OptionalpaymentPushCreateDeets: PaymentPushCreateDeets

      PaymentPush_CreateDeets

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<Payment, any>>

    Throws

    memberof PaymentPushesApi

getBulkFees

  • getBulkFees(paymentPushBulkCreateDeets?, options?): Promise<AxiosResponse<FeesBulkListResponse, any>>

  • summary Calculate fee estimates for individual transactions within a bulk payment.

    Parameters

    • OptionalpaymentPushBulkCreateDeets: PaymentPushBulkCreateDeets
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<FeesBulkListResponse, any>>

    Throws

    memberof PaymentPushesApi

getPaymentPushesById

  • getPaymentPushesById(id, options?): Promise<AxiosResponse<PaymentPushResponse, any>>

  • Returns a single PaymentPushCreate if found summary Find a PaymentPushCreate by ID

    Parameters

    • id: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<PaymentPushResponse, any>>

    Throws

    memberof PaymentPushesApi

updatePushPayment

  • updatePushPayment(id, paymentPushUpdateDeets?, options?): Promise<AxiosResponse<Payment, any>>

  • summary Update push payment record

    Parameters

    • id: string
    • OptionalpaymentPushUpdateDeets: PaymentPushUpdateDeets
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<Payment, any>>

    Throws

    memberof PaymentPushesApi

Settings

Member Visibility

On This Page

Constructors
Properties
Methods