Definições Gerais

Endpoints da API

Segurança

HTTPS

Todos os endpoints da API BTG Empresas utilizam o protocolo HTTPS.

OAuth 2

A API BTG Empresas utiliza o protocolo de autorização OAuth 2 para permitir o acesso de aplicativos terceiros aos recursos do cliente. Através da plataforma BTG Id é possível que um aplicativo parceiro consiga consentimento e autorização para executar operações na API em nome do cliente.

📘

BTG Id

Para mais detalhes sobre como funciona o esquema de autenticação e autorização das APIs do BTG Empresas acesse a documentação do BTG Id

Códigos de Retorno

API do BTG Empresas utiliza códigos de resposta HTTP convencionais para indicar sucesso ou falha nas requisições à API.
Em geral, códigos na faixa 2XX indicam sucesso. Códigos no intervalo 4XX indicam um erro gerado a partir dos parâmetros enviados pelo cliente da API. Códigos na faixa 5XX indicam um erro nos servidores do BTG Empresas.

Status CodeDefinição
200 - OKA requisição foi bem sucedida.
201 - CreatedUma requisição que resulta na criação de um recurso foi bem sucedida. Os códigos de resposta 201, vem sempre acompanhados de um header Location com o endereço do recurso criado.
202 - AcceptedUma requisição que resulta na execução de uma operação assíncrona foi bem sucedida.
400 - Bad RequestRequisição inválida, geralmente devido ao envio de parâmetros inválidos ou a falta de dados obrigatórios para a operação. Esta classe de erros indica necessidade de ajustes na requisição feita pelo cliente.
401 - UnauthorizedRequisição não autorizada devido a erros relacionados a autenticação do token. O payload de resposta da api sempre retorna o motivo pelo qual a autenticação falhou.
403 - ForbiddenA requisição foi autenticada com sucesso, mas o token utilizado não tem permissões suficientes para executar a operação.
404 - Not FoundO recurso para qual a requisição foi feita não existe.
409 - ConflictA requisição conflita com outra requisição já feita, devido ao uso de uma mesma idempotent key, ou o recurso resultante da operação conflita com outro recurso já existente.
429 - Too Many RequestsMuitas requisições feitas pelo mesmo cliente em um curto espaço de tempo.
500, 502, 503, 504 - Server ErrorsAlgum problema acontecendo com os servers da API do BTG Empresas. Recomendamos visitar a página de status.

Paginação

A API do BTG Pactual Empresas utiliza o padrão de offset e limit para paginação de resultados. Os recursos que oferecem resultados paginados recebem pelo menos 2 parâmetros comuns, são eles:

  • limit: Quantidade limite de resultados por página.
  • offset: Define a partir de qual posição iniciar a página.

📘

Exemplo

/bank-slips?offset=10&limit=10