Crear un retiro | Documentación API de Recurrente

Obsoleto: usa el endpoint unificado POST /transfers con destination: {type: bank_account, id: ...}. Este endpoint sigue funcionando para integraciones existentes.

Paga el balance de tu cuenta a una de tus cuentas bancarias externas. Requiere una llave con movimiento de dinero habilitado. El retiro es asíncrono: la respuesta es el estado inicial (pending/in_review/approved); suscríbete a los webhooks withdrawal.* o consulta el estado.

En Sandbox esta operación está bloqueada: un balance simulado nunca es retirable.

> **Obsoleto:** usa el endpoint unificado [`POST /transfers`](/api-reference/transfers/crear-una-transferencia) con `destination: {type: bank_account, id: ...}`. Este endpoint sigue funcionando para integraciones existentes. Paga el balance de tu cuenta a una de tus cuentas bancarias externas. Requiere una llave con movimiento de dinero habilitado. El retiro es **asíncrono**: la respuesta es el estado inicial (`pending`/`in_review`/`approved`); suscríbete a los webhooks `withdrawal.*` o consulta el estado. En Sandbox esta operación está bloqueada: un balance simulado nunca es retirable.

Authentication

X-SECRET-KEYstring

Tu clave secreta de API.

Una llave de cuenta (sk_live_..., sk_test_...) opera sobre su propia cuenta y, con X-ACCOUNT-ID, sobre sus cuentas conectadas.

Una llave de organización (sk_org_live_..., sk_org_test_...) alcanza todas las cuentas de una organización y solo sirve para leer: saldos, movimientos y reportes. Para operar sobre una cuenta debe nombrarla con X-ACCOUNT-ID; omitirlo en una lectura devuelve todas las cuentas de la organización. Cualquier otro endpoint responde 403 con code: organization_key_unsupported.

Tu clave secreta de API. Una llave de cuenta (`sk_live_...`, `sk_test_...`) opera sobre su propia cuenta y, con `X-ACCOUNT-ID`, sobre sus cuentas conectadas. Una llave de organización (`sk_org_live_...`, `sk_org_test_...`) alcanza todas las cuentas de una organización y solo sirve para leer: saldos, movimientos y reportes. Para operar sobre una cuenta debe nombrarla con `X-ACCOUNT-ID`; omitirlo en una lectura devuelve todas las cuentas de la organización. Cualquier otro endpoint responde `403` con `code: organization_key_unsupported`.

Request

This endpoint expects an object.

bank_account_idstringRequired

ID de la cuenta bancaria destino

amount_in_centsintegerRequired

currencyenumOptional

Por defecto, la moneda de la cuenta bancaria

Allowed values:

is_instantbooleanOptional

Retiro instantáneo (sujeto a elegibilidad y comisión)

Response

Retiro creado (asíncrono)

idstringOptional

statusenumOptional

amount_in_centsintegerOptional

currencystringOptional

bank_namestringOptional

notestring or nullOptional

Nota del retiro

created_atdatetimeOptional

bank_accountobjectOptional

Errors

400

Bad Request Error

403

Forbidden Error

422

Unprocessable Entity Error

$	curl -X POST https://app.recurrente.com/api/withdrawals \
>	-H "X-SECRET-KEY: <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"bank_account_id": "string",
>	"amount_in_cents": 50000
>	}'

1	{
2	"id": "wi_ab12cd34",
3	"status": "pending",
4	"amount_in_cents": 50000,
5	"currency": "GTQ",
6	"bank_name": "Banco Industrial",
7	"note": "string",
8	"created_at": "2024-01-15T09:30:00Z",
9	"bank_account": {
10	"id": "ba_lmgbvesmihkqzma3",
11	"bank_name": "Banco Industrial",
12	"holder_name": "Acme Restaurant, S.A.",
13	"created_at": "2024-01-15T09:30:00Z",
14	"status": "active",
15	"currency": "GTQ",
16	"account_type": "checking",
17	"is_preferred": true,
18	"ownership_type": "external"
19	}
20	}

Authentication

Headers

Request

Response

Errors