Consultar Transações

Documentação da API · Zypher Global

Gerar credenciais

Consulte o estado REAL de qualquer transação, cash-in ou cash-out, em qualquer moeda habilitada, na cobrança dinâmica (por valor) ou na chave/CLABE fixa (valor aberto). Todas as rotas exigem a permissão balance e são escopadas à conta autenticada.

Prefira receber as confirmações pelo webhook_url (webhook), é instantâneo. Use a consulta para RECONCILIAR (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)

Cobrança dinâmica (com amount) = um pagamento só. Consulte pelo request_number ou transaction_id devolvidos na criação.

Consulta
GET /consult-transaction?request_number=pr_...
GET /consult-transaction?transaction_id=pr_...
Resposta
{
  "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 qualquer moeda habilitada, a moeda vem no próprio registro.

Cash In por chave/CLABE fixa (estático · LISTA)

A chave PIX fixa (BRL) e a CLABE fixa (MXN) recebem VÁRIOS pagamentos e você não tem o transaction_id de cada um. Consulte por clabe OU por external_id → devolve a LISTA dos recebimentos daquela chave.

Consulta
GET /consult-transaction?clabe=012345678901234567
GET /consult-transaction?external_id=PEDIDO-123
GET /consult-transaction?external_id=PEDIDO-123&limit=20
Resposta
{
  "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 a chave PIX fixa (BRL), consulte por external_id (você não tem a CLABE). Para a CLABE fixa (MXN), consulte por clabe ou external_id. O limit limita a lista (padrão 20, máx 100).

Cash Out (saque)

Consulta o estado real de um saque, essencial pra não ficar com o cash-out indeterminado se um webhook falhar. Busque por um destes:

Parâmetros (um deles)
GET /consult-cashout?e2e=E...
GET /consult-cashout?transaction_id=pr_...
GET /consult-cashout?external_id=SAQUE-123
Resposta
{
  "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 saque em qualquer moeda habilitada, a moeda vem em currency.

Os identificadores vêm mascarados como referências públicas (pr_...) e o provider aparece com o nome da plataforma, os IDs internos nunca são expostos.
AnteriorConverter Moeda Próximo Webhooks
Esta página foi útil?