Class PaymentsApi

PaymentsApi - object-oriented interface export PaymentsApi

Hierarchy (view full)

BaseAPI
- PaymentsApi

Index

Constructors

constructor

new PaymentsApi(configuration?, basePath?, axios?): PaymentsApi
Parameters
- Optionalconfiguration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns PaymentsApi
Inherited from BaseAPI.constructor
- Defined in src/api/base.ts:53

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: undefined | Configuration

Methods

apiPaymentsCancelPut

apiPaymentsCancelPut(paymentCancelDeets?, options?): Promise<AxiosResponse<Payment, any>>
summary Cancel a payment
Parameters
- OptionalpaymentCancelDeets: PaymentCancelDeets
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<Payment, any>>
Throws
memberof PaymentsApi
- Defined in src/api/api.ts:22591

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
- Defined in src/api/api.ts:22603

apiPaymentsGet

apiPaymentsGet(orchestrationId?, paymentSource?, paymentSourceId?, paymentAcceptStatus?, 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: 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 Promise<AxiosResponse<PaymentListResponse, any>>
Throws
memberof PaymentsApi
- Defined in src/api/api.ts:22621

apiPaymentsHasPaymentsOrContactsGet

apiPaymentsHasPaymentsOrContactsGet(options?): Promise<AxiosResponse<boolean, any>>
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 Promise<AxiosResponse<boolean, any>>
Throws
memberof PaymentsApi
- Defined in src/api/api.ts:22632

apiPaymentsIdDetailsPut

apiPaymentsIdDetailsPut(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
- Defined in src/api/api.ts:22645

apiPaymentsIdGet

apiPaymentsIdGet(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
- Defined in src/api/api.ts:22658

apiPaymentsSearchGet

apiPaymentsSearchGet(minAmount?, maxAmount?, fromDate?, toDate?, statuses?, paymentTypes?, id?, shortId?, toHandle?, toEmail?, toPhone?, toName?, toPersonaId?, toUserId?, toUserAccountId?, 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
- 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
- Defined in src/api/api.ts:22691

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
- Defined in src/api/api.ts:22706

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
- Defined in src/api/api.ts:22717

getVirtualReceivingAccount

getVirtualReceivingAccount(options?): Promise<AxiosResponse<VirtualReceivingAccountInfo, any>>
summary Retrieve Customer Virtual Receiving Account
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<VirtualReceivingAccountInfo, any>>
Throws
memberof PaymentsApi
- Defined in src/api/api.ts:22728

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
- Defined in src/api/api.ts:22740

Class PaymentsApi

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns PaymentsApi

Properties

Protectedaxios

ProtectedbasePath

Protectedconfiguration

Methods

apiPaymentsCancelPut

Parameters

Returns Promise<AxiosResponse<Payment, any>>

Throws

apiPaymentsCreatePaymentIntentPost

Parameters

Returns Promise<AxiosResponse<void, any>>

Throws

apiPaymentsGet

Parameters

Returns Promise<AxiosResponse<PaymentListResponse, any>>

Throws

apiPaymentsHasPaymentsOrContactsGet

Parameters

Returns Promise<AxiosResponse<boolean, any>>

Throws

apiPaymentsIdDetailsPut

Parameters

Returns Promise<AxiosResponse<Payment, any>>

Throws

apiPaymentsIdGet

Parameters

Returns Promise<AxiosResponse<Payment, any>>

Throws

apiPaymentsSearchGet

Parameters

Returns Promise<AxiosResponse<PaymentListResponse, any>>

Throws

getPendingPayments

Parameters

Returns Promise<AxiosResponse<PersonaPendingPaymentsResponseListResponse, any>>

Throws

getTransactionStatuses

Parameters

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

Throws

getVirtualReceivingAccount

Parameters

Returns Promise<AxiosResponse<VirtualReceivingAccountInfo, any>>

Throws

updatePendingPayments

Parameters

Returns Promise<AxiosResponse<Payment, any>>

Throws

Settings

On This Page

`Protected`axios

`Protected`basePath

`Protected`configuration