Listar retiros
Lista tus retiros, paginados y filtrados por fecha de creación (`YYYY-MM-DD`). El filtro por `id` no está soportado — se ignora en silencio; para un retiro concreto usa el detalle. Un rango invertido responde `500`.
Autorización
Authorization 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 consulta
Page number, starting at 1.
Items per page.
First creation date to include, YYYY-MM-DD.
Last creation date to include, YYYY-MM-DD. Must not precede start_date.
Cuerpo de la respuesta
application/json
application/json
application/json
curl -X GET "https://example.com/withdrawals/query/"{
"count": 1,
"results": [
{
"id": "ea6ac67d-b577-481a-9b99-3c3c275ae527",
"business_id": "69",
"status": "PAID_FULL",
"amount": 20,
"currency": "MXN",
"transfer_method": "SPEI",
"tracking_key": "2da0310418da4be18419",
"account_data": {
"nombre_beneficiario": "Ana Maria Gonzalez",
"cuenta_beneficiario": "012969100000000110",
"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-01T17:35:02.118402",
"reason": null
},
{
"from_status": "PROCESSING",
"to_status": "PAID_FULL",
"timestamp": "2026-10-01T17:37:41.902188",
"reason": "succeeded"
}
],
"url_cep": "https://www.banxico.org.mx/cep/",
"created_at": "2026-10-01T17:33:41.364685Z",
"modified_at": "2026-10-01T17:37:41.998211Z",
"paid_at": "2026-10-01T17:37:41.998227Z"
}
],
"search_mode": "date_range"
}{
"detail": "Invalid token."
}{
"error": "Failed to fetch withdrawals"
}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`.
Consultar saldo disponible
Devuelve el saldo disponible para dispersar retiros. Solo `GET`. La forma de la respuesta depende de la configuración de tu comercio: puede traer solo `current_balance` o también `available` — léela de forma defensiva. El saldo no se valida al crear un retiro ni se reserva mientras está pendiente.
