Skip to navigation
Referencia APIConnected Accounts

Crear un retiro para una cuenta conectada

Deprecated

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.

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.

La llave también fija el ambiente: una sk_test_ solo lista y resuelve objetos de prueba (live_mode: false) y una sk_live_ solo objetos reales. Un ID del otro ambiente responde 404 (401 en /customers).

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

Headers

Idempotency-KeystringOptional

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

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
recipient_emailstring or nullOptional
Correo del beneficiario al que le avisamos el estado del retiro
tracking_urlstring or nullOptional

Página pública de seguimiento para el beneficiario

created_atdatetimeOptional
bank_accountobjectOptional

Errors

400
Bad Request Error
422
Unprocessable Entity Error