Create payment request

Creates a payment request. For more information, see Make a payment.

Body Params
int64
required

Identifies the account from which the payment is instructed.

string
required

How the recipient receives payment, for example by BankAccount or Echeck. For more information, see Payment methods.

number | null

The amount to send in the specified SendCurrency. Provide either SendValue or ReceiveValue.

string
required

The currency in which the send account is debited, in ISO 4217 currency code format, for example USD or GBP.

number | null

The amount the recipient should receive in the specified ReceiveCurrency. Provide either ReceiveValue or SendValue.

string
required

The currency the recipient receives, in ISO 4217 currency code format, for example USD or GBP.

boolean | null
Defaults to false

Whether to use the configured FX rate group when calculating the exchange rate.

StoredRecipient

References an existing stored recipient to use for the payment.

VendorRecipient

References an existing vendor recipient to use for the payment.

string | null

Additional information describing the payment.

string | null

The reason for making the payment.

string | null

The payment purpose or classification code required for certain payment routes.

string
required

The reference for the payment, visible to the recipient and (depending on PaymentMethod) typically displayed on their bank statement or cheque, or used for reference data.

string | null

A custom reference used to store internal metadata, such as a policy number, claim ID, case reference, or reconciliation identifier.

string | null

A custom reference used to store internal metadata, such as a policy number, claim ID, case reference, or reconciliation identifier.

string | null

A custom reference used to store internal metadata, such as a policy number, claim ID, case reference, or reconciliation identifier.

Scheduler

Adds the payment to a bulk payment schedule rather than processing it immediately. Specify either "PaymentSchedulerId": "<PaymentSchedulerId>" for a specific scheduler, or "Default": true for the default scheduler.

PaymentMethodsConfiguration

Options for the selected payment method, such as mail class for postal cheque payments.

string

Additional data associated with the payment request.

Recipient

The recipient details for the payment request.

CoPDetails

The signed, unmodified Confirmation of Payee (CoP) result from a prior validation call, which must match the recipient details on this request.

DynamicRiskSharing

Applies the provided funding split to this payment, for accounts that draw funds dynamically from more than one source.

Headers
string | null
Responses

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json