Partners API - v1.0.11

Number of APIs: 20

Quem Somos

Somos o primeiro banco digital especialista em crédito e serviços financeiros para empresas com atendimento feito por contadores de todo o país.

Crie soluções inteligentes com nossas APIs de integração.

Fale Conosco

Para saber mais, nos visite em: https://www.contbank.com

Para maiores informações ou dúvidas: api@contbank.com

Como Utilizar

Esta documentação ajudará você a integrar o seu sistema aos serviços do Contbank via API, mas para integrar ao nosso sistema bancário, é necessário que você possua uma credencial de acesso, a qual deve ser solicitada previamente ao Time do Contbank.

A credencial identifica seu usuário e seu contrato com o Contbank. Mantenha essas informações protegidas, mesmo quando forem apenas credenciais de teste.

Passo a Passo : Análise e Obtenção da Credencial de Acesso

1) Solicitação

Por gentileza, encaminhe os dados abaixo para api@contbank.com

Basicamente, para darmos início ao processo de análise e criação das suas credenciais de acesso, precisaremos das seguintes informações:

CNPJ da sua Empresa.
Dados do responsável técnico : nome completo, e-mail e telefone.
Informações sobre as APIs que você deseja integrar: Extrato, Cobrança, entre outros.

2) Análise e permissionamento

Após o envio acima, nosso Time analisará as informações e entrará em contato pelo telefone ou e-mail indicados.

Nesta etapa, entenderemos melhor sua necessidade e nosso time de engenharia dará prosseguimento nas permissões necessárias.

3) Disponibilização das credenciais de acesso

Neste momento iremos encaminhar suas credencias de acesso para utilizar em nossos ambientes de teste (sandbox) e de produção
Você receberá as suas credenciais no e-mail informado na etapa de solicitação (Etapa 1).

Ambientes

Possuímos 2 (dois) ambientes disponíveis.

Ambiente/Environment	Descrição	URL
SANDBOX	Ambiente destinado a testes e validações	http://api.contbank.com.br/
PRODUCTION	Ambiente de produção	https://api.contbank.com/

Funcionalidades Disponíveis

Fique ligado! Estamos constantemente evoluindo nossa documentação no intuito de facilitar seu entendimento e possibilitar inovar em seu produto.

Até o momento, temos as seguintes funcionalidades disponíveis via API:

Funcionalidade	API	Ambientes Disponíveis
- Geração de token de acesso	Authentication	Produção e Sandbox
- Consulta de contas permissionadas	Authorization	Produção e Sandbox
- Consulta de dados bancários	Accounts	Produção e Sandbox
- Consulta de extrato bancário	Bank Statements	Produção e Sandbox
- Emissão de cobranças via BolePIX ou apenas via PIX	Billings	Produção e Sandbox
- Cancelamento de cobranças	Billings	Produção e Sandbox
- Consulta de cobranças emitidas	Billings	Produção e Sandbox
- Simulação de pagamentos de cobranças	Billings	Apenas em Sandbox, para testes e homologação.
- Webhook de cobranças	Webhooks	Produção e Sandbox

Perfis de Credenciais de Acesso

Existem dois perfis de credenciais disponíveis para autenticação na API: Parceiro e Parceiro Agente de Negócio.

Parceiro

O perfil de Parceiro permite que os parceiros se autentiquem usando seu próprio client_id e secret. Ao fazer uma autenticação, é necessário incluir essas informações no payload da requisição da seguinte maneira:

client_id:
client_secret:

Parceiro Agente de Negócio

O perfil de Parceiro Agente de Negócio permite que o parceiro faça autenticação usando as credenciais do Agente de Negócio. O Agente de Negócio fornecerá ao parceiro o client_id e secret do agente. Ao fazer uma autenticação, o parceiro deve incluir as seguintes informações no payload da requisição:

client_id:
client_secret:

No header da requisição deve informar a seguinte chave:

X-Partner-Id:

Certifique-se de incluir esses cabeçalhos corretamente em suas solicitações para autenticar como Parceiro ou Parceiro Agente de Negócio.

Token SMS - Fluxo de Onboarding em Sandbox

Nosso fluxo de onboarding exige que o cliente valide o número de celular via SMS.

Para o ambiente de Sandbox nós não disparamos o SMS, sendo o token fixo em 123456.

Portanto, caso você deseje abrir uma conta de teste no nosso ambiente de Sandbox, ao ser solicitado o token SMS, informe o valor acima.

No ambiente de Produção você ou seus clientes irão receber o SMS normalmente no número informado.

Vale indicar que o número do celular é único por usuário e contas PF, não podendo ser reutilizado em vários cadastros. A mesma regra também se aplica ao CPF e e-mail pessoal do contato.

Últimas Atualizações

Com o intuito de darmos visibilidade às implementações recentes, divulgamos abaixo um resumo das últimas atualizações na nossa documentação :

Data da Atualização	Descrição da Alteração
15/04/2024	Billings : Liberada a possibilidade de se efetuar cobranças apenas via PIX nos ambientes de Sandbox e de Produção. Foi incluída na documentação um exemplo de acionamento.
16/04/2024	Billings : Atualizado o exemplo cURL de criação do billing_method BOLETO.
29/04/2024	Billings : Atualizado o payload, incluindo o ispixqrcodefilerequired que permite indicar quando o QRCode em formato PNG é necessário no response. Incluído no response a indicação dos campos billingmethodrelated.pixencodedfile e billingmethodrelated.pixcopypaste.
11/05/2024	Bank Statements : Indicado o endpoint da v1 como depreciada. Incluída a chamada do extrato v2 e exemplo de sucesso da chamada. Adicionada maiores explicações sobre alguns campos do response da API de extrato.
12/05/2024	Balance : Disponibilizada API de consulta de saldos atuais.
22/05/2024	Billings : Alterado o endpoint de Get do PDF. Versão anterior do endpoint foi indicada como depreciada.

APIs

6. Billings - Get Billing By ID GET {{url_contbank}}/s2s/billings/:billing_id
6. Billings - [DEPRECATED] Get PDF GET {{url_contbank}}/s2s/billings/pdf/:billing_id
1. Authentication - Auth - Token Generate POST {{url_contbank}}/partner-login/token
2. Authorization - Get Authorized Customers GET {{url_contbank}}/authorization
7. Webhooks - Create Configuration POST {{url_contbank}}/partner-bff/s2s/webhooks/configuration
3. Accounts - Get Bank Account GET {{url_contbank}}/accounts/information
4. Balance - Get Balance GET {{url_contbank}}/partner-bff/s2s/balance?account_number=123456&result_level=DETAILED
5. Bank Statements - Get Bank Statement (v2) GET {{url_contbank}}/partner-bff/s2s/bank-statements?page=1&per_page=15&branch={{branch_number}}&account={{account_number}}&begin_date_time=2024-05-01T00:00:00.0000000Z&end_date_time=2024-05-31T00:00:00.0000000Z
5. Bank Statements - [DEPRECATED] Get Bank Statement (v1) GET {{url_contbank}}/bank-statements?page=1&per_page=5&branch={{branch_number}}&account={{account_number}}&begin_date_time=2022-09-01T04:11:53.6050541Z&end_date_time=2022-10-31T04:11:53.6050541Z
6. Billings - Create Billing POST {{url_contbank}}/billings/accounts/:account_id