Overview#
Payout (debit), internal transfer, planned deposit (credit) use the same endpoint.The difference between each payment type is determined by the types of the accounts on each side:This document covers the simplest way to achieve each, with some optional properties covered at the end.Pre-requisites#
You must already have at least 1 wallet in the payment currency, for sending or receiving the payment
You will need the 22-character "account keys" for the origin (sender) and the beneficiary (receiver) accountsCounterparty account keys are shown as bankAccountId on each account on a counterparty Examples#
Payout#
{
"currencyCode": "AAA",
"amount": 0.00,
"originAccountKey": "abcdefghijkl0123456789",
"beneficiaryAccountKey": "abcdefghijkl0123456789"
}
If currencyCode is EUR and the beneficiary is in the "SEPA zone", the payment verification process must be completed and the verification result included in the payout request:{
...
"verification": {
"requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6",
"acceptWarning": true
}
}
Internal transfer#
{
"currencyCode": "AAA",
"amount": 0.00,
"originAccountKey": "abcdefghijkl0123456789",
"beneficiaryAccountKey": "abcdefghijkl0123456789"
}
Planned deposit#
{
"currencyCode": "AAA",
"amount": 0.00,
"originAccountKey": "abcdefghijkl0123456789",
"beneficiaryAccountKey": "abcdefghijkl0123456789"
}
Additional properties#
This is an incomplete list of optional properties that are often valuable.correlationId#
A unique ID for correlating with internal systems. Must be unique for the tenant or a 409 Conflict response will be given.{
...
"correlationId": "our-system-id"
}
paymentNetwork#
Generally should not be provided as the platform will choose the best network for your payout, including direct "Neo" transfers.If you wish to force SWIFT payment where an undesirable SEPA is possible, specify the property as swift.{
...
"paymentNetwork": "swift"
}
paymentReference#
Optional reference to apply to the payment, as sent to the beneficiary.
If not used, the automatic "vanity ID" will be used as the reference.{
...
"paymentReference": "our reference"
}
type#
For additional validation on each request, the type can be set to payout, deposit, or internalTransfer, to enforce that the correct types of accounts are provided.Modified at 2026-08-27 09:34:52