Function PaymentPushesApiFactory

PaymentPushesApi - factory interface export

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

  • Parameters

    • Optionalconfiguration: Configuration
    • OptionalbasePath: string
    • Optionalaxios: AxiosInstance

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

    • apiPaymentPushesBulkPost:function
      • apiPaymentPushesBulkPost(paymentPushBulkCreateDeets?, options?): 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 AxiosPromise<PaymentBulkResultResponseListResponse>

        Throws

    • apiPaymentPushesFeesPost:function
      • apiPaymentPushesFeesPost(paymentPushCreateDeets?, options?): AxiosPromise<Fees>

      • Parameters

        • OptionalpaymentPushCreateDeets: PaymentPushCreateDeets
        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns AxiosPromise<Fees>

        Throws

    • createPaymentPush:function
      • createPaymentPush(paymentPushCreateDeets?, options?): 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 AxiosPromise<Payment>

        Throws

    • getBulkFees:function
    • getPaymentPushesById:function
      • getPaymentPushesById(id, options?): AxiosPromise<PaymentPushResponse>

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

        Parameters

        • id: string
        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns AxiosPromise<PaymentPushResponse>

        Throws

    • updatePushPayment:function
      • updatePushPayment(id, paymentPushUpdateDeets?, options?): AxiosPromise<Payment>

      • summary Update push payment record

        Parameters

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

          Override http request option.

        Returns AxiosPromise<Payment>

        Throws

Settings

Member Visibility