API PIXPAY / V1 / SANDBOX

Integre pagamentos
sem perder o controle.

A API PixPay usa JSON, autenticação por credenciais próprias e idempotência em todas as operações críticas.

01

Introdução

Comece no ambiente sandbox e avance para produção somente após validar seu fluxo completo.

02

Autenticação

Envie sua API Key e assine requisições com o secret exibido uma única vez.

03

Ambientes

Sandbox não movimenta dinheiro. Produção permanecerá indisponível nesta fase.

04

Criar cliente

Cadastre o pagador antes de iniciar uma cobrança.

05

Criar cobrança PIX

Crie uma cobrança com valor em centavos, cliente e external_id único.

cURL
curl -X POST https://api.SEU_DOMINIO/v1/pix/charges \
  -H "Idempotency-Key: order_123" \
  -H "Content-Type: application/json" \
  -d '{"amount":25000,"customer":"cus_..."}'
06

Consultar PIX

Consulte pelo identificador público e acompanhe os estados da cobrança.

07

Saques

Saques estão disponíveis apenas como simulação nesta fase.

08

Webhooks

Eventos são assinados e cada tentativa de entrega fica registrada.

09

Erros

Todos os erros seguem um envelope consistente e incluem request_id.

{
  "error": {
    "code": "INSUFFICIENT_BALANCE",
    "message": "Saldo insuficiente.",
    "request_id": "req_..."
  }
}
10

Idempotência

Envie Idempotency-Key. Repetições equivalentes retornam a operação existente.