Retiros

Consultar un retiro

Devuelve un retiro por su identificador, creado por cualquiera de las dos vías. Sin barra final (con barra responde `404`). Es el único lugar que trae el motivo de un fallo, en `status_changes[].reason` y `action.reason`.

GET
/withdrawals/{withdrawal_id}

Autorización

Authorization
Authorization<token>

Your public API key, with the word Token and a space in front of it. Example: Token 6534bc0a7e1f4d2b9c8e3a5f7b1d2c4e6f8a9b0c — that whole value is the header. Sending the key alone returns 401 'Authentication credentials were not provided'. In this playground you may paste just the key; the prefix is added for you.

In: header

Parámetros de ruta

withdrawal_id*string

The withdrawal id: withdrawal_id from POST /process/, or id from POST /withdrawals/.

Cuerpo de la respuesta

application/json

application/json

curl -X GET "https://example.com/withdrawals/7b57edd2-6594-4ef6-813b-df0d3d091a5c"
{
  "id": "7b57edd2-6594-4ef6-813b-df0d3d091a5c",
  "business_id": "69",
  "status": "FAILED",
  "amount": 1.7,
  "currency": "MXN",
  "transfer_method": "SPEI",
  "tracking_key": "a61c4f05b1de4645a1d2",
  "provider_reference": null,
  "account_data": {
    "nombre_beneficiario": "Ana Maria Gonzalez",
    "cuenta_beneficiario": "012969100000000013",
    "institucion_contraparte": "40012",
    "tipo_cuenta_beneficiario": 40,
    "rfc_curp_beneficiario": "GOAN850315AB2",
    "concepto_pago": "Pago de comisiones",
    "email": "ana.gonzalez@email.com"
  },
  "metadata": {
    "order_reference": "ORD-001"
  },
  "status_changes": [
    {
      "from_status": "PENDING",
      "to_status": "PROCESSING",
      "timestamp": "2026-10-13T18:40:23.497368",
      "reason": null
    },
    {
      "from_status": "PROCESSING",
      "to_status": "FAILED",
      "timestamp": "2026-10-13T18:40:23.497375",
      "reason": "Provider rejected: invalid_institution_id"
    }
  ],
  "action": {
    "action": "FAIL",
    "reason": "Provider rejected: invalid_institution_id"
  },
  "url_cep": "",
  "created_at": "2026-10-13T02:06:17.772297Z",
  "modified_at": "2026-10-13T18:40:23.512117Z",
  "paid_at": null
}
{
  "detail": "Invalid token."
}
Sin contenido
¿Te resultó útil esta página?