Function PaymentsApiFactory

Returns {
    apiPaymentsCancelPut(paymentCancelDeets?: PaymentCancelDeets, options?: RawAxiosRequestConfig): AxiosPromise<Payment>;
    apiPaymentsCreatePaymentIntentPost(paymentIntentRequestDeets?: PaymentIntentRequestDeets, options?: RawAxiosRequestConfig): AxiosPromise<void>;
    apiPaymentsGet(orchestrationId?: string, paymentSource?: string, paymentSourceId?: string, paymentAcceptStatus?: AcceptPaymentStatusEnum, limit?: number, page?: number, userId?: string, options?: RawAxiosRequestConfig): AxiosPromise<PaymentListResponse>;
    apiPaymentsHasPaymentsOrContactsGet(options?: RawAxiosRequestConfig): AxiosPromise<boolean>;
    apiPaymentsIdDetailsPut(id: string, paymentDetailsUpdateDeets?: PaymentDetailsUpdateDeets, options?: RawAxiosRequestConfig): AxiosPromise<Payment>;
    apiPaymentsIdGet(id: string, userId?: string, options?: RawAxiosRequestConfig): AxiosPromise<Payment>;
    apiPaymentsSearchGet(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, toId?: string, toCreated?: string, toShortId?: string, toObjectName?: string, limit?: number, page?: number, userId?: string, options?: RawAxiosRequestConfig): AxiosPromise<PaymentListResponse>;
    getPendingPayments(status?: AcceptPaymentStatusEnum, limit?: number, page?: number, userId?: string, options?: RawAxiosRequestConfig): AxiosPromise<PersonaPendingPaymentsResponseListResponse>;
    getTransactionStatuses(options?: RawAxiosRequestConfig): AxiosPromise<string[]>;
    getVirtualReceivingAccount(options?: RawAxiosRequestConfig): AxiosPromise<VirtualReceivingAccountInfo>;
    updatePendingPayments(paymentAcceptDeets?: PaymentAcceptDeets, options?: RawAxiosRequestConfig): AxiosPromise<Payment>;
}

• apiPaymentsCancelPut:function

  • apiPaymentsCancelPut(paymentCancelDeets?, options?): AxiosPromise<Payment>

  • summary Cancel a payment

    Parameters

    • OptionalpaymentCancelDeets: PaymentCancelDeets
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<Payment>

    Throws

• apiPaymentsCreatePaymentIntentPost:function

  • apiPaymentsCreatePaymentIntentPost(paymentIntentRequestDeets?, options?): AxiosPromise<void>

  • summary Test method for invoice payment intent generation

    Parameters

    • OptionalpaymentIntentRequestDeets: PaymentIntentRequestDeets
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Throws

• apiPaymentsGet:function

  • apiPaymentsGet(orchestrationId?, paymentSource?, paymentSourceId?, paymentAcceptStatus?, limit?, page?, userId?, options?): AxiosPromise<PaymentListResponse>

  • summary Retrieve a list of payments

    Parameters

    • OptionalorchestrationId: string

      The id of the payment cycle for which to list the payments
    • OptionalpaymentSource: string
    • OptionalpaymentSourceId: string
    • OptionalpaymentAcceptStatus: 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 AxiosPromise<PaymentListResponse>

    Throws

• apiPaymentsHasPaymentsOrContactsGet:function

  • apiPaymentsHasPaymentsOrContactsGet(options?): AxiosPromise<boolean>

  • Returns a true/false for any payment or contact if found summary Retrieve if has any payment or contact

    Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<boolean>

    Throws

• apiPaymentsIdDetailsPut:function

  • apiPaymentsIdDetailsPut(id, paymentDetailsUpdateDeets?, options?): AxiosPromise<Payment>

  • Updates a Payment

    summary Update a Payment Details

    Parameters

    • id: string
    • OptionalpaymentDetailsUpdateDeets: PaymentDetailsUpdateDeets

      PaymentDetails_UpdateDeets
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<Payment>

    Throws

• apiPaymentsIdGet:function

  • apiPaymentsIdGet(id, userId?, options?): AxiosPromise<Payment>

  • 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 AxiosPromise<Payment>

    Throws

• apiPaymentsSearchGet:function

  • apiPaymentsSearchGet(minAmount?, maxAmount?, fromDate?, toDate?, statuses?, paymentTypes?, id?, shortId?, toHandle?, toEmail?, toPhone?, toName?, toPersonaId?, toUserId?, toUserAccountId?, toId?, toCreated?, toShortId?, toObjectName?, limit?, page?, userId?, options?): AxiosPromise<PaymentListResponse>

  • 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
    • 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 AxiosPromise<PaymentListResponse>

    Throws

• getPendingPayments:function

  • getPendingPayments(status?, limit?, page?, userId?, options?): AxiosPromise<PersonaPendingPaymentsResponseListResponse>

  • 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 AxiosPromise<PersonaPendingPaymentsResponseListResponse>

    Throws

• getTransactionStatuses:function

  • getTransactionStatuses(options?): AxiosPromise<string[]>

  • summary List Transaction Statuses

    Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<string[]>

    Throws

• getVirtualReceivingAccount:function

  • getVirtualReceivingAccount(options?): AxiosPromise<VirtualReceivingAccountInfo>

  • summary Retrieve Customer Virtual Receiving Account

    Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<VirtualReceivingAccountInfo>

    Throws

• updatePendingPayments:function

  • updatePendingPayments(paymentAcceptDeets?, options?): AxiosPromise<Payment>

  • summary Accept or Suspend payments from an account.

    Parameters

    • OptionalpaymentAcceptDeets: PaymentAcceptDeets
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<Payment>

    Throws