Skip to main content
POST
Execute a transfer

Authorizations

Authorization
string
header
required

API key issued during merchant onboarding.

Headers

Idempotency-Key
string

Optional client-supplied key. Identical key + identical body within 24h replays the original response. Identical key + different body returns 409 idempotency_conflict. The hash is over raw bytes — clients retrying must send the byte-identical body; a re-serialised JSON payload will produce a different hash and a 409. Strongly recommended for retry-safe clients.

Pattern: ^[A-Za-z0-9_\-]{8,255}$

Body

application/json

ExecuteTransferDto

wallet_id
string
required
Maximum string length: 64
beneficiary_id
string
required
Maximum string length: 64
amount
string
required
Pattern: ^\d+(\.\d+)?$
reference
string
required
Maximum string length: 128
source_currency
string
Pattern: ^[A-Z0-9]{2,8}$
destination_currency
string
Pattern: ^[A-Z0-9]{2,8}$
retry_on_failure
boolean
metadata
object

Response

Transfer executed successfully

status
enum<boolean>
required
Available options:
true
Example:

true

message
string
required

Human-readable summary

Example:

"Transfer executed successfully"

code
enum<string>
required
Available options:
ok
Example:

"ok"

data
object
required
meta
object
required