post
https://api.lirium-sandbox.com/v1/customers//outgoing_fiat_instructions
Create new withdrawal instructions for a customer
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Create new withdrawal instructions for a customer. This registers a bank account or payment destination where the customer can withdraw fiat currency.
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
| currency | string | Yes | Currency code (ARS, MXN) |
| type | string | Yes | Type of withdrawal rail (ar_cbu, ar_alias, mx_clabe) |
| label | string | No | User-friendly label for the instruction |
| ownership | string | No | Ownership relationship. Values: own (default), third_party |
| beneficiary_full_name | string | No | Full name of the beneficiary. Used when ownership is third_party |
| ar_cbu | object | Conditional | CBU details (required when type is ar_cbu) |
| ar_alias | object | Conditional | Alias details (required when type is ar_alias) |
| mx_clabe | object | Conditional | CLABE details (required when type is mx_clabe) |
Available Withdrawal Rails
| Currency | Type | Required Fields | Description |
|---|---|---|---|
| ARS | ar_cbu | cbu, cuit | Argentine bank account (CBU) |
| ARS | ar_alias | alias, cuit | Argentine bank alias |
| MXN | mx_clabe | clabe, beneficiary_full_name | Mexican CLABE transfer |
Response Fields
| Field | Type | Description |
|---|---|---|
| id | string | Unique identifier for the instruction |
| type | string | Withdrawal rail type |
| currency | string | Currency code |
| label | string | null | User-friendly label |
| status | string | Instruction status (e.g., "active") |
| ownership | string | null | Ownership relationship: own or third_party |
| beneficiary_full_name | string | null | Full name of the beneficiary when ownership is third_party |
| ar_cbu | object | null | CBU details (when type is ar_cbu) |
| ar_alias | object | null | Alias details (when type is ar_alias) |
| mx_clabe | object | null | CLABE details (when type is mx_clabe) |
Required Fields by Type
Argentina (ARS)
CBU Transfer (ar_cbu)
ar_cbu)| Field | Type | Description |
|---|---|---|
cbu | string | Argentine bank account number (22 digits) |
cuit | string | Tax identification number |
Alias Transfer (ar_alias)
ar_alias)| Field | Type | Description |
|---|---|---|
alias | string | Bank account alias |
cuit | string | Tax identification number |
Mexico (MXN)
CLABE Transfer (mx_clabe)
mx_clabe)| Field | Type | Description |
|---|---|---|
clabe | string | Mexican interbank account number (18 digits) |
beneficiary_full_name | string | Full name of the beneficiary |
recipient_legal_name | string | Deprecated. Use beneficiary_full_name instead. Will be removed in a future release. |
Deprecation NoticeThe
recipient_legal_namefield insidemx_clabeis deprecated and will be removed in a future release. Use the top-levelbeneficiary_full_namerequest field instead.
Error Responses
| Status | Error Code | Description |
|---|---|---|
| 400 | invalid_parameters | Request validation failed |
| 404 | not_found | Customer not found |