Function PaymentPushesApiAxiosParamCreator

Returns {
    apiPaymentPushesBulkPost: ((paymentPushBulkCreateDeets?: PaymentPushBulkCreateDeets, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    apiPaymentPushesFeesPost: ((paymentPushCreateDeets?: PaymentPushCreateDeets, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    createPaymentPush: ((paymentPushCreateDeets?: PaymentPushCreateDeets, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    getBulkFees: ((paymentPushBulkCreateDeets?: PaymentPushBulkCreateDeets, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    getPaymentPushesById: ((id: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    updatePushPayment: ((id: string, paymentPushUpdateDeets?: PaymentPushUpdateDeets, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
}

• apiPaymentPushesBulkPost: ((paymentPushBulkCreateDeets?: PaymentPushBulkCreateDeets, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  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

  Throws

  • • (paymentPushBulkCreateDeets?, options?): Promise<RequestArgs>

    • Parameters

      • OptionalpaymentPushBulkCreateDeets: PaymentPushBulkCreateDeets

        PaymentPushBulk_CreateDeets
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• apiPaymentPushesFeesPost: ((paymentPushCreateDeets?: PaymentPushCreateDeets, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Throws

  • • (paymentPushCreateDeets?, options?): Promise<RequestArgs>

    • Parameters

      • OptionalpaymentPushCreateDeets: PaymentPushCreateDeets
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• createPaymentPush: ((paymentPushCreateDeets?: PaymentPushCreateDeets, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  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

  Throws

  • • (paymentPushCreateDeets?, options?): Promise<RequestArgs>

    • Parameters

      • OptionalpaymentPushCreateDeets: PaymentPushCreateDeets

        PaymentPush_CreateDeets
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• getBulkFees: ((paymentPushBulkCreateDeets?: PaymentPushBulkCreateDeets, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

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

  Throws

  • • (paymentPushBulkCreateDeets?, options?): Promise<RequestArgs>

    • Parameters

      • OptionalpaymentPushBulkCreateDeets: PaymentPushBulkCreateDeets
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

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

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

  Throws

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

    • Parameters

      • id: string
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• updatePushPayment: ((id: string, paymentPushUpdateDeets?: PaymentPushUpdateDeets, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  summary Update push payment record

  Throws

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

    • Parameters

      • id: string
      • OptionalpaymentPushUpdateDeets: PaymentPushUpdateDeets
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>