Consultar Transacciones

Documentación de la API · Zypher Global

Generar credenciales

Consulta el estado REAL de cualquier transacción, cash-in o cash-out, en cualquier moneda habilitada, en el cobro dinámico (por valor) o en la clave/CLABE fija (valor abierto). Todas las rutas exigen el permiso balance y están acotadas a la cuenta autenticada.

Prefiere recibir las confirmaciones por el webhook_url (webhook), es instantáneo. Usa la consulta para CONCILIAR (webhook perdido, estado indeterminado).
O /consult-transaction é UNIVERSAL: aceita qualquer identificador (request_number, transaction_id, e2e, external_id) seja de cash-in ou de cash-out e devolve o registro certo no campo type. O /consult-cashout continua funcionando (compatível com quem já usa).

Cash In por identificador (dinámico)

Cobro dinámico (con amount) = un solo pago. Consulta por el request_number o transaction_id devueltos en la creación.

Consulta
GET /consult-transaction?request_number=pr_...
GET /consult-transaction?transaction_id=pr_...
Respuesta
{
  "ok": true,
  "type": "cashin",
  "status": "pending|confirmed|expired",
  "amount": 123.45,
  "fee": 1.23,
  "request_number": "pr_...",
  "transaction_id": "pr_...",
  "e2e": "E...",
  "provider": "Zypher Global",
  "updated_at": "2026-07-24 12:00:00"
}

Vale para cualquier moneda habilitada, la moneda viene en el propio registro.

Cash In por clave/CLABE fija (estático · LISTA)

La clave PIX fija (BRL) y la CLABE fija (MXN) reciben VARIOS pagos y no tienes el transaction_id de cada uno. Consulta por clabe O por external_id → devuelve la LISTA de los cobros de esa clave.

Consulta
GET /consult-transaction?clabe=012345678901234567
GET /consult-transaction?external_id=PEDIDO-123
GET /consult-transaction?external_id=PEDIDO-123&limit=20
Respuesta
{
  "ok": true,
  "type": "cashin",
  "count": 2,
  "payments": [
    { "id": "pr_...", "status": "confirmed", "amount": 100.00, "fee": 1.00, "currency": "MXN",
      "e2e": "E...", "transaction_id": "...", "external_id": "PEDIDO-123",
      "clabe": "0123...", "payer_name": "...", "created_at": "...", "updated_at": "..." }
  ]
}
Para la clave PIX fija (BRL), consulta por external_id (no tienes CLABE). Para la CLABE fija (MXN), consulta por clabe o external_id. El limit limita la lista (por defecto 20, máx 100).

Cash Out (retiro)

Consulta el estado real de un retiro, esencial para no quedarte con el cash-out indeterminado si falla un webhook. Busca por uno de estos:

Parámetros (uno de ellos)
GET /consult-cashout?e2e=E...
GET /consult-cashout?transaction_id=pr_...
GET /consult-cashout?external_id=SAQUE-123
Respuesta
{
  "ok": true,
  "type": "cashout",
  "status": "pending|completed|failed",
  "amount": 250.00,
  "fee": 2.50,
  "currency": "BRL",
  "e2e": "E...",
  "transaction_id": "pr_...",
  "external_id": "SAQUE-123",
  "provider": "Zypher Global",
  "beneficiary": { "name": "Fulano de Tal", "document": "00000000000", "bank": "NUBANK" },
  "pix_key": "[email protected]",
  "pix_type": "EMAIL",
  "created_at": "2026-07-24 12:00:00",
  "updated_at": "2026-07-24 12:00:05",
  "paid_at": "2026-07-24 12:00:05"
}

Vale para retiro en cualquier moneda habilitada, la moneda viene en currency.

Los identificadores vienen enmascarados como referencias públicas (pr_...) y el provider muestra el nombre de la plataforma, los IDs internos nunca se exponen.
AnteriorConvertir Moneda Siguiente Webhooks
¿Esta página fue útil?