Skip to main content

​
Bem-vindo

Esta documentacao descreve os endpoints v1 utilizados para criar e listar clientes. Utilize o arquivo OpenAPI incluso no repositorio (api-reference/openapi.json) para gerar SDKs ou importar no Postman/Insomnia.

​
Base URLs

  • Produzido: https://api.payle.digital
  • Sandbox (exemplo): https://sandbox-api.payle.digital
Confirme o dominio correto no painel antes de integrar.

​
Autenticacao

Todos os endpoints exigem o header x-api-key: <sua-chave> gerado no dashboard Payle. Se o header nao for enviado ou estiver incorreto, a API responde 401 Unauthorized. Para operacoes de escrita, a conta proprietaria da chave precisa estar aprovada; caso contrario, o retorno sera 403 Forbidden.

​
Erros e rastreamento

Toda resposta de erro inclui correlationId. Informe-o ao acionar o suporte. Em ambientes de testes, detalhes adicionais podem ser expostos no campo message.

​
O que vem a seguir

  • Leia a visao geral em Clientes
  • Explore os exemplos de requisicao nas paginas de criar e listar clientes