Sandbox

Documentación de la API · Zypher Global

Generar credenciales

El Sandbox te permite validar toda tu integración (crear cobro, recibir el webhook, consultar estado) SIN mover dinero real. Nada se confirma de verdad, es 100% aislado.

Una solicitud con la Clave de Prueba NUNCA toca adquirente, saldo ni transacción real. Las respuestas tienen el mismo formato de producción (+ el campo "sandbox": true).

Clave de Prueba (pública)

Usa estas credenciales ya disponibles, no necesitas generar nada. Son públicas a propósito (el sandbox no mueve dinero).

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

1) Crear un cobro de prueba

POST /cashin · misma ruta de producción. Cambia currency por BRL · MXN para probar cada moneda.

Body
{
  "currency": "BRL",
  "amount": 100.00,
  "external_id": "TESTE-001",
  "webhook_url": "https://seusistema.com/webhooks/zypherglobal"
}
Respuesta
{
  "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
}

Guarda el transaction_id, es el que usas para simular el pago en el siguiente paso. Cada moneda devuelve en la respuesta la instrucción de pago correspondiente (ej.: clabe en MXN, payee_data en COP).


2) Simular el pago (dispara el webhook)

POST /sandbox/simulate · confirma (o falla) el cobro de prueba y dispara el webhook a tu webhook_url, idéntico al de producción.

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

outcome: paid · failed · expired — prueba todos los escenarios de tu handler.

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

Saldo y retiro de prueba

En el sandbox el /balance devuelve un saldo de prueba alto, así puedes probar el /cashout (retiro) sin fondos reales. El retiro de prueba también acepta el /sandbox/simulate para simular la liquidación.

La conversión de moneda aún NO está disponible en el sandbox (mueve saldo real). Todo lo demás, cash in, cash out, estado, saldo y webhook, funciona.
¿Esta página fue útil?