Class PaymentsApi

PaymentsApi - object-oriented interface export PaymentsApi

Hierarchy (view full)

Constructors

constructor

Properties

axios basePath configuration

Methods

apiPaymentsCreatePaymentIntentPost cancelPayment getPayment getPaymentsByTransactionId getPendingPayments getTransactionStatuses getVirtualReceivingAccount hasPaymentsOrContacts listPayments searchPayments updatePaymentDetails updatePendingPayments

Constructors

constructor

Properties

Protectedaxios

axios: AxiosInstance = globalAxios

ProtectedbasePath

basePath: string = BASE_PATH

Protectedconfiguration

configuration: undefined | Configuration

Methods

apiPaymentsCreatePaymentIntentPost

  • apiPaymentsCreatePaymentIntentPost(paymentIntentRequestDeets?, options?): Promise<AxiosResponse<void, any>>

  • summary Test method for invoice payment intent generation

    Parameters

    • OptionalpaymentIntentRequestDeets: PaymentIntentRequestDeets
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<void, any>>

    Throws

    memberof PaymentsApi

cancelPayment

  • cancelPayment(id, paymentCancelDeets?, options?): Promise<AxiosResponse<Payment, any>>

  • summary Cancel a payment

    Parameters

    • id: string
    • OptionalpaymentCancelDeets: PaymentCancelDeets
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<Payment, any>>

    Throws

    memberof PaymentsApi

getPayment

  • getPayment(id, userId?, options?): Promise<AxiosResponse<Payment, any>>

  • Returns a single payment if found summary Retrieve a payment by ID

    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<AxiosResponse<Payment, any>>

    Throws

    memberof PaymentsApi

getPaymentsByTransactionId

  • getPaymentsByTransactionId(transactionId, options?): Promise<AxiosResponse<Payment[], any>>

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

    Parameters

    • transactionId: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<Payment[], any>>

    Throws

    memberof PaymentsApi

getPendingPayments

  • getPendingPayments(status?, limit?, page?, userId?, options?): Promise<AxiosResponse<PersonaPendingPaymentsResponseListResponse, any>>

  • summary List aggregated Pending or Suspended payments

    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<AxiosResponse<PersonaPendingPaymentsResponseListResponse, any>>

    Throws

    memberof PaymentsApi

getTransactionStatuses

  • getTransactionStatuses(options?): Promise<AxiosResponse<string[], any>>

  • summary List Transaction Statuses

    Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<string[], any>>

    Throws

    memberof PaymentsApi

getVirtualReceivingAccount

hasPaymentsOrContacts

  • hasPaymentsOrContacts(xCaller?, options?): Promise<AxiosResponse<boolean, any>>

  • 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.

    Parameters

    • OptionalxCaller: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<boolean, any>>

    Throws

    memberof PaymentsApi

listPayments

  • listPayments(orchestrationId?, paymentSource?, paymentSourceId?, paymentAcceptStatuses?, limit?, page?, userId?, options?): Promise<AxiosResponse<PaymentListResponse, any>>

  • summary Retrieve a list of payments

    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<AxiosResponse<PaymentListResponse, any>>

    Throws

    memberof PaymentsApi

searchPayments

  • searchPayments(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<AxiosResponse<PaymentListResponse, any>>

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

    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<AxiosResponse<PaymentListResponse, any>>

    Throws

    memberof PaymentsApi

updatePaymentDetails

  • updatePaymentDetails(id, paymentDetailsUpdateDeets?, options?): Promise<AxiosResponse<Payment, any>>

  • Updates a Payment

    summary Update a Payment Details

    Parameters

    • id: string
    • OptionalpaymentDetailsUpdateDeets: PaymentDetailsUpdateDeets

      PaymentDetails_UpdateDeets

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<Payment, any>>

    Throws

    memberof PaymentsApi

updatePendingPayments

  • updatePendingPayments(paymentAcceptDeets?, options?): Promise<AxiosResponse<Payment, any>>

  • summary Accept or Suspend payments from an account.

    Parameters

    • OptionalpaymentAcceptDeets: PaymentAcceptDeets
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<Payment, any>>

    Throws

    memberof PaymentsApi

Settings

Member Visibility

On This Page

Constructors
Properties
Methods