RErecurrente
withdrawals

Crear un retiro

Changed on

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.

post/withdrawals

Request

Headers

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

recipient_emailstring nullable

Correo del beneficiario al que le avisamos el estado del retiro

tracking_urlstring nullable

Página pública de seguimiento para el beneficiario

created_atstring date-time

Changes

  • 33bad9197d59Revision changes
    • breaking

      added to the response property oneOf list for the response status

    • breaking

      added to the response property oneOf list for the response status

    • breaking

      added to the response property oneOf list for the response status

    • breaking

      the / response's property type changed from object to array for status

    • breaking

      the / response's property type changed from object to array for status

    • breaking

      the / response's property type changed from object to array for status

  • 3d76463f9fd8Revision changes
    • warning

      deleted the header request parameter X-SECRET-KEY

    • info

      the endpoint scheme security secretKey was added to the API