Sandbox

Documentação da API · Zypher Global

Gerar credenciais

O Sandbox deixa você validar toda a sua integração (criar cobrança, receber o webhook, checar status) SEM mover dinheiro real. Nada é confirmado de verdade, é 100% isolado.

Uma requisição com a Chave de Teste NUNCA toca em adquirente, saldo ou transação real. As respostas têm o mesmo formato da produção (+ o campo "sandbox": true).

Chave de Teste (pública)

Use estas credenciais já disponíveis, não precisa gerar nada. São públicas de propósito (o sandbox não move dinheiro).

Headers
X-Client-Id: xpagsandbox_00000000
X-Client-Secret: 202620262026202620262026

1) Criar uma cobrança de teste

POST /cashin · mesma rota da produção. Troque currency por BRL · MXN para testar cada moeda.

Body
{
  "currency": "BRL",
  "amount": 100.00,
  "external_id": "TESTE-001",
  "webhook_url": "https://seusistema.com/webhooks/zypherglobal"
}
Resposta
{
  "sandbox": true,
  "ok": true,
  "status": "pending",
  "currency": "BRL",
  "amount": 100,
  "fee": 3,
  "request_number": "sbx_...",
  "transaction_id": "SBX-...",
  "copy_paste": "00020101...TEST...",
  "expire_minutes": 30
}

Guarde o transaction_id, é ele que você usa para simular o pagamento no próximo passo. Cada moeda devolve na resposta a instrução de pagamento correspondente (ex.: clabe no MXN, payee_data no COP).


2) Simular o pagamento (dispara o webhook)

POST /sandbox/simulate · confirma (ou falha) a cobrança de teste e dispara o webhook para a sua webhook_url, idêntico ao de produção.

Body
{
  "transaction_id": "SBX-...",
  "outcome": "paid"
}

outcome: paid · failed · expired — teste todos os cenários do seu handler.

Webhook enviado à sua URL
{
  "sandbox": true,
  "type": "cashin",
  "status": "confirmed",
  "amount": 100,
  "fee": 3,
  "transaction_id": "SBX-...",
  "external_id": "TESTE-001",
  "e2e": "E...",
  "provider": "Zypher Global"
}

Saldo e saque de teste

No sandbox o /balance devolve um saldo de teste alto, então você consegue testar o /cashout (saque) sem fundo real. O saque de teste também aceita o /sandbox/simulate para simular a baixa.

Conversão de moeda ainda NÃO está disponível no sandbox (ela mexe em saldo real). Todo o resto, cash in, cash out, status, saldo e webhook, funciona.
Esta página foi útil?