Crear un retiro para una cuenta conectada

Deprecated

POST

https://app.recurrente.com/api/connected_accounts/:connected_account_id/withdrawals

POST

/api/connected_accounts/:connected_account_id/withdrawals

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

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 }

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

Crea un retiro (payout) para una cuenta conectada (hija), pagando a una de las cuentas bancarias de la hija. Requiere movimiento de dinero habilitado en la llave de la plataforma.

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 `X-ACCOUNT-ID` y `destination: {type: bank_account, id: ...}`. Este endpoint sigue funcionando para integraciones existentes. Crea un retiro (payout) para una cuenta conectada (hija), pagando a una de las cuentas bancarias de la hija. Requiere movimiento de dinero habilitado en la llave de la plataforma. 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`.

Path parameters

connected_account_idstringRequired

Request

This endpoint expects an object.

bank_account_idstringRequired

amount_in_centsintegerRequired

currencyenumOptional

Allowed values:

is_instantbooleanOptional

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

422

Unprocessable Entity Error

Authentication

Path parameters

Headers

Request

Response

Errors