Crear un retiro

Crea un retiro con campos planos: los datos del beneficiario van al mismo nivel con prefijo `beneficiary_`. Responde `200` con el registro completo del retiro, y aquí el campo `id` **sí** es el identificador del retiro — el que va en `perform_action`.

Autorización

Authorization

Authorization<token>

Your public API key, with the word Token and a space in front of it. Example: Token 6534bc0a7e1f4d2b9c8e3a5f7b1d2c4e6f8a9b0c — that whole value is the header. Sending the key alone returns 401 'Authentication credentials were not provided'. In this playground you may paste just the key; the prefix is added for you.

In: header

Cuerpo de la petición

application/json

TypeScript Definitions

Use the request body type in TypeScript.

amount*number

Amount to send. Must be greater than zero.

currency*string

Only MXN today.

transfer_method*string

SPEI sends to an 18-digit CLABE; DEBIT_CARD sends to a 16-digit debit card number. Nothing else changes between the two.

beneficiary_account*string

18-digit CLABE for SPEI, 16-digit card number for DEBIT_CARD.

beneficiary_name*string

The holder's name as it appears on the account. Practical limit of 40 characters: longer names can be rejected when the transfer is sent, not when the withdrawal is created — validate it on your side first.

beneficiary_rfc*string

The beneficiary's RFC or CURP. If you don't have either, send ND.

beneficiary_institution*string

Banxico institution code of the beneficiary's bank, four or five digits. It must belong to the same bank as the CLABE: the correspondence is not checked when the withdrawal is created, but a mismatch can get the transfer rejected when it is sent.

email*string

The beneficiary's email.

description?string

Payment concept. Defaults to Retiro de fondos if omitted.

metadata?

Your own data, stored and returned as is. latitude and longitude are recommended for operations in Mexico.

fee_model*string

Always "01".

Cuerpo de la respuesta

`application/json`

curl -X POST "https://example.com/withdrawals/" \  -H "Content-Type: application/json" \  -d '{    "amount": 20,    "currency": "MXN",    "transfer_method": "SPEI",    "beneficiary_account": "012969100000000110",    "beneficiary_name": "Ana Maria Gonzalez",    "beneficiary_rfc": "GOAN850315AB2",    "beneficiary_institution": "40012",    "email": "ana.gonzalez@email.com",    "description": "Pago de comisiones",    "metadata": {      "latitude": "22.8870221",      "longitude": "-109.911775",      "order_reference": "ORD-001"    },    "fee_model": "01"  }'

{
  "id": "ea6ac67d-b577-481a-9b99-3c3c275ae527",
  "business_id": "69",
  "status": "PENDING",
  "amount": 20,
  "currency": "MXN",
  "transfer_method": "SPEI",
  "account_data": {
    "nombre_beneficiario": "Ana Maria Gonzalez",
    "cuenta_beneficiario": "012969100000000110",
    "institucion_contraparte": "40012",
    "tipo_cuenta_beneficiario": 40,
    "rfc_curp_beneficiario": "GOAN850315AB2",
    "concepto_pago": "Pago de comisiones",
    "email": "ana.gonzalez@email.com"
  },
  "metadata": {
    "order_reference": "ORD-001"
  },
  "status_changes": [],
  "action": null,
  "created_at": "2026-10-01T17:33:41.364685Z",
  "fixed_fee": "3.5",
  "tax": "16.0"
}

{
  "error": "Amount must be greater than 0"
}

{
  "detail": "Invalid token."
}

Crear un retiro

Autorización

Cuerpo de la petición

Cuerpo de la respuesta

200application/json

400application/json

401application/json

`application/json`

`application/json`

`application/json`