Skip to main content
POST
Execute an internal account-to-account transfer

Authorizations

x-api-key
string
header
default:lhgfaslk21490FAScVPkdsb53F9dNkfHG4faZSG5vfjndfcfgdssdgsdHF4663
required

API key of the application. Only valid together with the x-user-key header — the pair is an alternative to OAuth bearer authentication, never sent alongside it. The pair is granted the same permissions the operation's OAuth scopes describe.

Demo credential for trying the API from these docs: lhgfaslk21490FAScVPkdsb53F9dNkfHG4faZSG5vfjndfcfgdssdgsdHF4663

x-user-key
string
header
default:eyJlYW4iOiJVbnJlZ2lzdGVyZWRBcHBsaWNhdGlvbiIsImVrIjoiOE5sZ2cwcW5EUVdROUFNWGpXT2lmOWktZnpidG5KcUlqWGJ3WHJZZkpZcldrbG90ZEhvLVBjSWhQaU8xU1ZtMW84aU1WZGZqN2xWNzFjLXFxLmcybXE1dnh4Q1hUT25xaWRUaTFlcEhmVk1fIn0_
required

User-specific authentication key. Only valid together with the x-api-key header — the pair is an alternative to OAuth bearer authentication, never sent alongside it.

Demo credential for trying the API from these docs: eyJlYW4iOiJVbnJlZ2lzdGVyZWRBcHBsaWNhdGlvbiIsImVrIjoiOE5sZ2cwcW5EUVdROUFNWGpXT2lmOWktZnpidG5KcUlqWGJ3WHJZZkpZcldrbG90ZEhvLVBjSWhQaU8xU1ZtMW84aU1WZGZqN2xWNzFjLXFxLmcybXE1dnh4Q1hUT25xaWRUaTFlcEhmVk1fIn0_

Headers

x-request-id
string<uuid>
required

A unique request identifier.

Example:

"7e597a93-9111-49ef-8f25-3a3a5892d3b5"

Body

application/json

Request model for executing an internal transfer

requestReferenceId
string
required

Client reference / idempotency key.

Example:

"client-ref-8f3a-001"

sourceAccount
object
required

Account identifier for a transfer participant

destinationAccount
object
required

Account identifier for a transfer participant

amount
number<double>
required

Amount to transfer.

Example:

250

currency
string | null
required

ISO 4217 alphabetic currency code; must match the source account currency.

Example:

"USD"

extraData
object | null

Optional client metadata (opaque JSON object).

Response

Transfer accepted; returns transfer id and optional echoed request reference id.

Response after executing a transfer

transferId
integer<int64>
required

Server transfer identifier.

Example:

9876543210

requestReferenceId
string | null

Echo of client requestReferenceId when provided.

Example:

"client-ref-8f3a-001"