Sign in

v1

latestOpenAPI 3.1.02026-07-244511495.5 KB
Payments

Create outbound payment for a customer

Create outbound payment for a customer

post/v1/accounts/{account_id}/payments

Path parameters

account_idstring uuid required

Headers

Idempotency-Keystring uuid required

Idempotency key to allow safe retrying of the operation. The value should be a unique UUID for each distinct operation. See our understanding idempotency guide for full details.

Request body

amountinteger required

Payment amount.

external_idstring string nullable

External ID set by the customer. The external ID will be available on all resources related to the transaction if set when creating the transaction.

external_referencestring required

Payment reference for the payment.

purpose'charity' | 'commercial_investment' | 'corporate_card' | 'credit_card' | 'dividend' | 'family' | 'financial_services' | 'goods_sold' | 'goods_bought' | 'government' | 'insurance' | 'intergroup_transfer' | 'intra_group_dividends' | 'information_technology' | 'leasing' | 'loan_charges' | 'merchant_settlement' | 'mobile_wallet' | 'non_resident_transfer_between_accounts' | 'none' | 'pension' | 'personal_expenses' | 'prepaid_cards' | 'professional' | 'rental' | 'resident_transfer_between_accounts' | 'salaries' | 'tax' | 'telecommunications' | 'travel' | 'utility_bill' required

Enum representing different payment purposes.

Example request

{
  "beneficiary": {}
}

Response

Customer payment has been accepted

transaction_idstring uuid required

Id of the created payment.