Cancelar un retiro

Deprecated

POST

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

POST

/api/withdrawals/:id/cancel

curl -X POST https://app.recurrente.com/api/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",
  "currency_conversion": {
    "id": "cu_ab12cd34",
    "status": "awaiting_confirmation",
    "source_currency": "USD",
    "source_amount_in_cents": 10000,
    "destination_currency": "GTQ",
    "destination_amount_in_cents": 75000,
    "exchange_rate": 7.5,
    "expires_at": "2024-01-15T09:30:00Z",
    "created_at": "2024-01-15T09:30:00Z"
  },
  "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, que acepta IDs wi_. Este endpoint sigue funcionando para integraciones existentes.

Cancela un retiro que aún puede cancelarse (pendiente, o aprobado sin lote).

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

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

currency_conversionobject or nullOptional

La conversión que pagó el retiro cuando el balance de origen está en otra moneda que la cuenta bancaria (por ejemplo, de tu balance en USD a una cuenta en GTQ). source_amount_in_cents es lo que salió de tu balance; amount_in_cents del retiro es lo convertido. null si no hubo conversión. Si el retiro se rechaza o se cancela dentro de las 72 horas, la conversión pasa a reverted y el monto vuelve a tu balance en la moneda de origen.

created_atdatetimeOptional

bank_accountobjectOptional

Errors

422

Unprocessable Entity Error