A API de autenticação do BS2 é baseada no protocolo basic auth, e as demais APIs do PIX são baseadas no protocolo Bearer authentication.

Para iniciar, vá em Primeiros Passos e cadastre as APIs do PIX que você deseja utilizar.

Gerar chave de acesso às APIs

Para realizar requisições nas APIs PIX Direto, é necessário gerar uma chave de acesso (access_token) por meio de uma requisição no endpoint de geração de token Gerando Access Tokens.

A validade da chave de acesso é obtida no objeto expires_in, em segundos.

É necessário que o parceiro realize a gestão da chave de acesso para garantir que todas as requisições nas APIs PIX Direto serão realizadas utilizando uma chave válida.

⚠️

Importante:

Quando um novo access_token é gerado, caso haja uma chave existente, esta será automaticamente invalidada.

Gerar token

1. Com a API Key, API Secret e Scope prepare uma requisição HTTP do tipo POST para o endpoint Gerando Access Tokens;
2. Utilize no header Authorization o tipo Basic Auth e insira suas credenciais em base64;
3. No Body, utilize o parâmetro scope com valor igual ao scope obtido junto às credenciais;
4. No Body, utilize o parâmetro grant_type com valor igual a client_credentials;
5. Realize a requisição e obtenha o access_token.

📝

Nota:

O access_token obtido na geração do token deverá ser utilizado nas demais requisições das APIs PIX Direto.