Sign in

v1

latestOpenAPI 3.0.12026-07-26171200932.8 KB
Transfer

Execute an internal account-to-account transfer

Rate limit: 60 requests per 60 seconds. This is the default shared quota — it is shared with every other endpoint that has no dedicated limit, so requests across those endpoints all draw from the same budget.

Executes an internal transfer from the source account to the destination account for the authenticated customer.

post/api/v1/money/transfers

Headers

x-request-idstring uuid required
Example:49e9c281-7be9-4b3a-96a5-f7407343a371

A unique request identifier.

x-api-keystring password required
Example:lhgfaslk21490FAScVPkdsb53F9dNkfHG4faZSG5vfjndfcfgdssdgsdHF4663

API key for authentication.

x-user-keystring password required
Example:eyJlYW4iOiJVbnJlZ2lzdGVyZWRBcHBsaWNhdGlvbiIsImVrIjoiOE5sZ2cwcW5EUVdROUFNWGpXT2lmOWktZnpidG5KcUlqWGJ3WHJZZkpZcldrbG90ZEhvLVBjSWhQaU8xU1ZtMW84aU1WZGZqN2xWNzFjLXFxLmcybXE1dnh4Q1hUT25xaWRUaTFlcEhmVk1fIn0_

User-specific authentication key.

Request body

requestReferenceIdstring required

Client reference / idempotency key.

amountnumber double required

Amount to transfer.

currencystring nullable required

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

extraDataobject nullable

Optional client metadata (opaque JSON object).

Example request

{
  "requestReferenceId": "client-ref-8f3a-001",
  "sourceAccount": {
    "accountId": "ACC-100100"
  },
  "destinationAccount": {
    "accountId": "ACC-100100"
  },
  "amount": 250,
  "currency": "USD"
}

Response

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

transferIdinteger required

Server transfer identifier.

requestReferenceIdstring nullable

Echo of client requestReferenceId when provided.

Example response

{
  "transferId": 9876543210,
  "requestReferenceId": "client-ref-8f3a-001"
}