Quickstart

Gere sua chave e cadastre seus IPs

No OriPay Web (app.oripaysolutions.com.br), em Conta → API, crie a chave com os scopes que precisa e os IPs fixos de saída do seu servidor, confirmando com o seu PIN. A chave aparece uma vez, logo ao criar. Guarde em um cofre de segredos, nunca no código. Chaves com transfers:write ou refunds:write só funcionam depois da aprovação da OriPay. Ver Autenticação.

Confira o saldo

curl https://api.oripaysolutions.com.br/v1/balance \
  -H "Authorization: Bearer $ORIPAY_API_KEY"

{ "available": 1005045, "blocked": 0, "currency": "BRL", "as_of": "2026-10-28T13:20:00Z" }

Cadastre seu webhook e teste

No OriPay Web, em Conta → API → Webhook, informe a URL. Guarde o secret (whsec_...) mostrado, que serve para validar a assinatura. Depois confira se o evento chega:

curl -X POST https://api.oripaysolutions.com.br/v1/webhook-endpoint/test \
  -H "Authorization: Bearer $ORIPAY_API_KEY"

Crie uma cobrança

curl -X POST https://api.oripaysolutions.com.br/v1/pix/charges \
  -H "Authorization: Bearer $ORIPAY_API_KEY" \
  -H "Idempotency-Key: 6f1c2a9e-pedido-8812" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 15000,
    "expires_in": 3600,
    "external_id": "pedido-8812",
    "description": "Pedido 8812",
    "metadata": { "customer_id": "cli_4471" }
  }'

Mostre qr_code (copia e cola) ou qr_code_image ao seu cliente.

Receba o evento

Quando o cliente paga, chega charge.paid no seu webhook com o mesmo external_id e metadata. Dê baixa no pedido pedido-8812 do cliente cli_4471.

Ainda não há sandbox (em breve). Para o primeiro teste, use uma cobrança de valor baixo e pague com uma conta sua.

Começando

Fundamentos

Fluxos PIX

Webhooks