Withdrawal orders extract a fiat amount from your settlement account to an outside bank.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
A withdrawal order debits a fiat amount from your settlement account and transfers it to an outside bank account.
Currency Must Match the Settlement AccountThe withdrawal
currencyMUST be the same as your settlement account currency. Requesting a withdrawal in a different currency is rejected.
Withdrawal Destinations
Set the withdrawal.type field to the rail you want to use, then provide the matching object:
| Currency | Type | Object | Required Fields |
|---|---|---|---|
| ARS | ar_cvu | ar_cvu | cvu |
| ARS | ar_cbu | ar_cbu | cbu |
| ARS | ar_alias | ar_alias | alias |
| MXN | mx_clabe | mx_clabe | clabe |
| — | address_book_item | address_book_item | id |
Use address_book_item to reference an id of previously loaded arbitrary withdraw instructions. Currently the only way to load these instructions is by manually requesting it to [email protected].
Mexico (MXN) — CLABE Transfer
Withdrawals to a Mexican bank account use the same mx_clabe object as a Customer's outgoing fiat instruction.
| Field | Type | Required | Description |
|---|---|---|---|
clabe | string | Yes | Mexican interbank account number (18 digits). |
beneficiary_full_name | string | No | Full name of the beneficiary. |
recipient_legal_name | string | No | Deprecated. Use beneficiary_full_name instead. Will be removed in a future release. |
{
"reference_id": "withdrawal-1",
"operation": "withdrawal",
"withdrawal": {
"currency": "MXN",
"amount": "1234.56",
"type": "mx_clabe",
"mx_clabe": {
"clabe": "123456789012345678",
"beneficiary_full_name": "Juan Perez"
}
}
}