Auth

Para gerar um AccessToken, será necessário informar o Token e a Chave Secreta gerados no menu "API > Credenciais".
Você pode cadastrar até 50 Credenciais distintas para gerar novos AccessToken's.

Antes de começar, os AccessToken's possuem escopos de permissão, e eles são separados por virgula.
Os escopos permitidos são: invoice.write, customer.write, webhook.write.

❗️ A validade de cada AccessToken é de 12 meses, sem precisar ficar gerando um novo AccessToken a cada requisição. Para gerar um novo access token, basta fazer uma nova solicitação.

Abaixo, você confere o que cada parâmetro de retorno significa.

Se for usar Cartão de Crédito, lembre-se de salve o valor do ACCOUNT, pois este será usado para gerar os tokens dos cartões.

PARÂMETRO	DESCRIÇÃO	VALORES
account	ID da Conta/AccountID, será usado para a geração do Token do Cartão de Crédito
access_token	Token de Acesso para uso do fluxo transacional
token_type	Tipo do AccessToken gerado, Basic ou Bearer
scope	Scopos de permissões configuradas	invoice.write, customer.write,webhook.write
expires_in	validade do token em timestamp
companie	ID da Empresa
working	Ambiente de Uso.	PRODUCTION SANDBOX
details	Array com detalhes da conta
details > type	Tipo de Conta	1 - Pessoa Fisica 2 - Pessoa Juridica
details > document	CPF/CNPJ da Conta
details > name	Razão Social/Nome
details > owner	Array com os dados do Titular da Empresa
details > owner > document	CPF/CNPJ do Titular da Empresa
details > sac	Array com os dados de SAC da Empresa
details > sac > phone	Telefone/Celular de SAC
details > sac > email	Email de SAC

Envie suas requisições HTTP com um cabeçalho

Authorization

que contenha a palavra Basic seguida por um espaço e uma string codificada em base64 username:password

Exemplo:

Authorization: Basic *****************

{ "account": "62081FA12FC2", "access_token": "NTg5OjE3MjExNDAlRqVlRSbG96VDJwdmVBPT0=", "token_type": "Bearer", "scope": [ "invoice.write", "customer.write", "webhook.write" ], "expires_in": 1752676224, "working": "PRODUCTION", "companie": 1, "details": { "type": 1, "document": "00000000000000", "name": "RAZAO SOCIAL", "social_name": "FANTASIA", "owner": { "document": "00000000000" }, "sac": { "phone": "00000000000", "email": "suporte@email.com" }, "softDesc": "****", "fees": { "warning": "These fees do not include the acquirer's fees.", "percent": 0, "cents": 0, "billet": { "percent": 0, "cents": 0 }, "pix": { "percent": 0, "cents": 0 }, "card": { "percent": 0, "cents": 0, "installments": { "x1": 0, "x2": 0, "x3": 0, "x4": 0, "x5": 0, "x6": 0, "x7": 0, "x8": 0, "x9": 0, "x10": 0, "x11": 0, "x12": 0 } } } }, "__seconds": 0.004478931427001953 }

Requisição

Respostas