withdrawals

Crear un retiro

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.

post/withdrawals

Headers

X-SECRET-KEYstring required

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.

Idempotency-Keystring

Clave de idempotencia para reintentos seguros de operaciones críticas, especialmente las que mueven dinero o cambian estado operativo. Reintentar con la misma clave y el mismo cuerpo devuelve la respuesta original (header Idempotency-Replayed: true); reusarla con parámetros distintos devuelve 409.

Request body

bank_account_idstring required

ID de la cuenta bancaria destino

amount_in_centsinteger required
currency'GTQ' | 'USD'

Por defecto, la moneda de la cuenta bancaria

is_instantboolean

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

Response

Retiro creado (asíncrono)

idstring
status'pending' | 'approved' | 'in_review' | 'review_requested' | 'sent' | 'completed' | 'rejected' | 'cancelled'
amount_in_centsinteger
currencystring
bank_namestring
notestring nullable

Nota del retiro

created_atstring date-time

Changes

No recorded changes to this endpoint across all 1 revision of this API.