Cancelar un retiro de una cuenta conectada

Deprecated

POST

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

POST

/api/connected_accounts/:connected_account_id/withdrawals/:id/cancel

curl -X POST https://app.recurrente.com/api/connected_accounts/connected_account_id/withdrawals/id/cancel \
     -H "X-SECRET-KEY: <apiKey>"

{
  "id": "wi_ab12cd34",
  "status": "pending",
  "amount_in_cents": 50000,
  "currency": "GTQ",
  "bank_name": "Banco Industrial",
  "note": "string",
  "recipient_email": "maria@example.com",
  "tracking_url": "https://app.recurrente.com/t/3xK9mPq2vLn8RtWz4Yb7Hc",
  "created_at": "2024-01-15T09:30:00Z",
  "bank_account": {
    "id": "ba_lmgbvesmihkqzma3",
    "bank_name": "Banco Industrial",
    "holder_name": "Acme Restaurant, S.A.",
    "created_at": "2024-01-15T09:30:00Z",
    "status": "active",
    "currency": "GTQ",
    "account_type": "checking",
    "is_preferred": true,
    "ownership_type": "external"
  }
}

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

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

idstringRequired

Response

Retiro cancelado

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

422

Unprocessable Entity Error