Começando

Autenticação

Toda chamada usa uma chave de API no cabeçalho Authorization. Cada chave tem escopos que limitam o que ela pode fazer.

Como enviar a chave

Envie a chave no cabeçalho Authorization de toda requisição:

Authorization: Bearer dk_000000000000_EXEMPLONAOUSE

Sem chave, com chave errada ou revogada, a API responde 401 com o código unauthenticated.

Escopos

Cada chave só faz o que os seus escopos permitem. Dê a cada chave apenas os escopos que ela precisa. Sem o escopo, a API responde 403 com o código insufficient_scope.

EscopoO que permite
PAYMENT:CREATECriar pagamentos Pix.
PAYMENT:READConsultar e listar pagamentos.
REFUND:CREATEPedir reembolsos.
REFUND:READConsultar reembolsos.
INFRACTION:READConsultar infrações.
BALANCE:READConsultar o saldo.
WITHDRAWAL:CREATEPedir saques.
WITHDRAWAL:READConsultar saques.
WEBHOOK:READConsultar endereços de webhook.
WEBHOOK:WRITECadastrar e desativar endereços de webhook.

Onde guardar a chave

  • Guarde a chave numa variável de ambiente ou num cofre de segredos do servidor.
  • Nunca coloque a chave no navegador, no aplicativo, no repositório de código ou em logs.
  • Use uma chave por sistema. Assim você revoga uma sem parar as outras.
  • Se a chave vazar, revogue no painel em Integração > Chaves de API e crie outra.

Chamadas do navegador

A API recusa chamadas feitas de páginas web de outros sites (código origin_forbidden). Faça todas as chamadas a partir do seu servidor.