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-KEY: <x-api-key>' \
  --header 'X-API-NONCE: <x-api-nonce>' \
  --header 'X-API-SIGNATURE: <x-api-signature>' \
  --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": "123123123123",
    "sending_account_id": "1234abcd",
    "external_account_id": "987654321",
    "amount": 100,
    "note": "Payment for invoice #1234"
  }
}
Submit a wire transfer request to withdraw money from a customer account. This endpoint processes wire transfers to external accounts and requires all transaction details including amount, recipient information, and account details.

Headers

​
X-API-SIGNATURE
string
required

Signature header

​
X-API-TIMESTAMP
integer
required

Timestamp header

​
X-API-NONCE
string
required

Nonce header

​
X-API-KEY
string
required

Account ID header

Body

application/json

Schema to deserialize the transaction withdraw request.

​
sending_account_id
string
required

Sending account ID

​
external_account_id
string
required

Account id

​
amount
number
required

Amount

Required range: x <= 1000000
​
purpose
string
required

Purpose

Response

Successful Response

​
message
string
required
​
data
ClientCreateWithdrawalResponse · object

Schema to serialize the transaction withdrawal response.