Skip to main content

​
Para criar sua chave de API

Siga este passo a passo:
1

Acesse a aba OAuth no painel da Payloop

First step image for endpoint authenticate

Crie uma nova aplicação

  • Acesse o painel da Payloop e vá até a aba de OAuth
  • Na aba de OAuth, clique em Nova Aplicação
2

Preencha os dados da nova aplicação

Second step image for endpoint authenticate

Preencha o formulário

  • Preencha o campo Nome com o nome da aplicação na qual você irá utilizar o token
  • Preencha a URI de redirecionamento
  • Preencha os escopos que sua aplicação irá ter acesso ao utilizar a API da Payloop
3

Pegue os dados necessários para autenticar-se

Third step image for endpoint authenticate

Copie os dados necessários

  • UID
  • Token
  • Escopos
Passar os escopos separados por espaço no formato de string
4

Autentique-se no endpoint disponível na nossa documentação

Não altere o grant_type e site na requisição.

Fourth step image for endpoint authenticate
Fourth 2 step image for endpoint authenticate

Autenticando-se

Após você copiar os dados necessários, vá até nossa documentação da API e clique em Try it e preencha o payload com os dados copiados. Após isso, clique em Send.
Após criar seu token, você pode começar a integrar com nossa API, informando o subdomínio do seu site. Lembre-se de incluir o token em todas as requisições no header Authorization: 
curl --request GET \
  --url https://subdominio_do_seu_site.payloop.dev/api/customers \
  --header 'Authorization: Bearer <seu_token>'

​
Respostas da API

​
Sucesso — 200 OK

Quando a autenticação é realizada com sucesso, a API retorna um access_token válido para consumo dos endpoints protegidos. 
{
  "access_token": "example",
  "token_type": "Bearer",
  "expires_in": 72000,
  "scope": "customers_read customers_write payment_profiles_read payment_profiles_write subscriptions_read subscriptions_write subscription_items_read subscription_items_write",
  "created_at": "29/12/2025"
}

​
Erro de autenticação — 401 Unauthorized

A resposta abaixo indica que a autenticação falhou. 
{
  "error": "invalid_client",
	"error_description": "A autenticação do cliente falhou devido a cliente desconhecido, ausência de autenticação ou método de autenticação não suportado."
}
Se a API retornar o erro 401 Unauthorized, verifique se todos os dados enviados estão corretos.
Os erros mais comuns são:
  • Client ID (UID) inválido
  • Client Secret (Token) incorreto
  • Escopos não informados ou sem permissão
  • Escopos separados por vírgula
  • Site Alterar o subdomínio