RErecurrente
connectedAccounts

Crear un retiro para una cuenta conectada

Changed on

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.

post/connected_accounts/{connected_account_id}/withdrawals

Request

Path parameters

connected_account_idstring required

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
amount_in_centsinteger required
currency'GTQ' | 'USD'
is_instantboolean

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

      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