Crear un retiro | Documentación API de Recurrente

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.

Authentication

X-SECRET-KEYstring

Tu clave secreta de API

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)

idstring

statusenum

amount_in_centsinteger

currencystring

bank_namestring

created_atdatetime

bank_accountobject

Errors

403

Forbidden 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	"created_at": "2024-01-15T09:30:00Z",
8	"bank_account": {
9	"id": "ba_lmgbvesmihkqzma3",
10	"bank_name": "Banco Industrial",
11	"holder_name": "Acme Restaurant, S.A.",
12	"created_at": "2024-01-15T09:30:00Z",
13	"status": "active",
14	"currency": "GTQ",
15	"account_type": "checking",
16	"is_preferred": true,
17	"ownership_type": "external"
18	}
19	}

Authentication

Headers

Request

Response

Errors