Introdução

A OrcaPay oferece uma API REST para processar pagamentos via Pix e cartão de crédito. Esta documentação reúne tudo o que você precisa para integrar sua aplicação.

Como funciona

A integração com a OrcaPay segue três passos:

1. Obtenha sua chave de API no console da OrcaPay — veja Autenticação.
2. Teste a integração usando o endpoint de sandbox de cartão — veja Testando a integração.
3. Processe pagamentos e acompanhe o status em tempo real com webhooks.

Formato da API

• Base URL: https://api.orcapay.com.br
• Todas as requisições e respostas usam JSON.
• A API é servida exclusivamente por HTTPS.
• Valores monetários são decimais em reais (ex.: 159.90), entre 0.01 e 1000000.00.
• Datas e horários seguem o padrão ISO 8601 em UTC (ex.: 2026-07-18T14:30:00Z).
• A autenticação é feita pelo header X-Api-Key.

curl https://api.orcapay.com.br/payments \
  -H "X-Api-Key: op_live_..." \
  -H "Content-Type: application/json"

Próximos passos

• Autenticação — configure sua chave e entenda os escopos.
• Pagamentos — crie sua primeira cobrança Pix ou cartão.
• Referência da API — todos os endpoints em detalhe.