Skip to content

Primeiros Passos

Bem-vindo a documentacao oficial da API NomadPay. Esta plataforma foi projetada para integrar pagamentos PIX com maxima facilidade e profissionalismo.


Ambientes

A NomadPay disponibiliza dois ambientes:

AmbienteURL BaseUso
Sandboxhttps://api.nomadspay.comTestes e desenvolvimento
Producaohttps://api.nomadspay.comOperacoes reais

No painel (Dashboard), alterne entre as credenciais de Sandbox e Live na aba API → Credenciais.


Fluxo Basico de Integracao

1. Criar Cobranca    →    POST /charges
2. Exibir QR Code    →    Use pix_code retornado
3. Aguardar pagamento →   Webhook charge.paid na sua URL
4. Confirmar e liberar →  Use o event_id para idempotencia

Autenticacao

Todas as requisicoes exigem o header Authorization com seu Client Secret:

http
Authorization: Bearer <SEU_CLIENT_SECRET>

Consulte a pagina de Autenticacao para mais detalhes.


Endpoints Disponiveis

MetodoRotaDescricao
POST/chargesCriar cobranca PIX
GET/charges/:idConsultar status de cobranca
GET/charges/balanceConsultar saldo disponivel
POST/withdrawalsSolicitar saque (Cash Out)