Function PaymentsApiAxiosParamCreator

Returns {
    apiPaymentsCreatePaymentIntentPost: ((paymentIntentRequestDeets?: PaymentIntentRequestDeets, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    cancelPayment: ((id: string, paymentCancelDeets?: PaymentCancelDeets, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    getPayment: ((id: string, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    getPaymentsByTransactionId: ((transactionId: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    getPendingPayments: ((status?: AcceptPaymentStatusEnum, limit?: number, page?: number, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    getTransactionStatuses: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    getVirtualReceivingAccount: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    hasPaymentsOrContacts: ((xCaller?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    listPayments: ((orchestrationId?: string, paymentSource?: PaymentSourceEnum, paymentSourceId?: string, paymentAcceptStatuses?: AcceptPaymentStatusEnum[], limit?: number, page?: number, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    searchPayments: ((minAmount?: number, maxAmount?: number, fromDate?: string, toDate?: string, statuses?: string[], paymentTypes?: string[], id?: string, shortId?: string, toHandle?: string, toEmail?: string, toPhone?: string, toName?: string, toPersonaId?: string, toUserId?: string, toUserAccountId?: string, toIsAcceptedContact?: boolean, toCountryCode?: string, toExternalId?: string, toAvatar?: AvatarSize[], toId?: string, toCreated?: string, toShortId?: string, toObjectName?: string, limit?: number, page?: number, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    updatePaymentDetails: ((id: string, paymentDetailsUpdateDeets?: PaymentDetailsUpdateDeets, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    updatePendingPayments: ((paymentAcceptDeets?: PaymentAcceptDeets, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
}

• apiPaymentsCreatePaymentIntentPost: ((paymentIntentRequestDeets?: PaymentIntentRequestDeets, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  summary Test method for invoice payment intent generation

  Throws

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

    • Parameters

      • OptionalpaymentIntentRequestDeets: PaymentIntentRequestDeets
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• cancelPayment: ((id: string, paymentCancelDeets?: PaymentCancelDeets, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  summary Cancel a payment

  Throws

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

    • Parameters

      • id: string
      • OptionalpaymentCancelDeets: PaymentCancelDeets
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

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

  Returns a single payment if found summary Retrieve a payment 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>

• getPaymentsByTransactionId: ((transactionId: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Returns a list of payments if found summary Retrieves all payments for a transaction id

  Throws

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

    • Parameters

      • transactionId: string
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

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

  summary List aggregated Pending or Suspended payments

  Throws

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

    • Parameters

      • Optionalstatus: AcceptPaymentStatusEnum

        pending accepted suspended
      • 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>

• getTransactionStatuses: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  summary List Transaction Statuses

  Throws

  • • (options?): Promise<RequestArgs>

    • Parameters

      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• getVirtualReceivingAccount: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  summary Retrieve Customer Virtual Receiving Account

  Throws

  • • (options?): Promise<RequestArgs>

    • Parameters

      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• hasPaymentsOrContacts: ((xCaller?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Returns a true/false for any payment or contact if found summary Retrieve if has any payment or contact. Only use this to detect if the user should be sent to the waitlist. Do not use it to check if the user currently has payments or contacts as the results are cached in AccountSettings.

  Throws

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

    • Parameters

      • OptionalxCaller: string
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• listPayments: ((orchestrationId?: string, paymentSource?: PaymentSourceEnum, paymentSourceId?: string, paymentAcceptStatuses?: AcceptPaymentStatusEnum[], limit?: number, page?: number, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  summary Retrieve a list of payments

  Throws

  • • (orchestrationId?, paymentSource?, paymentSourceId?, paymentAcceptStatuses?, limit?, page?, userId?, options?): Promise<RequestArgs>

    • Parameters

      • OptionalorchestrationId: string

        The id of the payment cycle for which to list the payments
      • OptionalpaymentSource: PaymentSourceEnum

        push-payment contract simple-contract payment-cycle tip-link transfer
      • OptionalpaymentSourceId: string
      • OptionalpaymentAcceptStatuses: AcceptPaymentStatusEnum[]
      • 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>

• searchPayments: ((minAmount?: number, maxAmount?: number, fromDate?: string, toDate?: string, statuses?: string[], paymentTypes?: string[], id?: string, shortId?: string, toHandle?: string, toEmail?: string, toPhone?: string, toName?: string, toPersonaId?: string, toUserId?: string, toUserAccountId?: string, toIsAcceptedContact?: boolean, toCountryCode?: string, toExternalId?: string, toAvatar?: AvatarSize[], toId?: string, toCreated?: string, toShortId?: string, toObjectName?: string, limit?: number, page?: number, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  summary Search payments (e.g. between dates, amounts, etc.)

  Throws

  • • (minAmount?, maxAmount?, fromDate?, toDate?, statuses?, paymentTypes?, id?, shortId?, toHandle?, toEmail?, toPhone?, toName?, toPersonaId?, toUserId?, toUserAccountId?, toIsAcceptedContact?, toCountryCode?, toExternalId?, toAvatar?, toId?, toCreated?, toShortId?, toObjectName?, limit?, page?, userId?, options?): Promise<RequestArgs>

    • Parameters

      • OptionalminAmount: number

        The minimum amount for filtering
      • OptionalmaxAmount: number

        The maximum amount for filtering
      • OptionalfromDate: string

        The starting date for filtering
      • OptionaltoDate: string

        The end date for filtering
      • Optionalstatuses: string[]

        A list of statuses for filtering
      • OptionalpaymentTypes: string[]

        A list of payment types for filtering
      • Optionalid: string
      • OptionalshortId: string
      • OptionaltoHandle: string

        The Mozaic handle for a contact
      • OptionaltoEmail: string

        The email address of the contact
      • OptionaltoPhone: string

        The fully qualified phone number of the contact
      • OptionaltoName: string

        Loosely, the name of the contact. May be changed during registration
      • OptionaltoPersonaId: string

        Specifies the persona associated with this contact record
      • OptionaltoUserId: string

        Specifies the user associated with this contact record
      • OptionaltoUserAccountId: string

        Specifies the user account id associated with this contact record
      • OptionaltoIsAcceptedContact: boolean

        Specifies whether this contact is in network or out of network
      • OptionaltoCountryCode: string
      • OptionaltoExternalId: string
      • OptionaltoAvatar: AvatarSize[]

        contact avatar
      • OptionaltoId: string
      • OptionaltoCreated: string
      • OptionaltoShortId: string
      • OptionaltoObjectName: string

        The name of this object
      • 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>

• updatePaymentDetails: ((id: string, paymentDetailsUpdateDeets?: PaymentDetailsUpdateDeets, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Updates a Payment

  summary Update a Payment Details

  Throws

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

    • Parameters

      • id: string
      • OptionalpaymentDetailsUpdateDeets: PaymentDetailsUpdateDeets

        PaymentDetails_UpdateDeets
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• updatePendingPayments: ((paymentAcceptDeets?: PaymentAcceptDeets, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  summary Accept or Suspend payments from an account.

  Throws

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

    • Parameters

      • OptionalpaymentAcceptDeets: PaymentAcceptDeets
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>