Skip to main content
POST
/
customer
/
wire
Client Create Withdraw
curl --request POST \
  --url https://api.example.com/customer/wire \
  --header 'Content-Type: application/json' \
  --header 'X-API-NONCE: <x-api-nonce>' \
  --header 'X-API-SIGNATURE: <x-api-signature>' \
  --header 'X-API-SUBSCRIPTION-KEY: <x-api-subscription-key>' \
  --header 'X-API-TIMESTAMP: <x-api-timestamp>' \
  --data '
{
  "sending_account_id": "<string>",
  "external_account_id": "<string>",
  "amount": 123,
  "purpose": "<string>"
}
'
{
  "message": "<string>",
  "data": {
    "transaction_id": "57g40zMpwoQS9dHnDUIy2pxN",
    "sending_account_id": "57g3dnEZXOFgYN4yCSVitRcV",
    "external_account_id": "54_6HvEVoz7Sr929DXXwOGXn",
    "amount": 100.99,
    "note": "Payment for invoice 1234"
  }
}

Headers

x-idempotency-key
string | null
X-API-SIGNATURE
string
required

Signature header

X-API-TIMESTAMP
integer
required

Timestamp header

X-API-NONCE
string
required

Nonce header

X-API-SUBSCRIPTION-KEY
string
required

Account ID header

Body

application/json

Schema to deserialize the transaction withdraw request.

sending_account_id
string
required

Sending account ID

Example:

"57g40zMpwoQS9dHnDUIy2pxN"

external_account_id
string
required

Account id

Example:

"57g3dnEZXOFgYN4yCSVitRcV"

amount
number
required

Amount

Required range: x <= 100000000
Example:

100

purpose
string
required

Purpose

Example:

"I need money"

Response

Successful Response

message
string
required
data
ClientCreateWithdrawalResponse · object

Schema to serialize the transaction withdrawal response.