Create a Payment

A positive integer value in the specified currency's smallest unit. e.g. $10 would be represented as 1000 (cents).

Bearer of the bank charges: SENDER, RECEIVER, or SHARED. Refer to the payment rules page for per-bank support. For Hong Kong, applicable only for FPS payments via Airwallex.

ID of the payment batch to add this payment to. Only available when batch payments are enabled for your organization.

Applicable to Banking Circle EUR Payments. Please consult with the bank for your default routing logic and if this is applicable to your account. If applicable, specify the preferred payment rail to execute payments. The allowed values are:

• SEPAINST: SEPA Instant Credit Transfer
• SEPA: SEPA Credit Transfer
• T2: Target2

Three-letter ISO 4217 currency code in full uppercase. Must be a currency supported by the payment type. For example, FAST only supports SGD, and UAE domestic types (BKTR, UAE_FTS, UAE_IBFT) typically use AED.

Reference to a booked forex contract funding this payment.

A meaningful description of the payment. This will show up in the receiver's bank statement. Characters used should be restricted to the SWIFT Character Set: uppercase and lowercase letters A-Z, 0-9 numerals, space, and these symbols: /-?:().,'+.

Additional instruction for the sender bank, where the bank supports it.

Email addresses to send a payment advice to, where the bank supports it.

Extended description of the payment. Characters used should be restricted to the SWIFT Character Set: uppercase and lowercase letters A-Z, 0-9 numerals, space, and these symbols: /-?:().,'+. For UAE payments, a free-text description of up to 100 characters.

Purpose code describing the nature of the payment, for regulatory and reporting purposes. Refer to the corresponding payment rules page for the accepted code list and per-bank requirements.

• For HK FPS payments via Airwallex: mandatory; specify the purpose of the payment from the bank's code list.
• For Banking Circle payments: mandatory only for CNH payments to China; one of GOD, STR, CTF, OTF.
• For UAE payments: a 3-letter code from the Central Bank UAE list of purpose codes; defaults to FIS if not supplied.

The payment receiver. Which fields apply depends on the payment type; refer to the payment rules page. Same-bank transfer types (e.g. ACT, BKTR) support only name and bankAccountNumber; proxy-addressed types (e.g. PAYNOW, MY_DUITNOW, FPS) use proxyType and proxyValue instead of bank account numbers.

Currency to use in the sender account, if it has multiple currencies. Optional if the sender account only has one currency configured.

ID of the Internal Account that will be debited to make this payment. Required unless batchId is provided; payments added to a batch use the batch's sender account.

Type of the payment. Refer to the bank specific payment rules page for the supported types.