Function PaymentPushesApiFp

Returns {
    apiPaymentPushesBulkPost(paymentPushBulkCreateDeets?: PaymentPushBulkCreateDeets, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentBulkResultResponseListResponse>)>;
    apiPaymentPushesFeesPost(paymentPushCreateDeets?: PaymentPushCreateDeets, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Fees>)>;
    createPaymentPush(paymentPushCreateDeets?: PaymentPushCreateDeets, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Payment>)>;
    getBulkFees(paymentPushBulkCreateDeets?: PaymentPushBulkCreateDeets, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<FeesBulkListResponse>)>;
    getPaymentPushesById(id: string, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentPushResponse>)>;
    updatePushPayment(id: string, paymentPushUpdateDeets?: PaymentPushUpdateDeets, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Payment>)>;
}

• apiPaymentPushesBulkPost:function

  • apiPaymentPushesBulkPost(paymentPushBulkCreateDeets?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentBulkResultResponseListResponse>)>

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

    Throws

• apiPaymentPushesFeesPost:function

  • apiPaymentPushesFeesPost(paymentPushCreateDeets?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Fees>)>

  • Parameters

    • OptionalpaymentPushCreateDeets: PaymentPushCreateDeets
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• createPaymentPush:function

  • createPaymentPush(paymentPushCreateDeets?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Payment>)>

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

    Throws

• getBulkFees:function

  • getBulkFees(paymentPushBulkCreateDeets?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<FeesBulkListResponse>)>

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

    Parameters

    • OptionalpaymentPushBulkCreateDeets: PaymentPushBulkCreateDeets
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• getPaymentPushesById:function

  • getPaymentPushesById(id, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentPushResponse>)>

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

    Parameters

    • id: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• updatePushPayment:function

  • updatePushPayment(id, paymentPushUpdateDeets?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Payment>)>

  • summary Update push payment record

    Parameters

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

      Override http request option.

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

    Throws