Query Transactions

API Documentation · Zypher Global

Generate credentials

Query the REAL state of any transaction, cash-in or cash-out, in any enabled currency, on the dynamic charge (by amount) or on the fixed key/CLABE (open amount). All routes require the balance permission and are scoped to the authenticated account.

Prefer receiving confirmations via the webhook_url (webhook), it is instant. Use the query to RECONCILE (lost webhook, undetermined state).
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 by identifier (dynamic)

Dynamic charge (with amount) = a single payment. Query by the request_number or transaction_id returned at creation.

Query
GET /consult-transaction?request_number=pr_...
GET /consult-transaction?transaction_id=pr_...
Response
{
  "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"
}

Works for any enabled currency, the currency comes in the record itself.

Cash In by fixed key/CLABE (static · LIST)

The fixed PIX key (BRL) and the fixed CLABE (MXN) receive MULTIPLE payments and you do not have the transaction_id of each one. Query by clabe OR by external_id → returns the LIST of that key receipts.

Query
GET /consult-transaction?clabe=012345678901234567
GET /consult-transaction?external_id=PEDIDO-123
GET /consult-transaction?external_id=PEDIDO-123&limit=20
Response
{
  "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": "..." }
  ]
}
For the fixed PIX key (BRL), query by external_id (you have no CLABE). For the fixed CLABE (MXN), query by clabe or external_id. The limit limits the list (default 20, max 100).

Cash Out (withdrawal)

Queries the real state of a withdrawal, essential so the cash-out is not left undetermined if a webhook fails. Search by one of these:

Parameters (one of them)
GET /consult-cashout?e2e=E...
GET /consult-cashout?transaction_id=pr_...
GET /consult-cashout?external_id=SAQUE-123
Response
{
  "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"
}

Works for withdrawal in any enabled currency, the currency comes in currency.

Identifiers come masked as public references (pr_...) and the provider shows the platform name, internal IDs are never exposed.
PreviousConvert Currency Next Webhooks
Was this page helpful?