{"info":{"_postman_id":"4f849c07-83aa-4529-9f9a-ab66337830dc","name":"Partners API - v1.0.11","description":" $\"Contbank\"$ \n\n

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.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

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:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

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 :

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

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 is_pix_qrcode_file_required que permite indicar quando o QRCode em formato PNG é necessário no response. Incluído no response a indicação dos campos billing_method_related.pix_encoded_file e billing_method_related.pix_copy_paste.
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

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Quem Somos","slug":"quem-somos"},{"content":"Fale Conosco","slug":"fale-conosco"},{"content":"Como Utilizar","slug":"como-utilizar"},{"content":"Ambientes","slug":"ambientes"},{"content":"Funcionalidades Disponíveis","slug":"funcionalidades-disponiveis"},{"content":"Perfis de Credenciais de Acesso","slug":"perfis-de-credenciais-de-acesso"},{"content":"Token SMS - Fluxo de Onboarding em Sandbox","slug":"token-sms-fluxo-de-onboarding-em-sandbox"},{"content":"Últimas Atualizações","slug":"ultimas-atualizacoes"},{"content":"APIs","slug":"apis"}],"owner":"24543234","collectionId":"4f849c07-83aa-4529-9f9a-ab66337830dc","publishedId":"2s8YsnWw4N","public":true,"customColor":{"top-bar":"FFE03D","right-sidebar":"1E2124","highlight":"f0c100"},"publishDate":"2022-11-23T06:11:00.000Z"},"item":[{"name":"1. Authentication","item":[{"name":"Auth - Token Generate","event":[{"listen":"test","script":{"id":"23b94f3a-daa7-4882-b2c5-7fdf28272d06","exec":["var jsonData = JSON.parse(responseBody);\r","postman.setEnvironmentVariable(\"partner_token\", jsonData.access_token);"],"type":"text/javascript"}}],"id":"4be98656-b00e-47b4-9a94-a90ef603f4a6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Partner-Id","value":"Credencial enviada por email.","description":"

Obrigatório apenas quando as credenciais são de Parceiro Agente de Negócio

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"client_id\": \"PARTNER_CLIENT_ID_REQUIRED\",\n \"client_secret\": \"PARTNER_CLIENT_SECRET_ID_REQUIRED\"\n}","options":{"raw":{"language":"json"}}},"url":"{{url_contbank}}/partner-login/token","description":"

Json Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

key	value
client_id	string/required
client_secret	string/required

","urlObject":{"path":["partner-login","token"],"host":["{{url_contbank}}"],"query":[],"variable":[]}},"response":[{"id":"8b55880b-1926-4b30-92d0-c06809a9fbce","name":"200 Response","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"client_id\" : \"Eo85YB6jrWkJmvj2Vs5S9JvE71QO8VI1\",\n \"client_secret\": \"lkdvyG0WJoOA5MeKB5aT8Ttfoci3VWz7fm7wV1SeCE2IhgJZcAwTCagvBCdxUCLY\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.contbank.com.br/partner-login/token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 26 Sep 2022 22:15:18 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"941"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, Accept, X-Token, X-Current-Identity, *"},{"key":"Access-Control-Allow-Methods","value":"*"},{"key":"Access-Control-Allow-Origin","value":""},{"key":"Alt-Svc","value":"h3=\":443\"; ma=86400, h3-29=\":443\"; ma=86400"},{"key":"Cache-Control","value":"no-store"},{"key":"Cf-Cache-Status","value":"DYNAMIC"},{"key":"Cf-Ray","value":"750f5b7d1e64c521-SEA"},{"key":"Content-Encoding","value":"br"},{"key":"Ot-Baggage-Auth0-Request-Id","value":"750f5b7d1e64c521"},{"key":"Ot-Tracer-Sampled","value":"true"},{"key":"Ot-Tracer-Spanid","value":"2dbaf48d6d60093b"},{"key":"Ot-Tracer-Traceid","value":"496dd63a21100dd0"},{"key":"Pragma","value":"no-cache"},{"key":"Request-Id","value":"eb7a84f0-f8d5-4fd7-9b4d-0a7c1ed2909f"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"},{"key":"Traceparent","value":"00-2dbaf48d6d60093b-0000000000000000496dd63a21100dd0-01"},{"key":"Tracestate","value":"auth0-request-id=750f5b7d1e64c521,auth0=true"},{"key":"Vary","value":"Accept-Encoding, Origin"},{"key":"X-Auth0-Requestid","value":"ba10a96fb1698d87680a"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Ratelimit-Limit","value":"3"},{"key":"X-Ratelimit-Remaining","value":"2"},{"key":"X-Ratelimit-Reset","value":"0"}],"cookie":[],"responseTime":null,"body":"{\n \"access_token\": \"eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6InVKVjAxMFZsbVpyeE5RelZRVEVYQSJ9\",\n \"expires_in\": 86400,\n \"token_type\": \"Bearer\"\n}"},{"id":"d694291b-f92c-405a-8e53-3d3b410bfa53","name":"403 Response","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"client_id\": \"PARTNER_CLIENT_ID_REQUIRED\",\n \"client_secret\": \"PARTNER_CLIENT_SECRET_REQUIRED\"\n}","options":{"raw":{"language":"json"}}},"url":"{{url_contbank}}/partner-login/token"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 21 Nov 2022 18:17:34 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"72"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, Accept, X-Token, X-Current-Identity, *"},{"key":"Access-Control-Allow-Methods","value":"*"},{"key":"Access-Control-Allow-Origin","value":""},{"key":"Alt-Svc","value":"h3=\":443\"; ma=86400, h3-29=\":443\"; ma=86400"},{"key":"Cache-Control","value":"private, no-store, no-cache, must-revalidate, post-check=0, pre-check=0, no-transform"},{"key":"Cf-Cache-Status","value":"DYNAMIC"},{"key":"Cf-Ray","value":"76db6c45ac53c729-SEA"},{"key":"Ot-Baggage-Auth0-Request-Id","value":"76db6c45ac53c729"},{"key":"Ot-Tracer-Sampled","value":"true"},{"key":"Ot-Tracer-Spanid","value":"474cf2a676364406"},{"key":"Ot-Tracer-Traceid","value":"2605657d321c8911"},{"key":"Request-Id","value":"881ac328-6a3c-4e10-9e72-84a3b804fc85"},{"key":"Set-Cookie","value":"did=s%3Av0%3Ac56aa630-69c8-11ed-b3df-c3851700963f.6ATcH5al6ml5dRCNEhwApIOv6UYAgLIbKCIqe4aNMXc; Max-Age=31557600; Path=/; Expires=Wed, 22 Nov 2023 00:17:34 GMT; HttpOnly; Secure; SameSite=None"},{"key":"Set-Cookie","value":"did_compat=s%3Av0%3Ac56aa630-69c8-11ed-b3df-c3851700963f.6ATcH5al6ml5dRCNEhwApIOv6UYAgLIbKCIqe4aNMXc; Max-Age=31557600; Path=/; Expires=Wed, 22 Nov 2023 00:17:34 GMT; HttpOnly; Secure"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"},{"key":"Traceparent","value":"00-00000000000000002605657d321c8911-474cf2a676364406-01"},{"key":"Tracestate","value":"auth0-request-id=76db6c45ac53c729,auth0=true"},{"key":"Vary","value":"Accept-Encoding, Origin"},{"key":"X-Auth0-Requestid","value":"473b44c9dc421852fdea"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Ratelimit-Limit","value":"30"},{"key":"X-Ratelimit-Remaining","value":"29"},{"key":"X-Ratelimit-Reset","value":"1669054655"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"invalid_grant\",\n \"error_description\": \"Wrong email or password.\"\n}"}],"_postman_id":"4be98656-b00e-47b4-9a94-a90ef603f4a6"}],"id":"5da9f25d-8b4d-4e85-9d76-e4fd73c150f0","description":"

Endpoint responsável por gerar o token JWT, necessário para as requisições de parceiro.

O client_id e client_secret são obrigatórios no Body da requisição.

\n","event":[{"listen":"prerequest","script":{"id":"db2d53aa-a4b5-44d3-93ab-4db283c1b5e2","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"762a540c-1ea5-43b1-9da4-6246c84eda39","type":"text/javascript","exec":[""]}}],"_postman_id":"5da9f25d-8b4d-4e85-9d76-e4fd73c150f0"},{"name":"2. Authorization","item":[{"name":"Get Authorized Customers","id":"43b07474-84bc-48e0-94ea-16a05b104eaa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{partner_token}}"},"isInherited":false},"method":"GET","header":[],"url":"{{url_contbank}}/authorization","description":"

Rota responsável por devolver uma lista com todos os clientes, PF ou PJ, autorizados para o token que esta realizando a requisição.

SCHEMA DETAILS

Banks List Object - Users Authorized

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

key	value
current_identity	CPF/CNPJ do cliente.
name	Nome do cliente.
permissions	Escopo das permissões autorizadas pelo cliente.
profile_type	Tipo de perfil do cliente, PERSONAL (PF) ou BUSINESS (PJ).

Permissions Object - Scopes Details

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Permission	Detail
read:bank-statements	Conta autorizada para consultar o extrato bancário.
read:billings	Conta autorizada para consultar as cobranças.
write:billings	Conta autorizada para gerar cobranças.
read:accounts	Conta autorizada para consultar os dados bancários.

","urlObject":{"path":["authorization"],"host":["{{url_contbank}}"],"query":[],"variable":[]}},"response":[{"id":"2a57b363-0ea8-4532-98ec-3269c191ff9e","name":"200 - List of authorized clients for token.","originalRequest":{"method":"GET","header":[],"url":"api.contbank.com.br/authorization"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 21 Nov 2022 19:49:37 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"436"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, Accept, X-Token, X-Current-Identity, *"},{"key":"Access-Control-Allow-Methods","value":"*"},{"key":"Access-Control-Allow-Origin","value":""},{"key":"Request-Id","value":"8d6c0c2f-61b8-48e8-87e8-009f6e1cade8"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"user_id\": \"636a96a159fd21aa2851b034\",\n \"email\": \"sandbox_2@contbank.com\",\n \"banks\": [\n {\n \"name\": \"Usuário Sandbox 2\",\n \"current_identity\": \"99999999999\",\n \"permissions\": [\n \"read:accounts\",\n \"read:bank-statements\"\n ],\n \"is_admin\": false,\n \"profile_type\": \"PERSONAL\"\n },\n {\n \"name\": \"Usuário Sandbox 1\",\n \"current_identity\": \"12345678911\",\n \"permissions\": [\n \"read:accounts\",\n \"write:billings\",\n \"read:billings\",\n \"read:bank-statements\"\n ],\n \"is_admin\": false,\n \"profile_type\": \"PERSONAL\"\n }\n ]\n}"},{"id":"4eca9b28-2cda-49d7-bd0c-7e1d4a7ce044","name":"401 - Wrong or expired token.","originalRequest":{"method":"GET","header":[],"url":"{{url_contbank}}/authorization"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Mon, 21 Nov 2022 18:24:02 GMT"},{"key":"Content-Length","value":"0"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, Accept, X-Token, X-Current-Identity, *"},{"key":"Access-Control-Allow-Methods","value":"*"},{"key":"Access-Control-Allow-Origin","value":""},{"key":"Request-Id","value":"76a4d8e8-dd8e-4ee5-8a24-fc8f9d8a4748"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":null},{"id":"9286bddc-c3d5-4b3f-86ab-17019970134e","name":"404 - Partner has no authorized customers","originalRequest":{"method":"GET","header":[],"url":"{{url_contbank}}/authorization"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 21 Nov 2022 18:49:00 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"37"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, Accept, X-Token, X-Current-Identity, *"},{"key":"Access-Control-Allow-Methods","value":"*"},{"key":"Access-Control-Allow-Origin","value":""},{"key":"Request-Id","value":"ec82092c-e71c-4d17-8590-8adbedc7eb9e"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 404,\n \"messages\": [\n \"not found\"\n ]\n}"}],"_postman_id":"43b07474-84bc-48e0-94ea-16a05b104eaa"}],"id":"8cee9bdc-157f-485c-8271-d081a19054af","description":"

Consultas referentes as autorizações do seu token.

\n","auth":{"type":"bearer","bearer":{"token":"{{partner_token}}"},"isInherited":false},"event":[{"listen":"prerequest","script":{"id":"877ff0f7-dfa0-4e34-8867-306f264cace3","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"8b984583-5446-492c-8efe-f84539d289c6","type":"text/javascript","exec":[""]}}],"_postman_id":"8cee9bdc-157f-485c-8271-d081a19054af"},{"name":"3. Accounts","item":[{"name":"Get Bank Account","event":[{"listen":"test","script":{"id":"d32f67b7-8c8b-49f2-af94-74463db41eb9","exec":["var jsonData = JSON.parse(responseBody);\r","postman.setEnvironmentVariable(\"account_id\", jsonData.account_id);\r","postman.setEnvironmentVariable(\"branch_number\", jsonData.branch);\r","postman.setEnvironmentVariable(\"account_number\", jsonData.number);\r",""],"type":"text/javascript"}}],"id":"14824754-2968-4198-b03e-f7ced87f360b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{partner_token}}"},"isInherited":false},"method":"GET","header":[{"key":"X-Current-Identity","value":"99999999999999","description":"

CNPJ/CPF do cliente para consulta dos dados bancários.

\n","type":"text"}],"url":"{{url_contbank}}/accounts/information","description":"

Endpoint responsável por retornar as informações da conta bancária do cliente. Para isto, será necessário consultar a partir do CPF/CNPJ dele.

Header

O CPF/CNPJ deve ser repassado no X-Current-Identity, no header da requisição.

Agência e Conta

As informações retornadas nesta consulta são fundamentais para o acionamento de outros endpoints, como por exemplo, a geração de cobranças (billings). É a partir da informação de agência (branch) e conta (number) que conseguiremos identificar para qual cliente você, integrador, deseja emitir.

Response Schema - 200 Ok

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Value
status	Indica o status da conta, podendo ser ATIVA ou INATIVA.
branch	Indica o número da agência da conta.
number	Indica o número da conta.
account_id	Indica o id da conta, necessário para geração de cobranças.

Response Schema - 403 Forbidden

Quanto retornado o código 403, significa que você não possui permissão de acesso aos dados do CPF/CNPJ informado.

Response Schema - 404 Not Found

Ao acionar este endpoint e obter o código 404 como retorno, significa que o cliente em questão ainda não concluiu a abertura da sua conta, portanto não tendo resultado a ser apresentado e não sendo possível gerar operações para este cliente.

No momento em que o cliente concluir a abertura, automaticamente você terá acesso e então, este endpoint começará a retornar os dados esperados (response code 200).

\n","urlObject":{"path":["accounts","information"],"host":["{{url_contbank}}"],"query":[],"variable":[]}},"response":[{"id":"1b6d27c0-d1d5-423a-b4c1-a255b929cd38","name":"200 - Customer account details.","originalRequest":{"method":"GET","header":[{"key":"X-Current-Identity","value":"99999999999999","description":"CNPJ/CPF do cliente para consulta dos dados bancários.","type":"text"}],"url":"api.contbank.com.br/accounts/information"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"account_id\": \"000a1c100dc010f2a982dc00\",\n \"status\": \"APPROVED\",\n \"number\": \"444411111\",\n \"branch\": \"0001\"\n}"},{"id":"4f2dcf46-cc85-45db-a9e4-e6a2b5b70009","name":"403 - Customer identifier not authorized","originalRequest":{"method":"GET","header":[{"key":"X-Current-Identity","value":"99999999999999","description":"CNPJ/CPF do cliente para consulta dos dados bancários.","type":"text"}],"url":"{{url_contbank}}/accounts/information"},"status":"Forbidden","code":403,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Mon, 21 Nov 2022 20:23:08 GMT"},{"key":"Content-Length","value":"0"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, Accept, X-Token, X-Current-Identity, *"},{"key":"Access-Control-Allow-Methods","value":"*"},{"key":"Access-Control-Allow-Origin","value":""},{"key":"Request-Id","value":"fa3bc1a0-663a-46c1-b3e9-15ac9232fd23"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":null},{"id":"27995874-e2a7-4be7-91c3-16a2309687e5","name":"404 - Customer account not active","originalRequest":{"method":"GET","header":[{"key":"X-Current-Identity","value":"99999999999999","description":"CNPJ/CPF do cliente para consulta dos dados bancários.","type":"text"}],"url":"{{url_contbank}}/accounts/information"},"code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 404,\n \"key\": \"NOT_FOUND\",\n \"messages\": [\n \"not found\"\n ]\n}"}],"_postman_id":"14824754-2968-4198-b03e-f7ced87f360b"}],"id":"0faabc8c-9cbf-4c28-8b88-2c5979c7ff45","description":"

Consultas referentes as contas dos clientes.

\n","auth":{"type":"bearer","bearer":{"token":"{{partner_token}}"},"isInherited":false},"event":[{"listen":"prerequest","script":{"id":"7e1c4b52-48ca-4f7c-ae64-2c715638d53e","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"bca8a4da-9339-48e2-8c47-9bb754d7e56a","type":"text/javascript","exec":[""]}}],"_postman_id":"0faabc8c-9cbf-4c28-8b88-2c5979c7ff45"},{"name":"4. Balance","item":[{"name":"Get Balance","event":[{"listen":"test","script":{"id":"d32f67b7-8c8b-49f2-af94-74463db41eb9","exec":[""],"type":"text/javascript","packages":{}}}],"id":"af01cbd9-54db-48d1-896e-81987d8f4cad","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{partner_token}}"},"isInherited":false},"method":"GET","header":[{"key":"X-Current-Identity","value":"99999999999999","description":"

CNPJ/CPF do cliente

\n","type":"text"}],"url":"{{url_contbank}}/partner-bff/s2s/balance?account_number=123456&result_level=DETAILED","description":"

Endpoint responsável por retornar os saldos das contas correntes.

Header

O CPF/CNPJ deve ser repassado no X-Current-Identity, no header da requisição.

Response Schema - 200 Ok

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Value
branch_number	Indica o número da agência da conta.
account_number	Número da conta.
balance_date	Data do saldo
available.currency	Moeda do saldo disponível. BRL indica em reais.
available.amount	Saldo atual disponível. Valor monetário.

","urlObject":{"path":["partner-bff","s2s","balance"],"host":["{{url_contbank}}"],"query":[{"description":{"content":"

Número da conta

\n","type":"text/plain"},"key":"account_number","value":"123456"},{"description":{"content":"

BASIC ou DETAILED

\n","type":"text/plain"},"key":"result_level","value":"DETAILED"}],"variable":[]}},"response":[{"id":"037c4abb-1f2c-431a-8bb9-5ba7b716144c","name":"200 - Balance","originalRequest":{"method":"GET","header":[{"key":"X-Current-Identity","value":"99999999999999","description":"CNPJ/CPF do cliente","type":"text"}],"url":{"raw":"{{url_contbank}}/partner-bff/s2s/balance?account_number=123456&result_level=DETAILED","host":["{{url_contbank}}"],"path":["partner-bff","s2s","balance"],"query":[{"key":"account_number","value":"123456","description":"Número da conta"},{"key":"result_level","value":"DETAILED","description":"BASIC ou DETAILED"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"branch_number\": \"0001\",\n \"account_number\": \"123456\",\n \"balance_date\": \"2024-05-12T00:00:00.000000000Z\",\n \"available\": {\n \"currency\": \"BRL\",\n \"amount\": 15213.91\n }\n}"}],"_postman_id":"af01cbd9-54db-48d1-896e-81987d8f4cad"}],"id":"dfb946da-b694-4740-bdff-991e71d4d706","description":"

Consulta de saldo.

\n","auth":{"type":"bearer","bearer":{"token":"{{partner_token}}"},"isInherited":false},"event":[{"listen":"prerequest","script":{"id":"7e1c4b52-48ca-4f7c-ae64-2c715638d53e","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"bca8a4da-9339-48e2-8c47-9bb754d7e56a","type":"text/javascript","exec":[""]}}],"_postman_id":"dfb946da-b694-4740-bdff-991e71d4d706"},{"name":"5. Bank Statements","item":[{"name":"Get Bank Statement (v2)","id":"44023331-547b-4ce1-8f57-06b385597e9a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{partner_token}}"},"isInherited":false},"method":"GET","header":[{"key":"X-Current-Identity","value":"12345678901","description":"

CPF/CNPJ do usuário

\n","type":"text"}],"url":"{{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","description":"

API de extrato : retorna os dados agrupados por data, além do saldo diário.

Response Schema

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Campo	Descrição
page	Número da página retornada. Página atual.
per_page	Quantidade de registros por página. Este valor é enviado no request.
has_next_page	Valor booleano. Indica se há uma próxima página a ser retornada. Se o valor indicado for false, significa que não há próxima página. Se o valor for true, há uma nova página.
itens	Lista das transações retornadas para os filtros aplicados.
itens.aggregate_id	Valor chave da transação.
itens.document_number	CPF/CNPJ da conta.
itens.bank_branch	Agência da conta.
itens.bank_account	Número da conta.
itens.amount	Valor da transação.
itens.name	Tipo da transação.
itens.timestamp	Data e hora da transação.
itens.label	Descrição da transação.
itens.data	Dados extras referente a transação. Os campos e valores contidos neste objeto diferem dependendo do tipo de transação.
itens.data.conciliation_description	Descrição da transação. Essa descrição também é utilizada no arquivo OFX. Pode ser utilizado para conciliar API e OFX.
itens.data.recipient_account	Dados do emitente da transação.
itens.data.sender_account	Dados do destinatário da transação.

","urlObject":{"path":["partner-bff","s2s","bank-statements"],"host":["{{url_contbank}}"],"query":[{"description":{"content":"

Pagina atual. Campo obrigatório.

\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"

Registros por página. Campo obrigatório.

\n","type":"text/plain"},"key":"per_page","value":"15"},{"description":{"content":"

Número da agencia. Campo obrigatório.

\n","type":"text/plain"},"key":"branch","value":"{{branch_number}}"},{"description":{"content":"

Número da conta. Campo obrigatório. Não é o Account ID.

\n","type":"text/plain"},"key":"account","value":"{{account_number}}"},{"description":{"content":"

Periodo inicial da consulta. O período máximo deve ser de 90 (noventa) dias.

\n","type":"text/plain"},"key":"begin_date_time","value":"2024-05-01T00:00:00.0000000Z"},{"description":{"content":"

Periodo final da consulta. O período máximo deve ser de 90 (noventa) dias.

\n","type":"text/plain"},"key":"end_date_time","value":"2024-05-31T00:00:00.0000000Z"}],"variable":[]}},"response":[{"id":"0358f971-ebd7-4f60-83f2-740cbd32d5ef","name":"200 - Banks statements list.","originalRequest":{"method":"GET","header":[{"key":"X-Current-Identity","value":"12345678901","type":"text","description":"CPF/CNPJ do cliente que terá o extrato consultado."}],"url":{"raw":"{{url_contbank}}/partner-bff/s2s/bank-statements?page=1&per_page=10&branch=0001&account=123456&begin_date_time=2024-05-01T00:00:00.0000000Z&end_date_time=2024-05-31T00:00:00.0000000Z","host":["{{url_contbank}}"],"path":["partner-bff","s2s","bank-statements"],"query":[{"key":"page","value":"1","description":"Posição da página / Obrigatório"},{"key":"per_page","value":"10","description":"Qtd de registros por página / Obrigatório"},{"key":"branch","value":"0001","description":"Número da agência / Obrigatório"},{"key":"account","value":"123456"},{"key":"begin_date_time","value":"2024-05-01T00:00:00.0000000Z","description":"Data inicial da consulta / Obrigatório"},{"key":"end_date_time","value":"2024-05-31T00:00:00.0000000Z","description":"Data final da consulta / Obrigatório"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"page\": 1,\n \"per_page\": 10,\n \"has_next_page\": true,\n \"statements\": [\n {\n \"date\": \"2024-05-09\",\n \"value\": 11.91,\n \"itens\": [\n {\n \"aggregate_id\": \"TRANSACTION_ID_116277cd-3b7c-4603-8816-aa2a0a796ec8\",\n \"type\": \"TRANSACTION\",\n \"category\": \"EletronicTransfers\",\n \"document_number\": \"12345678901\",\n \"bank_branch\": \"0001\",\n \"bank_account\": \"11692537\",\n \"amount\": 0.07,\n \"name\": \"CASH_IN_ACCOUNT\",\n \"timestamp\": \"2024-05-09T18:23:26Z\",\n \"label\": \"TED Recebido\",\n \"data\": {\n \"address_key\": null,\n \"amount_details\": null,\n \"authentication_code_external\": null,\n \"channel\": \"INTERNAL\",\n \"clearing_amount\": 0.07,\n \"company_key\": \"CONTBANK\",\n \"conciliation_description\": \"TED Recebido NOME DO REMETENTE ******77020 Agência:0001 Conta:441183506\",\n \"conciliation_id\": null,\n \"control_number\": null,\n \"correlation_id\": \"67064285-313c-4118-a897-3e93cc9a3795\",\n \"deposit_transaction_id\": \"116277cd-3b7c-4603-8816-aa2a0a796ec8\",\n \"description\": \"TESTE\",\n \"document\": \"12345678901\",\n \"end_to_end_id\": null,\n \"event_date_time\": \"2024-05-10T00:23:26+00:00\",\n \"is_pix_deposit\": false,\n \"is_tax_deposit\": false,\n \"is_tax_refund_deposit\": false,\n \"over_limit_amount\": 0,\n \"pix_transaction_id\": \"00000000-0000-0000-0000-000000000000\",\n \"recipient_account\": {\n \"account\": \"11692537\",\n \"agency\": \"0001\",\n \"document\": \"12345678901\",\n \"ispb_number\": \"13140088\",\n \"name\": \"NOME DO REMETENTE\"\n },\n \"sender_account\": {\n \"account\": \"441183506\",\n \"agency\": \"0001\",\n \"document\": \"80278477020\",\n \"ispb_number\": \"13140088\",\n \"name\": \"NOME DO DESTINATÁRIO\"\n },\n \"transaction_amount\": 0.07,\n \"withdrawal_agent_type\": null,\n \"withdrawal_provider_ispb\": null\n },\n \"status\": \"\",\n \"year\": 0,\n \"month\": 0,\n \"initial_balance\": 11.84,\n \"final_balance\": 11.91\n },\n {\n \"aggregate_id\": \"TRANSACTION_ID_63f8b15a-5099-4ef2-bd6b-2cd5e09b06c0\",\n \"type\": \"TRANSACTION\",\n \"category\": \"EletronicTransfers\",\n \"document_number\": \"12345678901\",\n \"bank_branch\": \"0001\",\n \"bank_account\": \"11692537\",\n \"amount\": -0.05,\n \"name\": \"CASH_OUT_ACCOUNT\",\n \"timestamp\": \"2024-05-09T18:08:28.006Z\",\n \"label\": \"TED Enviado\",\n \"data\": {\n \"conciliation_description\": \"TED Enviado NOME DO DESTINATÁRIO ******77020 Acesso Soluções De Pagamento S.A. - Instituição De Pagamento Agência:0001 Conta:441183506\",\n \"transaction_receipt\": {\n \"amount\": -0.05,\n \"authentication_code\": \"63f8b15a-5099-4ef2-bd6b-2cd5e09b06c0\",\n \"control_number\": null,\n \"description\": \"TESTE TED\",\n \"destination_account\": \"441183506\",\n \"destination_agency\": \"0001\",\n \"destination_bank_name\": \"Acesso Soluções De Pagamento S.A. - Instituição De Pagamento\",\n \"destination_compe\": \"332\",\n \"destination_document\": \"80278477020\",\n \"destination_name\": \"NOME DO DESTINATÁRIO\",\n \"transaction_date\": \"2024-05-10T00:08:28.0062021Z\"\n }\n },\n \"status\": \"\",\n \"year\": 0,\n \"month\": 0,\n \"initial_balance\": 11.89,\n \"final_balance\": 11.84\n },\n {\n \"aggregate_id\": \"TRANSACTION_ID_9fd275c5-66ce-4c3a-8412-37c358340a03\",\n \"type\": \"TRANSACTION\",\n \"category\": \"EletronicTransfers\",\n \"document_number\": \"12345678901\",\n \"bank_branch\": \"0001\",\n \"bank_account\": \"11692537\",\n \"amount\": -0.02,\n \"name\": \"CASH_OUT_ACCOUNT\",\n \"timestamp\": \"2024-05-09T17:53:17.021Z\",\n \"label\": \"TED Enviado\",\n \"data\": {\n \"conciliation_description\": \"TED Enviado NOME DO DESTINATÁRIO ******77020 Acesso Soluções De Pagamento S.A. - Instituição De Pagamento Agência:0001 Conta:441183506\",\n \"transaction_receipt\": {\n \"amount\": -0.02,\n \"authentication_code\": \"9fd275c5-66ce-4c3a-8412-37c358340a03\",\n \"control_number\": null,\n \"description\": \"TESTE TED CASH IN\",\n \"destination_account\": \"441183506\",\n \"destination_agency\": \"0001\",\n \"destination_bank_name\": \"Acesso Soluções De Pagamento S.A. - Instituição De Pagamento\",\n \"destination_compe\": \"332\",\n \"destination_document\": \"80278477020\",\n \"destination_name\": \"NOME DO DESTINATÁRIO\",\n \"transaction_date\": \"2024-05-09T23:53:17.0213831Z\"\n }\n },\n \"status\": \"\",\n \"year\": 0,\n \"month\": 0,\n \"initial_balance\": 11.91,\n \"final_balance\": 11.89\n },\n {\n \"aggregate_id\": \"PIX_TRANSACTION_ID_9055f30a-f57b-464c-a877-1a11840eec71\",\n \"type\": \"TRANSACTION\",\n \"category\": \"EletronicTransfers\",\n \"document_number\": \"12345678901\",\n \"bank_branch\": \"0001\",\n \"bank_account\": \"11692537\",\n \"amount\": 0.01,\n \"name\": \"PIX_CASH_IN_ACCOUNT\",\n \"timestamp\": \"2024-05-09T17:49:05Z\",\n \"label\": \"Pix Recebido\",\n \"data\": {\n \"address_key\": null,\n \"amount_details\": null,\n \"authentication_code_external\": null,\n \"channel\": \"INTERNAL_SPI\",\n \"clearing_amount\": 0.01,\n \"company_key\": \"CONTBANK\",\n \"conciliation_description\": \"Pix Recebido NOME DO REMETENTE ******77020 Agência:0001 Conta:441183506\",\n \"conciliation_id\": null,\n \"control_number\": null,\n \"correlation_id\": \"967ce40d-940c-4f92-afd7-589d2f6e1177\",\n \"deposit_transaction_id\": \"9055f30a-f57b-464c-a877-1a11840eec71\",\n \"description\": \"Teste pix cash out\",\n \"document\": \"12345678901\",\n \"end_to_end_id\": \"E1314008820240509234986c4620058d\",\n \"event_date_time\": \"2024-05-09T23:49:05+00:00\",\n \"is_pix_deposit\": true,\n \"is_tax_deposit\": false,\n \"is_tax_refund_deposit\": false,\n \"over_limit_amount\": 0,\n \"pix_transaction_id\": \"00000000-0000-0000-0000-000000000000\",\n \"recipient_account\": {\n \"account\": \"11692537\",\n \"agency\": \"0001\",\n \"document\": \"12345678901\",\n \"ispb_number\": \"13140088\",\n \"name\": \"NOME DO REMETENTE\"\n },\n \"sender_account\": {\n \"account\": \"441183506\",\n \"agency\": \"0001\",\n \"document\": \"80278477020\",\n \"ispb_number\": \"13140088\",\n \"name\": \"NOME DO DESTINARÁRIO\"\n },\n \"transaction_amount\": 0.01,\n \"withdrawal_agent_type\": null,\n \"withdrawal_provider_ispb\": null\n },\n \"status\": \"\",\n \"year\": 0,\n \"month\": 0,\n \"initial_balance\": 11.9,\n \"final_balance\": 11.91\n },\n {\n \"aggregate_id\": \"PAYBILL_02c79680-6475-4fbc-847c-11703f9d166b\",\n \"type\": \"TRANSACTION\",\n \"category\": \"AccountPayment\",\n \"document_number\": \"12345678901\",\n \"bank_branch\": \"0001\",\n \"bank_account\": \"11692537\",\n \"amount\": -5,\n \"name\": \"PAYBILL\",\n \"timestamp\": \"2024-05-09T17:45:03.613Z\",\n \"label\": \"Pagamento efetuado\",\n \"data\": {\n \"amount\": 5,\n \"assignor\": \"BANCO VOTORANTIM S.A.\",\n \"authentication_code\": \"02c79680-6475-4fbc-847c-11703f9d166b\",\n \"bank_account\": \"11692537\",\n \"bank_branch\": \"0001\",\n \"bank_code\": \"332\",\n \"bank_ispb\": \"13140088\",\n \"bank_name\": \"Acesso Soluções de Pagamento S.A.\",\n \"charges\": {\n \"discount_amount\": 0,\n \"fine_amount_calculated\": 0,\n \"interest_amount_calculated\": 0\n },\n \"company_key\": \"CONTBANK\",\n \"conciliation_description\": \"Pagamento efetuado BANCO VOTORANTIM S.A.\",\n \"confirmation_transaction_id\": 2426270401,\n \"confirmed_at\": null,\n \"correlation_id\": \"a309809e-a8b8-49ce-bd6e-408521bf5bc2\",\n \"created_at\": \"2024-05-09T23:45:03.6132623Z\",\n \"description\": \"TESTE PAGAMENTO\",\n \"digitable\": \"65590000020806150000800381893007397170000000500\",\n \"document_number\": \"12345678901\",\n \"due_date\": \"2024-05-15T00:00:00Z\",\n \"has_uncommitted_events\": true,\n \"id\": \"02c79680-6475-4fbc-847c-11703f9d166b\",\n \"original_amount\": 5,\n \"payment_date\": \"2024-05-09T23:45:03.6132735Z\",\n \"payment_status\": \"Created\",\n \"payment_type\": \"Bill\",\n \"reason_refused\": null,\n \"recipient_document\": \"13.140.088/0001-99\",\n \"recipient_name\": \"ACESSO SOLUCOES DE PAGAMENTO SA INSTITUICAO DE PAG\",\n \"requested_at\": \"2024-05-09T23:45:03.6132621Z\",\n \"settle_date\": \"2024-05-09T00:00:00Z\",\n \"transaction_id\": 2426267970,\n \"type\": \"Compensation\",\n \"updated_at\": \"2024-05-09T23:45:05.3560631Z\",\n \"version\": 2\n },\n \"status\": \"\",\n \"year\": 0,\n \"month\": 0,\n \"initial_balance\": 16.9,\n \"final_balance\": 11.9\n },\n {\n \"aggregate_id\": \"TRANSACTION_ID_ac066171-b16c-4717-889f-78958a277d82\",\n \"type\": \"TRANSACTION\",\n \"category\": \"EletronicTransfers\",\n \"document_number\": \"12345678901\",\n \"bank_branch\": \"0001\",\n \"bank_account\": \"11692537\",\n \"amount\": 13,\n \"name\": \"CASH_IN_ACCOUNT\",\n \"timestamp\": \"2024-05-09T17:42:46Z\",\n \"label\": \"TED Recebido\",\n \"data\": {\n \"address_key\": null,\n \"amount_details\": null,\n \"authentication_code_external\": null,\n \"channel\": \"INTERNAL\",\n \"clearing_amount\": 13,\n \"company_key\": \"CONTBANK\",\n \"conciliation_description\": \"TED Recebido NOME DO REMETENTE 12345678901234 Agência:0001 Conta:11846518\",\n \"conciliation_id\": null,\n \"control_number\": null,\n \"correlation_id\": \"ab329a4d-04fe-4531-a59a-e3fa71ec2eb3\",\n \"deposit_transaction_id\": \"ac066171-b16c-4717-889f-78958a277d82\",\n \"description\": \"TESTE TED\",\n \"document\": \"12345678901\",\n \"end_to_end_id\": null,\n \"event_date_time\": \"2024-05-09T23:42:46+00:00\",\n \"is_pix_deposit\": false,\n \"is_tax_deposit\": false,\n \"is_tax_refund_deposit\": false,\n \"over_limit_amount\": 0,\n \"pix_transaction_id\": \"00000000-0000-0000-0000-000000000000\",\n \"recipient_account\": {\n \"account\": \"11692537\",\n \"agency\": \"0001\",\n \"document\": \"12345678901\",\n \"ispb_number\": \"13140088\",\n \"name\": \"NOME DO REMETENTE\"\n },\n \"sender_account\": {\n \"account\": \"11846518\",\n \"agency\": \"0001\",\n \"document\": \"31648759000109\",\n \"ispb_number\": \"13140088\",\n \"name\": \"NOME DO DESTINATÁRIO\"\n },\n \"transaction_amount\": 13,\n \"withdrawal_agent_type\": null,\n \"withdrawal_provider_ispb\": null\n },\n \"status\": \"\",\n \"year\": 0,\n \"month\": 0,\n \"initial_balance\": 3.9,\n \"final_balance\": 16.9\n },\n {\n \"aggregate_id\": \"PIX_TRANSACTION_ID_35fd18fc-f6db-489d-82d6-d6f9e9127e29\",\n \"type\": \"TRANSACTION\",\n \"category\": \"EletronicTransfers\",\n \"document_number\": \"12345678901\",\n \"bank_branch\": \"0001\",\n \"bank_account\": \"11692537\",\n \"amount\": -0.09,\n \"name\": \"PIX_CASH_OUT_ACCOUNT\",\n \"timestamp\": \"2024-05-09T17:41:55.552Z\",\n \"label\": \"Pix Enviado\",\n \"data\": {\n \"address_key\": null,\n \"address_key_type\": \"\",\n \"amount\": -0.09,\n \"amount_details\": null,\n \"authentication_code\": \"35fd18fc-f6db-489d-82d6-d6f9e9127e29\",\n \"channel\": \"INTERNAL\",\n \"conciliation_description\": \"Pix Enviado NOME DO REMETENTE ******77020 Acesso Soluções De Pagamento S.A. - Instituição De Pagamento Agência:0001 Conta:441183506\",\n \"description\": \"Extrato teste\",\n \"end_to_end_id\": \"E131400882024050923417859c038a55\",\n \"initialization_type\": \"Manual\",\n \"recipient\": {\n \"bank_account\": \"441183506\",\n \"bank_account_type\": \"CHECKING\",\n \"bank_branch\": \"0001\",\n \"bank_compe\": \"332\",\n \"bank_ispb\": \"13140088\",\n \"bank_name\": \"Acesso Soluções De Pagamento S.A. - Instituição De Pagamento\",\n \"document\": \"80278477020\",\n \"document_type\": \"CPF\",\n \"name\": \"NOME DO REMETENTE\"\n },\n \"scheduled_payment_date\": null,\n \"transaction_date\": \"2024-05-09T23:41:58.3539557Z\",\n \"withdrawal_agent_type\": null,\n \"withdrawal_provider_ispb\": null\n },\n \"status\": \"\",\n \"year\": 0,\n \"month\": 0,\n \"initial_balance\": 3.99,\n \"final_balance\": 3.9\n },\n {\n \"aggregate_id\": \"PIX_TRANSACTION_ID_4263932a-5963-4496-bbf1-12e030d53088\",\n \"type\": \"TRANSACTION\",\n \"category\": \"EletronicTransfers\",\n \"document_number\": \"12345678901\",\n \"bank_branch\": \"0001\",\n \"bank_account\": \"11692537\",\n \"amount\": -0.01,\n \"name\": \"PIX_CASH_OUT_ACCOUNT\",\n \"timestamp\": \"2024-05-09T17:40:51.117Z\",\n \"label\": \"Pix Enviado\",\n \"data\": {\n \"address_key\": null,\n \"address_key_type\": \"\",\n \"amount\": -0.01,\n \"amount_details\": null,\n \"authentication_code\": \"4263932a-5963-4496-bbf1-12e030d53088\",\n \"channel\": \"INTERNAL\",\n \"conciliation_description\": \"Pix Enviado JULIO MARANGONI ******01865 Acesso Soluções De Pagamento S.A. - Instituição De Pagamento Agência:0001 Conta:11738235\",\n \"description\": \"Teste extrato\",\n \"end_to_end_id\": \"E1314008820240509234053aa096e2c1\",\n \"initialization_type\": \"Manual\",\n \"recipient\": {\n \"bank_account\": \"11738235\",\n \"bank_account_type\": \"CHECKING\",\n \"bank_branch\": \"0001\",\n \"bank_compe\": \"332\",\n \"bank_ispb\": \"13140088\",\n \"bank_name\": \"Acesso Soluções De Pagamento S.A. - Instituição De Pagamento\",\n \"document\": \"37786401865\",\n \"document_type\": \"CPF\",\n \"name\": \"JULIO MARANGONI\"\n },\n \"scheduled_payment_date\": null,\n \"transaction_date\": \"2024-05-09T23:40:52.2159001Z\",\n \"withdrawal_agent_type\": null,\n \"withdrawal_provider_ispb\": null\n },\n \"status\": \"\",\n \"year\": 0,\n \"month\": 0,\n \"initial_balance\": 4,\n \"final_balance\": 3.99\n },\n {\n \"aggregate_id\": \"TRANSACTION_ID_4ab44ad8-4ee9-4541-9a05-08202c6f416d\",\n \"type\": \"TRANSACTION\",\n \"category\": \"EletronicTransfers\",\n \"document_number\": \"12345678901\",\n \"bank_branch\": \"0001\",\n \"bank_account\": \"11692537\",\n \"amount\": -0.21,\n \"name\": \"CASH_OUT_ACCOUNT\",\n \"timestamp\": \"2024-05-09T17:40:15.782Z\",\n \"label\": \"TED Enviado\",\n \"data\": {\n \"conciliation_description\": \"TED Enviado NOME DO DESTINATÁRIO ******77020 Acesso Soluções De Pagamento S.A. - Instituição De Pagamento Agência:0001 Conta:441183506\",\n \"transaction_receipt\": {\n \"amount\": -0.21,\n \"authentication_code\": \"4ab44ad8-4ee9-4541-9a05-08202c6f416d\",\n \"control_number\": null,\n \"description\": \"TESTE EXTRATO\",\n \"destination_account\": \"441183506\",\n \"destination_agency\": \"0001\",\n \"destination_bank_name\": \"Acesso Soluções De Pagamento S.A. - Instituição De Pagamento\",\n \"destination_compe\": \"332\",\n \"destination_document\": \"80278477020\",\n \"destination_name\": \"NOME DO DESTINATÁRIO\",\n \"transaction_date\": \"2024-05-09T23:40:15.7823715Z\"\n }\n },\n \"status\": \"\",\n \"year\": 0,\n \"month\": 0,\n \"initial_balance\": 4.21,\n \"final_balance\": 4\n },\n {\n \"aggregate_id\": \"PIX_TRANSACTION_ID_7ac7b764-c378-44aa-b28f-93a6a3fec9df\",\n \"type\": \"TRANSACTION\",\n \"category\": \"EletronicTransfers\",\n \"document_number\": \"12345678901\",\n \"bank_branch\": \"0001\",\n \"bank_account\": \"11692537\",\n \"amount\": 1.5,\n \"name\": \"PIX_CASH_IN_ACCOUNT\",\n \"timestamp\": \"2024-05-09T17:39:42.792Z\",\n \"label\": \"Pix Recebido\",\n \"data\": {\n \"address_key\": \"1cf646e1-ec69-4624-906e-44593d032fe5\",\n \"amount_details\": null,\n \"authentication_code_external\": null,\n \"channel\": \"SPI\",\n \"clearing_amount\": 1.5,\n \"company_key\": \"CONTBANK\",\n \"conciliation_description\": \"Pix Recebido NOME DO REMETENTE ******78901 Agência:0001 Conta:80866239\",\n \"conciliation_id\": null,\n \"control_number\": null,\n \"correlation_id\": \"bd6c3912-7003-4b86-aec2-b02b16a66c89\",\n \"deposit_transaction_id\": \"7ac7b764-c378-44aa-b28f-93a6a3fec9df\",\n \"description\": null,\n \"document\": \"12345678901\",\n \"end_to_end_id\": \"E18236120202405092339s01650e210b\",\n \"event_date_time\": \"2024-05-09T23:39:42.7925092Z\",\n \"is_pix_deposit\": true,\n \"is_tax_deposit\": false,\n \"is_tax_refund_deposit\": false,\n \"over_limit_amount\": 0,\n \"pix_transaction_id\": \"bd6c3912-7003-4b86-aec2-b02b16a66c89\",\n \"recipient_account\": {\n \"account\": \"11692537\",\n \"agency\": \"0001\",\n \"document\": \"12345678901\",\n \"ispb_number\": \"13140088\",\n \"name\": null\n },\n \"sender_account\": {\n \"account\": \"80866239\",\n \"agency\": \"0001\",\n \"document\": \"12345678901\",\n \"ispb_number\": \"18236120\",\n \"name\": \"NOME DO DESTINATÁRIO\"\n },\n \"transaction_amount\": 1.5,\n \"withdrawal_agent_type\": null,\n \"withdrawal_provider_ispb\": null\n },\n \"status\": \"\",\n \"year\": 0,\n \"month\": 0,\n \"initial_balance\": 2.71,\n \"final_balance\": 4.21\n }\n ]\n }\n ]\n}"}],"_postman_id":"44023331-547b-4ce1-8f57-06b385597e9a"},{"name":"[DEPRECATED] Get Bank Statement (v1)","id":"4bf317ea-42e3-4068-9021-3d2866df7a1b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{partner_token}}"},"isInherited":false},"method":"GET","header":[{"key":"X-Current-Identity","value":"12345678901","description":"

CPF/CNPJ do usuário

\n","type":"text"}],"url":"{{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","description":"

[Esta rota não é mais válida (DEPRECATED)]

Obter dados do extrato bancário de um cliente, com possibilidade de paginação e filtro de data.

\n","urlObject":{"path":["bank-statements"],"host":["{{url_contbank}}"],"query":[{"description":{"content":"

Pagina atual. Campo obrigatório.

\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"

Registros por página. Campo obrigatório.

\n","type":"text/plain"},"key":"per_page","value":"5"},{"description":{"content":"

Número da agencia. Campo obrigatório.

\n","type":"text/plain"},"key":"branch","value":"{{branch_number}}"},{"description":{"content":"

Número da conta. Campo obrigatório. Não é o Account ID.

\n","type":"text/plain"},"key":"account","value":"{{account_number}}"},{"description":{"content":"

Periodo inicial da consulta. O período máximo deve ser de 90 (noventa) dias.

\n","type":"text/plain"},"key":"begin_date_time","value":"2022-09-01T04:11:53.6050541Z"},{"description":{"content":"

Periodo final da consulta. O período máximo deve ser de 90 (noventa) dias.

\n","type":"text/plain"},"key":"end_date_time","value":"2022-10-31T04:11:53.6050541Z"}],"variable":[]}},"response":[{"id":"d9e6ad2b-a14d-4ac5-ac11-af4f5dd69c93","name":"200 - Banks statements list.","originalRequest":{"method":"GET","header":[{"key":"X-Current-Identity","value":"05621174000195","type":"text","description":"CNPJ do cliente que será efetuado a consulta do extrato bancário."}],"url":{"raw":"{{url_contbank}}/bank-statements?page=1&per_page=5&branch=0001&account=999999999&begin_date_time=2022-09-01T04:11:53.6050541Z&end_date_time=2022-10-31T04:11:53.6050541Z","host":["{{url_contbank}}"],"path":["bank-statements"],"query":[{"key":"page","value":"1","description":"Posição da página / Obrigatório"},{"key":"per_page","value":"5","description":"Qtd de registros por página / Obrigatório"},{"key":"branch","value":"0001","description":"Número da agência / Obrigatório"},{"key":"account","value":"999999999","description":"Número da conta / Obrigatório"},{"key":"begin_date_time","value":"2022-09-01T04:11:53.6050541Z","description":"Data inicial da consulta / Obrigatório"},{"key":"end_date_time","value":"2022-10-31T04:11:53.6050541Z","description":"Data final da consulta / Obrigatório"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"page\": 1,\n \"per_page\": 10,\n \"has_next_page\": true,\n \"statements\": [\n {\n \"aggregate_id\": \"PAYBILL_56a35e14-fb4c-4414-95f3-74c0ac4292bb\",\n \"type\": \"TRANSACTION\",\n \"category\": \"AccountPayment\",\n \"document_number\": \"99999999999\",\n \"bank_branch\": \"0001\",\n \"bank_account\": \"184999\",\n \"amount\": -235.51,\n \"name\": \"PAYBILL\",\n \"timestamp\": \"2021-11-29T21:38:28.6134558Z\",\n \"label\": \"Pagamento efetuado\",\n \"data\": {\n \"id\": \"56a35e14-fb4c-4414-95f3-74c0ac4292bb\",\n \"correlation_id\": \"c4539c12-50a5-11ec-bf63-0242ac130002\",\n \"digitable\": \"836200000021355100403185234319172032100181841691\",\n \"amount\": 235.51,\n \"original_amount\": 235.51,\n \"assignor\": \"Generica CC\",\n \"recipient_document\": null,\n \"recipient_name\": null,\n \"charges\": {\n \"interest_amount_calculated\": 0,\n \"fine_amount_calculated\": 0,\n \"discount_amount\": 0\n },\n \"settle_date\": \"2021-11-29T00:00:00Z\",\n \"payment_date\": \"2021-11-29T21:38:28.6134632Z\",\n \"type\": \"Concessionaire\",\n \"due_date\": \"2021-11-29T00:00:00Z\",\n \"transaction_id\": 8421157,\n \"confirmation_transaction_id\": 8421160,\n \"description\": \"PGTO\",\n \"authentication_code\": \"56a35e14-fb4c-4414-95f3-74c0ac4292bb\",\n \"payment_status\": \"Created\",\n \"payment_type\": \"Bill\",\n \"company_key\": \"SDB_CONTBANK\",\n \"document_number\": \"99999999999\",\n \"bank_account\": \"184999\",\n \"bank_branch\": \"0001\",\n \"confirmed_at\": \"0001-01-01T00:00:00Z\",\n \"created_at\": \"2021-11-29T21:38:28.6134558Z\",\n \"updated_at\": \"2021-11-29T21:38:30.3879947Z\",\n \"version\": 2,\n \"has_uncommitted_events\": true\n },\n \"status\": \"ACTIVE\"\n },\n {\n \"aggregate_id\": \"PAYBILL_f2f557aa-2d17-4333-adf4-eed67bd01fe8\",\n \"type\": \"TRANSACTION\",\n \"category\": \"AccountPayment\",\n \"document_number\": \"99999999999\",\n \"bank_branch\": \"0001\",\n \"bank_account\": \"184999\",\n \"amount\": -128.68,\n \"name\": \"PAYBILL\",\n \"timestamp\": \"2021-11-29T21:35:30.4625305Z\",\n \"label\": \"Pagamento efetuado\",\n \"data\": {\n \"id\": \"f2f557aa-2d17-4333-adf4-eed67bd01fe8\",\n \"correlation_id\": \"c4539c12-50a5-11ec-bf63-0242ac130002\",\n \"digitable\": \"846800000016286800820891999104482503611747048993\",\n \"amount\": 128.68,\n \"original_amount\": 128.68,\n \"assignor\": \"Conta - Segmento Telefone\",\n \"recipient_document\": null,\n \"recipient_name\": null,\n \"charges\": {\n \"interest_amount_calculated\": 0,\n \"fine_amount_calculated\": 0,\n \"discount_amount\": 0\n },\n \"settle_date\": \"2021-11-29T00:00:00Z\",\n \"payment_date\": \"2021-11-29T21:35:30.4625966Z\",\n \"type\": \"Concessionaire\",\n \"due_date\": \"2021-11-29T00:00:00Z\",\n \"transaction_id\": 8421152,\n \"confirmation_transaction_id\": 8421154,\n \"description\": \"PGTO\",\n \"authentication_code\": \"f2f557aa-2d17-4333-adf4-eed67bd01fe8\",\n \"payment_status\": \"Created\",\n \"payment_type\": \"Bill\",\n \"company_key\": \"SDB_CONTBANK\",\n \"document_number\": \"99999999999\",\n \"bank_account\": \"184999\",\n \"bank_branch\": \"0001\",\n \"confirmed_at\": \"0001-01-01T00:00:00Z\",\n \"created_at\": \"2021-11-29T21:35:30.4625305Z\",\n \"updated_at\": \"2021-11-29T21:35:32.5523658Z\",\n \"version\": 2,\n \"has_uncommitted_events\": true\n },\n \"status\": \"ACTIVE\"\n },\n {\n \"aggregate_id\": \"PAYBILL_1ec300f1-73c9-46eb-8a16-61fb10dbaf58\",\n \"type\": \"TRANSACTION\",\n \"category\": \"AccountPayment\",\n \"document_number\": \"99999999999\",\n \"bank_branch\": \"0001\",\n \"bank_account\": \"184999\",\n \"amount\": -119.9,\n \"name\": \"PAYBILL\",\n \"timestamp\": \"2021-11-25T14:55:12.1802731Z\",\n \"label\": \"Pagamento efetuado\",\n \"data\": {\n \"id\": \"1ec300f1-73c9-46eb-8a16-61fb10dbaf58\",\n \"correlation_id\": \"7b122854-389f-46b4-8766-28941a3b3371\",\n \"digitable\": \"846700000017199000820894999104482503545020855999\",\n \"amount\": 119.9,\n \"original_amount\": 119.9,\n \"assignor\": \"Conta - Segmento Telefone\",\n \"recipient_document\": null,\n \"recipient_name\": null,\n \"charges\": {\n \"interest_amount_calculated\": 0,\n \"fine_amount_calculated\": 0,\n \"discount_amount\": 0\n },\n \"settle_date\": \"2021-11-25T00:00:00Z\",\n \"payment_date\": \"2021-11-25T14:55:12.1802795Z\",\n \"type\": \"Concessionaire\",\n \"due_date\": \"2021-11-25T00:00:00Z\",\n \"transaction_id\": 8399566,\n \"confirmation_transaction_id\": 8399569,\n \"description\": \"\",\n \"authentication_code\": \"1ec300f1-73c9-46eb-8a16-61fb10dbaf58\",\n \"payment_status\": \"Created\",\n \"payment_type\": \"Bill\",\n \"company_key\": \"SDB_CONTBANK\",\n \"document_number\": \"99999999999\",\n \"bank_account\": \"184999\",\n \"bank_branch\": \"0001\",\n \"confirmed_at\": \"0001-01-01T00:00:00Z\",\n \"created_at\": \"2021-11-25T14:55:12.1802731Z\",\n \"updated_at\": \"2021-11-25T14:55:13.5260162Z\",\n \"version\": 2,\n \"has_uncommitted_events\": true\n },\n \"status\": \"ACTIVE\"\n },\n {\n \"aggregate_id\": \"PAYBILL_f47083b7-5c1f-480a-b5f0-b430a041969b\",\n \"type\": \"TRANSACTION\",\n \"category\": \"AccountPayment\",\n \"document_number\": \"99999999999\",\n \"bank_branch\": \"0001\",\n \"bank_account\": \"184999\",\n \"amount\": -147.78,\n \"name\": \"PAYBILL\",\n \"timestamp\": \"2021-11-25T13:49:02.056587Z\",\n \"label\": \"Pagamento efetuado\",\n \"data\": {\n \"id\": \"f47083b7-5c1f-480a-b5f0-b430a041969b\",\n \"correlation_id\": \"cf8d56e8-3d2a-4cca-845e-81945a9e0636\",\n \"digitable\": \"846800000016477800820896997400414600611560309993\",\n \"amount\": 147.78,\n \"original_amount\": 147.78,\n \"assignor\": \"Conta - Segmento Telefone\",\n \"recipient_document\": null,\n \"recipient_name\": null,\n \"charges\": {\n \"interest_amount_calculated\": 0,\n \"fine_amount_calculated\": 0,\n \"discount_amount\": 0\n },\n \"settle_date\": \"2021-11-25T00:00:00Z\",\n \"payment_date\": \"2021-11-25T13:49:02.056597Z\",\n \"type\": \"Concessionaire\",\n \"due_date\": \"2021-11-25T00:00:00Z\",\n \"transaction_id\": 8398658,\n \"confirmation_transaction_id\": 8398660,\n \"description\": \"\",\n \"authentication_code\": \"f47083b7-5c1f-480a-b5f0-b430a041969b\",\n \"payment_status\": \"Created\",\n \"payment_type\": \"Bill\",\n \"company_key\": \"SDB_CONTBANK\",\n \"document_number\": \"99999999999\",\n \"bank_account\": \"184999\",\n \"bank_branch\": \"0001\",\n \"confirmed_at\": \"0001-01-01T00:00:00Z\",\n \"created_at\": \"2021-11-25T13:49:02.056587Z\",\n \"updated_at\": \"2021-11-25T13:49:03.6869086Z\",\n \"version\": 2,\n \"has_uncommitted_events\": true\n },\n \"status\": \"ACTIVE\"\n },\n {\n \"aggregate_id\": \"PAYBILL_887d83e1-c604-42b2-bea7-60f2f9362266\",\n \"type\": \"TRANSACTION\",\n \"category\": \"AccountPayment\",\n \"document_number\": \"99999999999\",\n \"bank_branch\": \"0001\",\n \"bank_account\": \"184999\",\n \"amount\": -128.68,\n \"name\": \"PAYBILL\",\n \"timestamp\": \"2021-11-25T13:37:07.2758507Z\",\n \"label\": \"Pagamento efetuado\",\n \"data\": {\n \"id\": \"887d83e1-c604-42b2-bea7-60f2f9362266\",\n \"correlation_id\": \"4dd44f04-995e-432a-94ab-9448353b7386\",\n \"digitable\": \"846800000016286800820891999104482503611747048993\",\n \"amount\": 128.68,\n \"original_amount\": 128.68,\n \"assignor\": \"Conta - Segmento Telefone\",\n \"recipient_document\": null,\n \"recipient_name\": null,\n \"charges\": {\n \"interest_amount_calculated\": 0,\n \"fine_amount_calculated\": 0,\n \"discount_amount\": 0\n },\n \"settle_date\": \"2021-11-25T00:00:00Z\",\n \"payment_date\": \"2021-11-25T13:37:07.2758605Z\",\n \"type\": \"Concessionaire\",\n \"due_date\": \"2021-11-25T00:00:00Z\",\n \"transaction_id\": 8398480,\n \"confirmation_transaction_id\": 8398523,\n \"description\": \"\",\n \"authentication_code\": \"887d83e1-c604-42b2-bea7-60f2f9362266\",\n \"payment_status\": \"Created\",\n \"payment_type\": \"Bill\",\n \"company_key\": \"SDB_CONTBANK\",\n \"document_number\": \"99999999999\",\n \"bank_account\": \"184999\",\n \"bank_branch\": \"0001\",\n \"confirmed_at\": \"0001-01-01T00:00:00Z\",\n \"created_at\": \"2021-11-25T13:37:07.2758507Z\",\n \"updated_at\": \"2021-11-25T13:37:09.3330712Z\",\n \"version\": 2,\n \"has_uncommitted_events\": true\n },\n \"status\": \"ACTIVE\"\n },\n {\n \"aggregate_id\": \"TRANSACTION_ID_0d079d82-8635-4e5c-8e47-7b8922c3adc3\",\n \"type\": \"TRANSACTION\",\n \"category\": \"EletronicTransfers\",\n \"document_number\": \"99999999999\",\n \"bank_branch\": \"0001\",\n \"bank_account\": \"184999\",\n \"amount\": -12.22,\n \"name\": \"CASH_OUT_ACCOUNT\",\n \"timestamp\": \"2021-11-24T17:11:35.6619032Z\",\n \"label\": \"Transferência enviada\",\n \"data\": {\n \"transaction_receipt\": {\n \"authentication_code\": \"0d079d82-8635-4e5c-8e47-7b8922c3adc3\",\n \"transaction_date\": \"2021-11-24T17:11:35.6619032Z\",\n \"destination_name\": \"Bank Teste\",\n \"destination_agency\": \"0001\",\n \"destination_account\": \"198480\",\n \"destination_document\": \"99999999991\",\n \"destination_bank_name\": \"Acesso Soluções De Pagamento S.A.\",\n \"destination_compe\": \"332\",\n \"amount\": -12.22,\n \"description\": \"\"\n }\n },\n \"status\": \"ACTIVE\"\n },\n {\n \"aggregate_id\": \"PAYBILL_4ec8d55f-86fc-432e-8e32-63e33fcd2351\",\n \"type\": \"TRANSACTION\",\n \"category\": \"AccountPayment\",\n \"document_number\": \"99999999999\",\n \"bank_branch\": \"0001\",\n \"bank_account\": \"184999\",\n \"amount\": -235.51,\n \"name\": \"PAYBILL\",\n \"timestamp\": \"2021-11-24T17:08:26.3874884Z\",\n \"label\": \"Pagamento efetuado\",\n \"data\": {\n \"id\": \"4ec8d55f-86fc-432e-8e32-63e33fcd2351\",\n \"correlation_id\": \"6d903b3e-f058-4228-9837-f0cc4c5ff71e\",\n \"digitable\": \"836200000021355100403185234319172032100181841691\",\n \"amount\": 235.51,\n \"original_amount\": 235.51,\n \"assignor\": \"Generica CC\",\n \"recipient_document\": null,\n \"recipient_name\": null,\n \"charges\": {\n \"interest_amount_calculated\": 0,\n \"fine_amount_calculated\": 0,\n \"discount_amount\": 0\n },\n \"settle_date\": \"2021-11-24T00:00:00Z\",\n \"payment_date\": \"2021-11-24T17:08:26.3874955Z\",\n \"type\": \"Concessionaire\",\n \"due_date\": \"2021-11-24T00:00:00Z\",\n \"transaction_id\": 8390386,\n \"confirmation_transaction_id\": 8390389,\n \"description\": \"\",\n \"authentication_code\": \"4ec8d55f-86fc-432e-8e32-63e33fcd2351\",\n \"payment_status\": \"Created\",\n \"payment_type\": \"Bill\",\n \"company_key\": \"SDB_CONTBANK\",\n \"document_number\": \"99999999999\",\n \"bank_account\": \"184999\",\n \"bank_branch\": \"0001\",\n \"confirmed_at\": \"0001-01-01T00:00:00Z\",\n \"created_at\": \"2021-11-24T17:08:26.3874884Z\",\n \"updated_at\": \"2021-11-24T17:08:27.7778168Z\",\n \"version\": 2,\n \"has_uncommitted_events\": true\n },\n \"status\": \"ACTIVE\"\n },\n {\n \"aggregate_id\": \"PAYBILL_843a209a-b2c7-4473-af28-072c7d6c6a11\",\n \"type\": \"TRANSACTION\",\n \"category\": \"AccountPayment\",\n \"document_number\": \"99999999999\",\n \"bank_branch\": \"0001\",\n \"bank_account\": \"184999\",\n \"amount\": -211.94,\n \"name\": \"PAYBILL\",\n \"timestamp\": \"2021-11-24T17:02:20.9883482Z\",\n \"label\": \"Pagamento efetuado\",\n \"data\": {\n \"id\": \"843a209a-b2c7-4473-af28-072c7d6c6a11\",\n \"correlation_id\": \"5be279ee-c556-4159-a1f2-495bcdd6ebd6\",\n \"digitable\": \"03399103177839215812376100301043988050000020778\",\n \"amount\": 211.94,\n \"original_amount\": 207.78,\n \"assignor\": \"BANCO SANTANDER S.A\",\n \"recipient_document\": \"99.568.999/0001-00\",\n \"recipient_name\": \"BENEFICIARIO AMBIENTE HOMOLOGACAO\",\n \"charges\": {\n \"interest_amount_calculated\": 0,\n \"fine_amount_calculated\": 4.16,\n \"discount_amount\": 0\n },\n \"settle_date\": \"2021-11-24T00:00:00Z\",\n \"payment_date\": \"2021-11-24T17:02:20.9883598Z\",\n \"type\": \"Compensation\",\n \"due_date\": \"2021-11-15T00:00:00Z\",\n \"transaction_id\": 8390286,\n \"confirmation_transaction_id\": 8390299,\n \"description\": \"\",\n \"authentication_code\": \"843a209a-b2c7-4473-af28-072c7d6c6a11\",\n \"payment_status\": \"Created\",\n \"payment_type\": \"Bill\",\n \"company_key\": \"SDB_CONTBANK\",\n \"document_number\": \"99999999999\",\n \"bank_account\": \"184999\",\n \"bank_branch\": \"0001\",\n \"confirmed_at\": \"0001-01-01T00:00:00Z\",\n \"created_at\": \"2021-11-24T17:02:20.9883482Z\",\n \"updated_at\": \"2021-11-24T17:02:24.54635Z\",\n \"version\": 2,\n \"has_uncommitted_events\": true\n },\n \"status\": \"ACTIVE\"\n },\n {\n \"aggregate_id\": \"PAYBILL_439c4131-221b-4d55-999f-78b435fad850\",\n \"type\": \"TRANSACTION\",\n \"category\": \"AccountPayment\",\n \"document_number\": \"99999999999\",\n \"bank_branch\": \"0001\",\n \"bank_account\": \"184999\",\n \"amount\": -124.86,\n \"name\": \"PAYBILL\",\n \"timestamp\": \"2021-11-23T17:20:02.2114427Z\",\n \"label\": \"Pagamento efetuado\",\n \"data\": {\n \"id\": \"439c4131-221b-4d55-999f-78b435fad850\",\n \"correlation_id\": \"6edb69cd-3bf6-4c06-8e5e-84020b5ade59\",\n \"digitable\": \"846100000013248600820893997400414600775628906999\",\n \"amount\": 124.86,\n \"original_amount\": 124.86,\n \"assignor\": \"Conta - Segmento Telefone\",\n \"recipient_document\": null,\n \"recipient_name\": null,\n \"charges\": {\n \"interest_amount_calculated\": 0,\n \"fine_amount_calculated\": 0,\n \"discount_amount\": 0\n },\n \"settle_date\": \"2021-11-23T00:00:00Z\",\n \"payment_date\": \"2021-11-23T17:20:02.211468Z\",\n \"type\": \"Concessionaire\",\n \"due_date\": \"2021-11-23T00:00:00Z\",\n \"transaction_id\": 8379227,\n \"confirmation_transaction_id\": 8379229,\n \"description\": \"\",\n \"authentication_code\": \"439c4131-221b-4d55-999f-78b435fad850\",\n \"payment_status\": \"Created\",\n \"payment_type\": \"Bill\",\n \"company_key\": \"SDB_CONTBANK\",\n \"document_number\": \"99999999999\",\n \"bank_account\": \"184999\",\n \"bank_branch\": \"0001\",\n \"confirmed_at\": \"0001-01-01T00:00:00Z\",\n \"created_at\": \"2021-11-23T17:20:02.2114427Z\",\n \"updated_at\": \"2021-11-23T17:20:03.4826484Z\",\n \"version\": 2,\n \"has_uncommitted_events\": true\n },\n \"status\": \"ACTIVE\"\n },\n {\n \"aggregate_id\": \"PAYBILL_4646305e-8eda-460b-93a3-5d82ffdae56a\",\n \"type\": \"TRANSACTION\",\n \"category\": \"AccountPayment\",\n \"document_number\": \"99999999999\",\n \"bank_branch\": \"0001\",\n \"bank_account\": \"184999\",\n \"amount\": -128.68,\n \"name\": \"PAYBILL\",\n \"timestamp\": \"2021-11-23T17:17:37.6275196Z\",\n \"label\": \"Pagamento efetuado\",\n \"data\": {\n \"id\": \"4646305e-8eda-460b-93a3-5d82ffdae56a\",\n \"correlation_id\": \"91ea5979-228f-474d-a789-1102c74ae219\",\n \"digitable\": \"846800000016286800820891999104482503775822925993\",\n \"amount\": 128.68,\n \"original_amount\": 128.68,\n \"assignor\": \"Conta - Segmento Telefone\",\n \"recipient_document\": null,\n \"recipient_name\": null,\n \"charges\": {\n \"interest_amount_calculated\": 0,\n \"fine_amount_calculated\": 0,\n \"discount_amount\": 0\n },\n \"settle_date\": \"2021-11-23T00:00:00Z\",\n \"payment_date\": \"2021-11-23T17:17:37.6275492Z\",\n \"type\": \"Concessionaire\",\n \"due_date\": \"2021-11-23T00:00:00Z\",\n \"transaction_id\": 8379218,\n \"confirmation_transaction_id\": 8379220,\n \"description\": \"\",\n \"authentication_code\": \"4646305e-8eda-460b-93a3-5d82ffdae56a\",\n \"payment_status\": \"Created\",\n \"payment_type\": \"Bill\",\n \"company_key\": \"SDB_CONTBANK\",\n \"document_number\": \"99999999999\",\n \"bank_account\": \"184999\",\n \"bank_branch\": \"0001\",\n \"confirmed_at\": \"0001-01-01T00:00:00Z\",\n \"created_at\": \"2021-11-23T17:17:37.6275196Z\",\n \"updated_at\": \"2021-11-23T17:17:38.901733Z\",\n \"version\": 2,\n \"has_uncommitted_events\": true\n },\n \"status\": \"ACTIVE\"\n }\n ]\n}"},{"id":"d40f125f-8c01-477a-b6a3-fa22f4f508cc","name":"403 - Account not authorized or account query param not sent.","originalRequest":{"method":"GET","header":[{"key":"X-Current-Identity","value":"05621174000195","type":"text","description":"CNPJ do cliente que será efetuado a consulta do extrato bancário."}],"url":{"raw":"{{url_contbank}}/bank-statements?page=1&per_page=5&branch=0001&account=999999999&begin_date_time=2022-09-01T04:11:53.6050541Z&end_date_time=2022-10-31T04:11:53.6050541Z","host":["{{url_contbank}}"],"path":["bank-statements"],"query":[{"key":"page","value":"1","description":"Posição da página/ Obrigatório"},{"key":"per_page","value":"5","description":"Qtd de registros por página/ Obrigatório"},{"key":"branch","value":"0001","description":"Número da agência/ Obrigatório"},{"key":"account","value":"999999999","description":"Número da conta / Obrigatório"},{"key":"begin_date_time","value":"2022-09-01T04:11:53.6050541Z","description":"Data inicial da consulta"},{"key":"end_date_time","value":"2022-10-31T04:11:53.6050541Z","description":"Data final da consulta"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Mon, 21 Nov 2022 20:18:25 GMT"},{"key":"Content-Length","value":"0"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, Accept, X-Token, X-Current-Identity, *"},{"key":"Access-Control-Allow-Methods","value":"*"},{"key":"Access-Control-Allow-Origin","value":""},{"key":"Request-Id","value":"aafe1124-7726-4b25-9056-6de5bd4914b6"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"4bf317ea-42e3-4068-9021-3d2866df7a1b"}],"id":"72ddb64c-8c42-493c-9173-e486cca71126","description":"

Endpoint responsável por consultar o extrato bancário de uma conta específica.

O período máximo aceitável para consultas ao extrato é de 90 (noventa) dias.

Todas as movimentações que impactam o saldo de um cliente são retornadas nesta consulta, como transações via PIX/TED, pagamento de contas, recebimento de boletos, entre outros.

API e OFX

O campo conciliation_description é retornado pela API v2 do extrato e também é utilizado no arquivo OFX, no campo Memo. Ele pode ser utilizado para conciliar os lançamentos entre o arquivo e a API.

TABELA DE REFERÊNCIA DOS TIPOS DE TRANSAÇÕES

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Label	Reference	Type	Unique Transaction ID Property
PIX_CASH_OUT_ACCOUNT	Cash out por pix.	Débito	data.authentication_code
PIX_CASH_IN_ACCOUNT	Cash in por pix.	Crédito	data.deposit_transaction_id
PIX_REFUND_ACCOUNT	Devolução (cash in) de pix.	Crédito	data.deposit_transaction_id
CASH_IN_ACCOUNT	Cash in por TED/BOLETO/DOC.	Crédito	data.deposit_transaction_id
CASH_OUT_ACCOUNT	Cash out por TED.	Débito	data.transaction_receipt.authentication_code
REFUND_ACCOUNT	Cash in originado de devolução de TED.	Crédito	data.deposit_transaction_id
PAYBILL	Pagamento de Contas.	Débito	data.id

","_postman_id":"72ddb64c-8c42-493c-9173-e486cca71126"},{"name":"6. Billings","item":[{"name":"Create Billing","event":[{"listen":"test","script":{"id":"c9214f2b-f4df-4020-844a-3d32a9c93c18","exec":["var jsonData = JSON.parse(responseBody);","postman.setEnvironmentVariable(\"billing_id\", jsonData.id);"],"type":"text/javascript"}}],"id":"1d14e03f-899a-468c-b4ea-675490cd4874","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{partner_token}}"},"isInherited":false},"method":"POST","header":[{"key":"X-Current-Identity","value":"12345678901","type":"text","description":"

CPF/CNPJ do usuário que está gerando a nova cobrança.

\n"}],"body":{"mode":"raw","raw":"{\n \"billing_method\": \"BOLETO\",\n \"account\": {\n \"branch\": \"{{branch_number}}\",\n \"number\": \"{{account_number}}\"\n },\n \"amount\": 20.00,\n \"due_date\": \"2023-02-01T00:00:00.0000000-03:00\",\n \"description\": \"Descrição do boleto\",\n \"payer\": {\n \"name\": \"Nome do Pagador do Boleto\",\n \"trade_name\": \"Nome do Pagador do Boleto\",\n \"identifier\": \"70043708013\",\n \"address\": {\n \"zip\": \"01301100\",\n \"street\": \"Rua da Consolação, 1000 Apto XYZ\", \n \"neighborhood\": \"Bairro Consolação\",\n \"city\": \"São Paulo\",\n \"state\": \"SP\"\n },\n \"email\": \"email_da_notificacao@contbank.com\",\n \"phone\": {\n \"country_code\": \"55\",\n \"phone_number\": \"11999999999\"\n }\n },\n \"discount_rate\": 15,\n \"fine_rate\": 2,\n \"interest_rate\": 1.75,\n \"total_of_installments\" : 2,\n \"partner\" : {\n \"fee_rate\" : 0,\n \"fee_value\" : 2.50\n },\n \"long_looping\":true\n}","options":{"raw":{"language":"json"}}},"url":"{{url_contbank}}/billings/accounts/:account_id","description":"

Endpoint para criação de uma nova cobrança.

O account_id deve ser enviado na URL.
O X-Current-Identity deve ser preenchido no Header da requisição.

Request Schema

Campo	Descrição
billing_method	Indica o tipo da cobrança. Os valores aceitos são : BOLETO ou PIX. Campo obrigatório.
account.branch	Agência da conta que está criando a nova cobrança. Campo obrigatório.
account.number	Número da conta de quem está criando a nova cobrança. Campo obrigatório.
amount	Valor da cobrança em Reais (BRL). Atualmente, se o billing_method for BOLETO, os valores aceitos devem estar entre R$ 5,00 e R$ 120.000,00. Para cobrança via PIX não há restrição de valores. Campo obrigatório.
due_date	Data de vencimento da cobrança. A data limite de pagamento de uma cobrança via BOLETO, por padrão, é de 60 dias após esta data de vencimento indicada. Para PIX, o campo due_date indica a data limite de pagamento. Campo obrigatório.
description	Descrição da cobrança. Este valor será apresentado no PDF da cobrança. Campo opcional, mas recomendado para que o seu cliente tenha um maior esclarescimento do que trata-se a cobrança em questão.
payer	São os dados de quem está sendo cobrado, ou seja, do responsável pelo pagamento. Campo obrigatório.
payer.name	Nome ou Razão Social do pagador.
payer.trade_name	Campo opcional. Utilizado quando o pagador possui nome fantasia.
payer.address	Campo obrigatório. Caso não tenha alguma informação obrigatória do pagador, deixe não envie este objeto que iremos assumir o endereço do Contbank como padrão.
payer.address.zip	Campo obrigatório. Código postal do endereço do pagador.
payer.address.street	Campo obrigatório. Rua do endereço do pagador.
payer.address.neighborhood	Campo obrigatório. Bairro do endereço do pagador.
payer.address.city	Campo obrigatório. Cidade do endereço do pagador.
payer.address.state	Campo obrigatório. UF do endereço do pagador.
payer.email	Campo opcional. E-mail do pagador. Quando informado, enviaremos lembretes de vencimento e/ou confirmação do pagamento da cobrança.
payer.phone	Campo opcional. Telefone celular do pagador. Quando informado, enviaremos SMS ao número indicado, lembrando do vencimento e/ou confirmando o recebimento do pagamento da cobrança. OBSERVAÇÃO : Por padrão o disparo via SMS está desativado. Procure o time comercial do Contbank para ativação.
close_payment	Trata-se da data para encerramento da cobrança. Se o billing_method for PIX, este campo é desconsiderado, pois a data de encerramento da cobrança será considerada como sendo a data do campo due_date. Campo opcional e válido apenas para billing_method BOLETO. Se o billing_method for PIX, este campo é desconsiderado.
close_payment_days	Quantidade de dias para encerramento da cobrança. Campo opcional e válido apenas para billing_method BOLETO. Se o billing_method for PIX, este campo é desconsiderado.
discount_value	Valor da Taxa de desconto que será aplicado ao valor da cobrança quando ocorrer compensação até 1 (um) dia antes da data de vencimento. Campo opcional e válido apenas para billing_method BOLETO. Se o billing_method for PIX este campo é desconsiderado, pois não há a possibilidade de aplicação de desconto para este formato de cobrança.
discount_day	Dias para aplicação do desconto, quando a cobrança é antecipada. Campo opcional e válido apenas para billing_method BOLETO. Se o billing_method for PIX este campo é desconsiderado.
discount_type	Referente ao tipo de desconto a ser aplicado, quando a cobrança é antecipada. Valores aceitos : CURRENCY ou PERCENT. Campo opcional e válido apenas para billing_method BOLETO. Se o billing_method for PIX este campo é desconsiderado.
fine_value	Valor referente a multa. Aplicado quando pago após o vencimento. Campo opcional e válido apenas para billing_method BOLETO. Se o billing_method for PIX este campo é desconsiderado, pois não há a possibilidade de aplicação de multa para este formato de cobrança.
fine_type	Referente ao tipo da a ser aplicada. Valores aceitos : PERCENT ou CURRENCY. Campo opcional e válido apenas para billing_method BOLETO. Se o billing_method for PIX este campo é desconsiderado.
fine_day	Refere-se à quantidade de dias pós vencimento, para aplicação da multa. Campo opcional e válido apenas para billing_method BOLETO. Se o billing_method for PIX este campo é desconsiderado.
interest_value	Valor referente aos juros mensais. Aplicado quando pago após o vencimento. Campo opcional e válido apenas para billing_method BOLETO. Se o billing_method for PIX este campo é desconsiderado, pois não há a possibilidade de aplicação de juros para este formato de cobrança.
interest_day	Refere-se à quantidade de dias necessários, pós vencimento para aplicação dos juros mensais. Campo opcional e válido apenas para billing_method BOLETO. Se o billing_method for PIX este campo é desconsiderado.
interest_type	Campo opcional. Referente ao tipo de aplicação dos juros mensais. Valores aceitos : PERCENT ou CURRENCY. Campo opcional e válido apenas para billing_method BOLETO. Se o billing_method for PIX este campo é desconsiderado.
total_of_installments	Campo opcional. Deve ser informado apenas quando for uma cobrança recorrente. Indica a quantidade de vezes/meses em que a cobrança será emitida. As emissões seguintes serão efetuadas nos meses subsequentes ao do primeiro vencimento (o informado no campo due_date).
partner.fee_rate	Campo opcional. Taxa percentual que será aplicada sob o valor pago. Esta taxa será destinada como crédito ao Parceiro, sendo debitada do cliente emitente. Semelhante ao fee_value.
partner.fee_value	Campo opcional. Taxa monetária (em R$) que será aplicada. Esta taxa será destinada como crédito ao Parceiro, sendo debitada do cliente emitente. Semelhante ao fee_rate.
long_looping	Campo opcional e válido apenas para billing_method BOLETO. Se o billing_method for PIX este campo é desconsiderado. Ao enviar a requisição com o valor \"false\", a API retornará imediatamente a solicitação de criação de boleto e não aguardará o tempo de registro do mesmo. Utilização Recomendada: Valor \"true\": Permite que a API aguarde o tempo necessário para o registro completo do boleto antes de retornar a resposta. Valor \"false\": Recomendado para integrações avançadas. Ao optar por \"false\", os parceiros devem acompanhar as mudanças de status do boleto através do webhook associado à API. Isso permitirá que atualizações sobre o status do boleto sejam recebidas em tempo real, sem esperar pela confirmação na resposta da requisição. Nota: É crucial que a integração esteja preparada para gerenciar as atualizações de status por meio do webhook correspondente ao valor \"false\" para garantir o acompanhamento preciso dos boletos criados.
is_pix_qrcode_file_required	Flag para indicar a necessidade de retornar o Pix QR Code no formato de imagem png. Quando enviada como \"false\" a imagem não é retornada. Campo opcional. Caso seja emitida uma cobrança PIX e este campo não seja enviado, iremos assumir o valor como \"false\".

Response Schema

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Campo	Descrição
current_identity	É o CPF/CNPJ do usuário que gerou a cobrança.
account	São os dados da conta que gerou a cobrança.
status	Pode ser \"PENDING\" (cobrança ainda sendo registrada), \"REGISTERED\" (cobrança já registrada e aguardando o pagamento), \"CANCELED\" (cobrança cancelada) ou \"SETTLED\" (cobrança paga/quitada).
close_payment	Indica a data limite que o pagamento é aceito. Após esta data, não é mais possível receber o pagamento da cobrança, sendo a mesma automaticamente cancelada. Para cobranças do tipo PIX este campo será retornado com o mesmo valor do due_date.
billing_method_related	Objeto que irá conter demais dados pertinentes ao tipo de cobrança (billing_method) que foi solicitado.
billing_method_related.pix_id	ID de referência do PIX vinculado a cobrança solicitada. É apenas um ID de controle e não é preciso externar ao seu cliente.
billing_method_related.pix_encoded_value	Este campo é retornado apenas para cobranças com o billing_method indicado como PIX. Refere-se ao valor em base64 do PIX Copia e Cola. Para retornar ao seu cliente, você deve converter o valor de base64 para texto/string. Se preferir, já retornamos no campo billing_method_related.pix_copy_paste o valor decodificado.
billing_method_related.pix_encoded_file	Este campo é retornado apenas para cobranças com o billing_method indicado como PIX. Refere-se a imagem do QRCode no formato PNG. Essa opção será retornada apenas quando a flag is_pix_qrcode_file_required estiver indicada como \"true\" no payload, pois esta opção pode ocasionar um tempo de retorno, mesmo em milissegundos, maior.
billing_method_related.pix_copy_paste	Este campo é retornado apenas para cobranças com o billing_method indicado como PIX. Refere-se ao valor string (campo pix_encoded_value decodificado) do PIX Copia e Cola.
billing_method_related.boleto_id	Este campo é retornado apenas para cobranças com o billing_method indicado como PIX. ID de referência do BOLETO vinculado a cobrança solicitada. É apenas um ID de controle e não é preciso externar ao seu cliente.
discounts	Objeto que contém os valores de descontos a serem aplicados. Este campo é retornado apenas para cobranças com o billing_method indicado como BOLETO.
fine	Objeto que contém os valores de multa a serem aplicados. Este campo é retornado apenas para cobranças com o billing_method indicado como BOLETO.
interest	Objeto que contém os valores de juros a serem aplicados. Este campo é retornado apenas para cobranças com o billing_method indicado como BOLETO.
status_history	Histórico dos status que a cobrança percorreu. Trata-se de um array. O status atual da cobrança é desconsiderada no histórico.
created_by	ID do usuário que realizou a requisição de criação da cobrança. Ela é vinculada a credencial de acesso.

","urlObject":{"path":["billings","accounts",":account_id"],"host":["{{url_contbank}}"],"query":[],"variable":[{"description":{"content":"

Id da conta do usuário para geração da cobrança. Variavel de ambiente ao carregada pela rota Get Bank Account.

\n","type":"text/plain"},"type":"any","value":"{{account_id}}","key":"account_id"}]}},"response":[{"id":"966d60d8-c77c-4bf4-9b3c-852790b10505","name":"Create Billing - 202 Accepted - BolePIX","originalRequest":{"method":"POST","header":[{"key":"X-Current-Identity","value":"16246241620","type":"text","description":"CPF/CNPJ do usuário que está gerando a nova cobrança."}],"body":{"mode":"raw","raw":"{\n \"billing_method\": \"BOLETO\",\n \"account\": {\n \"branch\": \"0001\",\n \"number\": \"123456\"\n },\n \"amount\": 20.00,\n \"due_date\": \"2023-02-01T00:00:00.0000000-03:00\",\n \"description\": \"Descrição do boleto\",\n \"payer\": {\n \"name\": \"Nome do Pagador do Boleto\",\n \"trade_name\": \"Nome do Pagador do Boleto\",\n \"identifier\": \"99988855544\",\n \"address\": {\n \"zip\": \"01301100\",\n \"street\": \"Rua da Consolação, 1000 Apto XYZ\", \n \"neighborhood\": \"BAIRRO CONSOLAÇÃO\",\n \"city\": \"São Paulo\",\n \"state\": \"SP\"\n },\n \"email\": \"email_da_notificacao@contbank.com\",\n \"phone\": {\n \"country_code\": \"55\",\n \"phone_number\": \"11999999999\"\n }\n },\n \"discount_value\": 15,\n \"discount_day\": 1,\n \"discount_type\": \"PERCENT\",\n \"fine_value\": 2,\n \"fine_day\": 1,\n \"fine_type\": \"PERCENT\",\n \"interest_value\": 1.75,\n \"interest_day\": 1,\n \"interest_type\": \"PERCENT\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{url_contbank}}/billings/accounts/:account_id","host":["{{url_contbank}}"],"path":["billings","accounts",":account_id"],"variable":[{"key":"account_id","value":"{{account_id}}","description":"Id da conta do usuário para geração da cobrança. Variavel de ambiente ao carregada pela rota Get Bank Account."}]}},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"_id\": \"63747b11f33f0e0c367fcbe1\",\n \"billing_method\": \"BOLETO\",\n \"current_identity\": \"12345678901\",\n \"account\": {\n \"account_id\": \"1234567a8901b23456789c0d\",\n \"branch\": \"0001\",\n \"number\": \"123456\",\n \"identifier\": \"12345678901\"\n },\n \"payer\": {\n \"name\": \"NOME DO PAGADOR DO BOLETO\",\n \"trade_name\": \"NOME DO PAGADOR DO BOLETO\",\n \"identifier\": \"99988877744\",\n \"address\": {\n \"zip\": \"01301100\",\n \"street\": \"RUA DA CONSOLAÇÃO, 1000 APTO XYZ\",\n \"neighborhood\": \"BAIRRO CONSOLAÇÃO\",\n \"city\": \"SÃO PAULO\",\n \"state\": \"SP\"\n },\n \"email\": \"email_da_notificacao@contbank.com\",\n \"phone\": {\n \"country_code\": \"55\",\n \"phone_number\": \"11999999999\"\n },\n \"notifications\": {\n \"send_email\": true,\n \"send_sms\": true\n }\n },\n \"due_date\": \"2023-02-01T00:00:00Z\",\n \"close_payment\": \"2023-04-02T00:00:00Z\",\n \"description\": \"DESCRIÇÃO DO BOLETO\",\n \"amount\": 20,\n \"discounts\": {\n \"limit_date\": \"2023-01-31T23:59:59Z\",\n \"value\": 15,\n \"type\": \"FixedPercentUntilLimitDate\"\n },\n \"fine\": {\n \"start_date\": \"2023-02-02T00:00:00Z\",\n \"value\": 2,\n \"type\": \"Percent\"\n },\n \"interest\": {\n \"start_date\": \"2023-02-02T00:00:00Z\",\n \"value\": 1.75,\n \"type\": \"PercentPerMonth\"\n },\n \"status\": \"PENDING\",\n \"status_history\": [\n {\n \"status\": \"NEW\",\n \"updated_at\": \"2022-11-16T05:56:24.753001729Z\",\n \"updated_by\": \"1234c500aa81769229db2da7\"\n }\n ],\n \"updated_at\": \"2022-11-16T05:56:24.837213482Z\",\n \"updated_by\": \"1234c500aa81769229db2da7\",\n \"created_at\": \"2022-11-16T05:56:24.753251969Z\",\n \"created_by\": \"1234c500aa81769229db2da7\",\n \"request_id\": \"26dc9ec6-db3e-4823-8621-e594c42abdab\",\n \"billing_method_related\": {\n \"updated_at\": \"2022-11-16T05:56:24.837174243Z\",\n \"boleto_id\": \"63747b00fbffae4d663519aa\"\n }\n}"},{"id":"eae0d0eb-e31c-4af3-9da1-0eed33498b37","name":"Create Billing - 202 Accepted - PIX Copia e Cola ou QRCode","originalRequest":{"method":"POST","header":[{"key":"X-Current-Identity","value":"16246241620","type":"text","description":"CPF/CNPJ do usuário que está gerando a nova cobrança."}],"body":{"mode":"raw","raw":"{\n \"billing_method\": \"PIX\",\n \"account\": {\n \"branch\": \"0001\",\n \"number\": \"123456\"\n },\n \"amount\": 10.00,\n \"due_date\": \"2024-05-01T00:00:00.000Z\",\n \"description\": \"COBRANÇA VIA PIX COPIA E COLA\",\n \"payer\": {\n \"name\": \"NOME DO CLIENTE\",\n \"identifier\": \"99988855544\" \n },\n \"is_pix_qrcode_file_required\" : true\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{url_contbank}}/billings/accounts/:account_id","host":["{{url_contbank}}"],"path":["billings","accounts",":account_id"],"variable":[{"key":"account_id","value":"{{account_id}}","description":"Id da conta do usuário para geração da cobrança. Variavel de ambiente ao carregada pela rota Get Bank Account."}]}},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"6618e80c526d5c3a1bcfe6d0\",\n \"billing_method\": \"PIX\",\n \"current_identity\": \"12345678901\",\n \"account\": {\n \"account_id\": \"1234567a8901b23456789c0d\",\n \"branch\": \"0001\",\n \"number\": \"123456\",\n \"identifier\": \"12345678901\"\n },\n \"payer\": {\n \"name\": \"NOME DO CLIENTE\",\n \"identifier\": \"99988855544\",\n \"address\": {\n \"street\": \"AV PAULISTA, 1765, BAIRRO BELA VISTA\",\n \"zip\": \"01311930\",\n \"city\": \"SÃO PAULO\",\n \"state\": \"SP\",\n \"number\": \"1765\",\n \"neighborhood\": \"BAIRRO BELA VISTA\",\n \"country\": \"BR\"\n },\n \"notifications\": {\n \"send_email\": false,\n \"send_sms\": false\n }\n },\n \"due_date\": \"2024-05-0123:59:59.999999999Z\",\n \"close_payment\": \"2024-05-01T23:59:59.999999999Z\",\n \"description\": \"COBRANÇA VIA PIX COPIA E COLA\",\n \"amount\": 10,\n \"status\": \"REGISTERED\",\n \"status_history\": [\n {\n \"status\": \"NEW\",\n \"updated_at\": \"2024-04-11T14:51:44.444821474-03:00\",\n \"updated_by\": \"6079c518aa81769229db2da7\"\n }\n ],\n \"updated_at\": \"2024-04-11T14:51:45.542629577-03:00\",\n \"updated_by\": \"6079c518aa81769229db2da7\",\n \"created_at\": \"2024-04-11T14:51:44.444898848-03:00\",\n \"created_by\": \"6079c518aa81769229db2da7\",\n \"request_id\": \"d893ccaa-091e-49c3-b3df-c9acbe318dff\",\n \"billing_method_related\": {\n \"updated_at\": \"2024-04-12T04:51:45.542628877-03:00\",\n \"pix_id\": \"6618e80c9c3f0b0f8014ab8b\",\n \"pix_encoded_value\": \"MDAwMjAxMDEwMjEyMjY5MjAwMTRici5nb3YuYmNiLnBpeDI1NzBxci1oLnNhbmRib3guYmFua2x5LmNvbS5ici9waXgvcXIvMGIzMTkxNmYtYTdkZS00YjM5LTg3MjUtNjMyMTBlZmE2MmEyNTIwNDAwMDA1MzAzOTg2NTgwMkJSNTkyNUdJUkVTIENPTlNVTFRPUklBIENPTlRBQkk2MDA5U0FPIFBBVUxPNjEwODAxMzExOTMwNjIwNzA1MDMqKio2MzA0MTQ0Mg==\",\n \"pix_encoded_file\": \"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAQAAAAEAAQMAAABmvDolAAAABlBMVEX///8AAABVwtN+AAAD30lEQVR42uyZP47kLBDFn0VAyA3MRZC5FkFLWJrA16LFRewbVEhg+X0qprt3J/yCZjsYolXrtxJT1J/3yvg9v+d/nkxe0+XENbua4ndPNuQTkeQoIAHLdDkir4jndHkISZYFcJ8DxHPxu4Pb2s2UGXBslrUs/hoLXOhACJh2gNzOMBqYPYG8rfqCu3MtbyeGAsAyTyIC3GKZDgrYEPDjNd8MaFbPs3Nu275qPY5dpKUUwo+0/9eAHn+Q7Bk17XBahOFnC3gzkCKv578NeXnCbg3h9fMAIBdT5olOsl4S005puQVz5yGjgNRTWcODm6nX7EVsQwgTOQzIp5a001TOtczTLmLXzHPB9DkAEJbpEJGEm+Hu6YTbVlk8hwG5nsDsHLcVpkzHLq4hBXM/dowCLOs1wzkk3OI5e1Jasvq/vIwCEE9MF5zbWi6Y4UG7ptBTfRSQEK9JCznlNcAfO4XcKvmqrA8AbIn3Q7Oa33OTYEsJIV6Pv2IEUHnpGwLJnJinnWjJapY9KmsAkCJ1WkJrusDv3jmNnrlzxygg1xKPPpL4VeL10DA8X4EaANha75f+uOazjyHn2GBqRz8F6Hpm1pAmGBW9gma30/B6iJwBgKUOS0du29cZvALcWkA8HhpmBFCizk26lm5GR6jQsqmM+lPd7wZyCdBWLHY17DpKkOzZfxwFpBAWT3F6yViPg6D9Fv9Pp/YBgOWpFxa3PpQ5YFcVFa8eNQDQepohkvlVyWOHZleJvPwwQG2qij1J6QZzHOxdMMTy0lEDAHNGHoTbtlPn0O76Jc1998MAzWqoU8sk66FtrmnJT09L8AlAMiXu6uhbXk3X6GiW5P24xgGx6sPJt/DGDHHoneBV/u8HAHP5HdKtvQ4iim25lmV6Oda3AynEuwYKeb3FAviufzWpn2JvAGAqj0NFZLvBdNFArsD02ol9AhBrmXVYrt1Wq9Cyq63n0jviGMCWeMGLCHQc7NMujuSpoRwGwBT4R/OLxe9e9DVNWV5Z/X7A1hJVKvS9HCbuIi1vJfboDQL0zFpFqd9XWzHy9tci9xOArKbsckBuQLy8uiTbAuCfu6D3Aw9D5FRIfO+jpCXEet89RwGaPACc5FWH0rdx7PphxjBAHwuOkuwau+BEs6s54Xc3CuhfH9SpcTW1HprVXBHP5ble+ASgb5tnJ2rVapl6JLc1BDwDOQKIp2psvZBRwUnplRX5tLTjAPnuv3NfovYNx5/1whBgnh37ErXME8Vx22r9a5H7fgD9QwNFx8HZzasaEFPw12v+a6B/fejLw3QLXXN1/aDuVkYBv+f3vM5/AQAA//8lBau0yqizkwAAAABJRU5ErkJggg==\",\n \"pix_copy_paste\": \"00020101021226920014br.gov.bcb.pix2570qr-h.sandbox.bankly.com.br/pix/qr/0b31916f-a7de-4b39-8725-63210efa62a25204000053039865802BR5925GIRES CONSULTORIA CONTABI6009SAO PAULO61080131193062070503***63041442\"\n },\n \"installment\": 1,\n \"total_of_installments\": 1\n}"},{"id":"4bbf982a-8399-435a-8e5e-2ab787c23d65","name":"Create Billing - 422 Invalid Amount","originalRequest":{"method":"POST","header":[{"key":"X-Current-Identity","value":"16246241620","type":"text","description":"CPF/CNPJ do usuário que está gerando a nova cobrança."}],"body":{"mode":"raw","raw":"{\n \"billing_method\": \"BOLETO\",\n \"account\": {\n \"branch\": \"0001\",\n \"number\": \"123456\"\n },\n \"amount\": 1.00,\n \"due_date\": \"2023-02-01T00:00:00.0000000-03:00\",\n \"description\": \"Descrição do boleto\",\n \"payer\": {\n \"name\": \"Nome do Pagador do Boleto\",\n \"trade_name\": \"Nome do Pagador do Boleto\",\n \"identifier\": \"99988855544\",\n \"address\": {\n \"zip\": \"01301100\",\n \"street\": \"Rua da Consolação, 1000 Apto XYZ\", \n \"neighborhood\": \"BAIRRO CONSOLAÇÃO\",\n \"city\": \"São Paulo\",\n \"state\": \"SP\"\n },\n \"email\": \"email_da_notificacao@contbank.com\",\n \"phone\": {\n \"country_code\": \"55\",\n \"phone_number\": \"11999999999\"\n }\n },\n \"discount_rate\": 15,\n \"fine_rate\": 2,\n \"interest_rate\": 1.75\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{url_contbank}}/billings/accounts/:account_id","host":["{{url_contbank}}"],"path":["billings","accounts",":account_id"],"variable":[{"key":"account_id","value":null}]}},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"code\": 422,\n \"key\": \"INVALID_PARAMETER\",\n \"messages\": [\n \"validation failed for amount\"\n ]\n}"},{"id":"40269cbf-04eb-45fe-9254-05015db34b9d","name":"Create Billing - 400 Bad Request - Conta inválida","originalRequest":{"method":"POST","header":[{"key":"X-Current-Identity","value":"16246241620","type":"text","description":"CPF/CNPJ do usuário que está gerando a nova cobrança."}],"body":{"mode":"raw","raw":"{\n \"billing_method\": \"PIX\",\n \"account\": {\n \"branch\": \"000\",\n \"number\": \"000\"\n },\n \"amount\": 10.00,\n \"due_date\": \"2024-05-01T00:00:00.000Z\",\n \"description\": \"COBRANÇA VIA PIX COPIA E COLA\",\n \"payer\": {\n \"name\": \"NOME DO CLIENTE\",\n \"identifier\": \"99988855544\" \n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{url_contbank}}/billings/accounts/:account_id","host":["{{url_contbank}}"],"path":["billings","accounts",":account_id"],"variable":[{"key":"account_id","value":"000000000000","description":"Id da conta do usuário para geração da cobrança. Variavel de ambiente ao carregada pela rota Get Bank Account."}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"code\": 400,\n \"key\": \"INVALID_ACCOUNT_BRANCH_OR_NUMBER\",\n \"messages\": [\n \"invalid account branch or number\"\n ]\n}"},{"id":"d2a475ca-09cf-472f-84c9-10b4d1cad496","name":"Create Billing - 400 Bad Request - Data de vencimento inválida","originalRequest":{"method":"POST","header":[{"key":"X-Current-Identity","value":"16246241620","type":"text","description":"CPF/CNPJ do usuário que está gerando a nova cobrança."}],"body":{"mode":"raw","raw":"{\n \"billing_method\": \"PIX\",\n \"account\": {\n \"branch\": \"0001\",\n \"number\": \"123456\"\n },\n \"amount\": 10.00,\n \"due_date\": \"1990-01-01T00:00:00.000Z\",\n \"description\": \"COBRANÇA VIA PIX COPIA E COLA\",\n \"payer\": {\n \"name\": \"NOME DO CLIENTE\",\n \"identifier\": \"99988855544\" \n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{url_contbank}}/billings/accounts/:account_id","host":["{{url_contbank}}"],"path":["billings","accounts",":account_id"],"variable":[{"key":"account_id","value":"{{account_id}}","description":"Id da conta do usuário para geração da cobrança. Variavel de ambiente ao carregada pela rota Get Bank Account."}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"code\": 400,\n \"key\": \"INVALID_DUE_DATE\",\n \"messages\": [\n \"invalid due date\"\n ]\n}"}],"_postman_id":"1d14e03f-899a-468c-b4ea-675490cd4874"},{"name":"Simulate Billing Payment (Sandbox Only)","id":"78267c23-b543-436a-90e2-da5a2bdf7d77","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{partner_token}}"},"isInherited":false},"method":"PUT","header":[{"key":"X-Current-Identity","value":"99999999999","description":"

CPF ou CNPJ do cliente emissor da cobrança

\n"}],"url":"{{url_contbank}}/s2s/billings/settle/:billing_id/paid","description":"

Este endpoint permite simular pagamentos de cobranças. A função de simulação permite que você teste e valide o processo de pagamento sem realizar transações reais. Este recurso é exclusivo do ambiente de sandbox e não afetará transações em produção.

Ao realizar a simulação de baixa, a cobrança correspondente ao ID em questão, constará como Paga na tela de Gestão de Cobranças, acessada via Dashboard Bancário.

Ao mesmo tempo, caso seja efetuada qualquer consulta desta cobrança via API (endpoints de GET By ID ou List), teremos o status \"PAID_OUT\" retornado.

Tabela de Responses

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Código	Descrição	Conteúdo
204	Sucesso (Sem Conteúdo)	Nenhum conteúdo retornado
403	Proibido	json schema

Tabela de Schema

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Campo	Tipo	Descrição
code	Inteiro	O código de erro HTTP (403 neste caso).
key	String	A chave que identifica o erro (\"SETTLEMENT_NOT_ALLOWED\"). Esse erro indica que a cobrança não esta registrada, e não pode ser simulado o pagamento.
messages	Array	Uma lista de mensagens de erro, contendo o(s) motivo(s) do(s) erro(s).

","urlObject":{"path":["s2s","billings","settle",":billing_id","paid"],"host":["{{url_contbank}}"],"query":[],"variable":[{"description":{"content":"

ID da cobrança gerada | obrigatório

\n","type":"text/plain"},"type":"any","value":"{{billing_id}}","key":"billing_id"}]}},"response":[{"id":"68a55c0c-c0b1-4739-9d82-a6f073891dec","name":"Success - 204 No Content","originalRequest":{"method":"PUT","header":[{"key":"X-Current-Identity","value":"99999999999","description":"CPF ou CNPJ do cliente emissor da cobrança"}],"url":{"raw":"{{url_contbank}}/s2s/billings/settle/:billing_id/paid","host":["{{url_contbank}}"],"path":["s2s","billings","settle",":billing_id","paid"],"variable":[{"id":"b8caa01e-9970-477e-a366-8ba87e043ca7","key":"billing_id","value":"","description":"ID da cobrança gerada | obrigatório"}]}},"status":"No Content","code":204,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"0ef24df9-aeeb-4f18-92ae-190fb4c4be79","name":"Error - 403 Fobidden","originalRequest":{"method":"PUT","header":[{"key":"X-Current-Identity","value":"99999999999","description":"CPF ou CNPJ do cliente emissor da cobrança"}],"url":{"raw":"{{url_contbank}}/s2s/billings/settle/:billing_id/paid","host":["{{url_contbank}}"],"path":["s2s","billings","settle",":billing_id","paid"],"variable":[{"key":"billing_id","value":"{{billing_id}}","description":"ID da cobrança gerada | obrigatório"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"code\": 403,\r\n \"key\": \"SETTLEMENT_NOT_ALLOWED\",\r\n \"messages\": [\r\n \"error settlement is not allowed\"\r\n ]\r\n}"}],"_postman_id":"78267c23-b543-436a-90e2-da5a2bdf7d77"},{"name":"Cancel Billing","event":[{"listen":"test","script":{"id":"d502aa65-d583-4e0d-89dd-0565acbf83c8","exec":["var jsonData = JSON.parse(responseBody);","postman.setEnvironmentVariable(\"billing_id\", jsonData.id);"],"type":"text/javascript"}}],"id":"dd04a1e8-ce75-4e10-abb1-e89ead2a8548","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{partner_token}}"},"isInherited":false},"method":"PUT","header":[{"key":"X-Current-Identity","value":"12345678901","type":"text","description":"

CPF/CNPJ do usuário que está cancelando a cobrança.

\n"}],"body":{"mode":"raw","raw":"{\n \"reason\" : \"CANCEL-BILLING-REASON-001\",\n \"cancel_all_installments\" : false\n}","options":{"raw":{"language":"json"}}},"url":"{{url_contbank}}/s2s/billings/cancel/:billing_id","description":"

Endpoint para cancelamento de uma cobrança.

É possível realizar o cancelamento apenas de cobranças que estejam registradas e pendentes de pagamentos.

IMPORTANTE : Caso uma cobrança recorrente seja cancelada com a flag cancel_all_installments indicada em true, as emissões das competências seguintes não serão geradas. Caso o cancelamento seja efetuado com a flag cancel_all_installments em false, as demais emissões serão efetuadas normalmente.

O billing_id deve ser enviado na URL. Trata-se do ID da cobrança a ser cancelada.
O X-Current-Identity deve ser preenchido no Header da requisição.

Request Schema

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Campo	Descrição
reason	Indica o motivo do cancelamento. Campo obrigatório. Enviar motivo conforme consta no quadro abaixo.
cancel_all_installments	Flag que indica se as cobranças seguintes de uma recorrencia serão também cancelas ou não. Campo opcional. O valor default quando não enviado é false.

Response Schema

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Campo	Descrição
status	Pode ser \"PENDING\" (cobrança ainda sendo registrada), \"REGISTERED\" (cobrança já registrada e aguardando o pagamento), \"CANCELED\" (cobrança cancelada) ou \"SETTLED\" (cobrança paga/quitada). Ao realizar o cancelamento o status deverá ser retornado como \"CANCELED\".
updated_at	Indica a data de atualização do status, ou seja, data do cancelamento da cobrança.
updated_by	Indica o ID do usuário que realizou a alteração na cobrança, ou seja, quem procedeu com o cancelamento. Nos casos dos parceiros, será vinculado ao ID do token de autenticação.

Reason

Abaixo a lista de motivos aceitos para cancelamento de uma cobrança.
Este motivo é obrigatório para proceder com o cancelamento.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Valor	Descrição
CANCEL-BILLING-REASON-001	Baixado para acertos
CANCEL-BILLING-REASON-002	Baixado para devolução
CANCEL-BILLING-REASON-003	Baixado com pagamento direto ao cliente
CANCEL-BILLING-REASON-004	Baixado para substituição
CANCEL-BILLING-REASON-005	Baixado a pedido do cedente

","urlObject":{"path":["s2s","billings","cancel",":billing_id"],"host":["{{url_contbank}}"],"query":[],"variable":[{"id":"d1a166df-68d8-4aa5-88f0-e8e4647f0240","description":{"content":"

ID da cobrança a ser cancelada.

\n","type":"text/plain"},"type":"any","value":null,"key":"billing_id"}]}},"response":[{"id":"7d53f19d-4446-43ba-b8c6-842ac1771c17","name":"Create Billing - 200 OK","originalRequest":{"method":"POST","header":[{"key":"X-Current-Identity","value":"12345678901","type":"text","description":"CPF/CNPJ do usuário que está gerando a nova cobrança."}],"body":{"mode":"raw","raw":"{\n \"reason\" : \"CANCEL-BILLING-REASON-001\",\n \"cancel_all_installments\" : false\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{url_contbank}}/billings/cancel/:billing_id","host":["{{url_contbank}}"],"path":["billings","cancel",":billing_id"],"variable":[{"key":"billing_id","value":null,"description":"ID da cobrança a ser cancelada."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"_id\": \"6382dce123c71arrfa425a09\",\n \"billing_method\": \"BOLETO\",\n \"current_identity\": \"12345678901\",\n \"account\": {\n \"account_id\": \"6109864a1555f85450005e6e\",\n \"branch\": \"0001\",\n \"number\": \"123456\",\n \"identifier\": \"12345678901\"\n },\n \"payer\": {\n \"name\": \"NOME DO PAGADOR\",\n \"trade_name\": \"TRADE NAME DO PAGADOR\",\n \"identifier\": \"98798798789\",\n \"address\": {\n \"street\": \"RUA DA CONSOLAÇÃO, 1000 APTO ABC\",\n \"zip\": \"01301100\",\n \"city\": \"SÃO PAULO\",\n \"state\": \"SP\"\n },\n \"email\": \"teste@contbank.com\",\n \"phone\": {\n \"country_code\": \"55\",\n \"phone_number\": \"11999999999\"\n },\n \"notifications\": {\n \"send_email\": true,\n \"send_sms\": true\n }\n },\n \"due_date\": \"2023-02-01T00:00:00Z\",\n \"close_payment\": \"2023-04-02T00:00:00Z\",\n \"description\": \"EMISSÃO DE UMA COBRANÇA RECORRENTE\",\n \"amount\": 20,\n \"discounts\": {\n \"limit_date\": \"2023-01-31T23:59:59Z\",\n \"value\": 15,\n \"type\": \"FixedPercentUntilLimitDate\"\n },\n \"fine\": {\n \"start_date\": \"2023-02-02T00:00:00Z\",\n \"value\": 2,\n \"type\": \"Percent\"\n },\n \"interest\": {\n \"start_date\": \"2023-02-02T00:00:00Z\",\n \"value\": 1.75,\n \"type\": \"PercentPerMonth\"\n },\n \"status\": \"CANCELED\",\n \"status_history\": [\n {\n \"status\": \"NEW\",\n \"updated_at\": \"2022-11-27T03:43:33.467Z\",\n \"updated_by\": \"6079c518aa81769229db2da7\"\n },\n {\n \"status\": \"PENDING\",\n \"updated_at\": \"2022-11-27T03:43:48.732Z\",\n \"updated_by\": \"6079c518aa81769229db2da7\"\n },\n {\n \"status\": \"REGISTERED\",\n \"updated_at\": \"2022-11-27T03:44:09.263Z\",\n \"updated_by\": \"6079c518aa81769229db2da7\"\n },\n {\n \"status\": \"CANCELED\",\n \"status_reason\" : \"CANCEL-BILLING-REASON-001\",\n \"updated_at\": \"2022-11-27T03:45:08.433011878Z\",\n \"updated_by\": \"6079c518aa81769229db2da7\"\n }\n ],\n \"updated_at\": \"2022-11-27T03:45:08.433011878Z\",\n \"updated_by\": \"6079c518aa81769229db2da7\",\n \"created_at\": \"2022-11-27T03:43:33.467Z\",\n \"created_by\": \"6079c518aa81769229db2da7\",\n \"request_id\": \"5624bf84-7c2e-4a6e-8b88-13a992a83ea1\",\n \"billing_method_related\": {\n \"updated_at\": \"2022-11-27T03:43:48.732Z\",\n \"boleto_id\": \"6382dce5b1c9cd5b926e349e\",\n \"authentication_code\": \"9d97a92e-b10f-44c9-850e-10dfd6882890\"\n },\n \"installment\": 1,\n \"total_of_installments\": 4,\n \"partner\": {\n \"fee_rate\": 2.75,\n \"fee_value\": 5\n }\n}"},{"id":"1c529f61-3d4d-45e7-9638-f196c64180e7","name":"Create Billing - 400 Bad Request (Invalid Reason)","originalRequest":{"method":"POST","header":[{"key":"X-Current-Identity","value":"12345678901","type":"text","description":"CPF/CNPJ do usuário que está gerando a nova cobrança."}],"url":{"raw":"{{url_contbank}}/billings/cancel/:billing_id","host":["{{url_contbank}}"],"path":["billings","cancel",":billing_id"],"variable":[{"key":"billing_id","value":null,"description":"ID da cobrança a ser cancelada."}]}},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"code\": 422,\n \"key\": \"INVALID_PARAMETER\",\n \"messages\": [\n \"validation failed for amount\"\n ]\n}"},{"id":"f4a5ae67-d38d-432c-958c-5dfeabfad636","name":"Create Billing - 403 Forbidden (Invalid X-Current-Identity)","originalRequest":{"method":"POST","header":[{"key":"X-Current-Identity","value":"000000","type":"text","description":"CPF/CNPJ do usuário que está gerando a nova cobrança."}],"body":{"mode":"raw","raw":"{\n \"reason\" : \"Baixado com pagamento direto ao cliente\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{url_contbank}}/billings/cancel/:billing_id","host":["{{url_contbank}}"],"path":["billings","cancel",":billing_id"],"variable":[{"key":"billing_id","value":null,"description":"ID da cobrança a ser cancelada."}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"0e2dc25d-b6d4-4d0d-8d28-4232a44e0c6c","name":"Create Billing - 404 Not Found (Billing Not Found)","originalRequest":{"method":"POST","header":[{"key":"X-Current-Identity","value":"12345678901","type":"text","description":"CPF/CNPJ do usuário que está gerando a nova cobrança."}],"body":{"mode":"raw","raw":"{\n \"reason\" : \"Baixado com pagamento direto ao cliente\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{url_contbank}}/billings/cancel/:billing_id","host":["{{url_contbank}}"],"path":["billings","cancel",":billing_id"],"variable":[{"key":"billing_id","value":"00000000000","description":"ID da cobrança a ser cancelada."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"code\": 404,\n \"key\": \"NOT_FOUND\",\n \"messages\": [\n \"not found\"\n ]\n}"}],"_postman_id":"dd04a1e8-ce75-4e10-abb1-e89ead2a8548"},{"name":"[DEPRECATED] Cancel Billing","event":[{"listen":"test","script":{"id":"d502aa65-d583-4e0d-89dd-0565acbf83c8","exec":["var jsonData = JSON.parse(responseBody);","postman.setEnvironmentVariable(\"billing_id\", jsonData.id);"],"type":"text/javascript"}}],"id":"7c451f22-d479-4559-a7aa-10f84cd8a046","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{partner_token}}"},"isInherited":false},"method":"PUT","header":[{"key":"X-Current-Identity","value":"12345678901","type":"text","description":"

CPF/CNPJ do usuário que está cancelando a cobrança.

\n"}],"body":{"mode":"raw","raw":"{\n \"reason\" : \"Baixado com pagamento direto ao cliente\"\n}","options":{"raw":{"language":"json"}}},"url":"{{url_contbank}}/billings/cancel/:billing_id","description":"

[Esta rota não é mais válida (DEPRECATED)]

Endpoint para cancelamento de uma cobrança.

É possível realizar o cancelamento apenas de cobranças que estejam registradas e pendentes de pagamentos.

IMPORTANTE : Caso uma cobrança recorrente seja cancelada, as emissões das competências seguintes não serão geradas.

O billing_id deve ser enviado na URL. Trata-se do ID da cobrança a ser cancelada.
O X-Current-Identity deve ser preenchido no Header da requisição.

Request Schema

\n\n\n\n\n\n\n\n\n\n\n\n\n

Campo	Descrição
reason	Indica o motivo do cancelamento. Campo obrigatório. Verificar possíveis motivos no quadro abaixo.

Response Schema

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Campo	Descrição
status	Pode ser \"PENDING\" (cobrança ainda sendo registrada), \"REGISTERED\" (cobrança já registrada e aguardando o pagamento), \"CANCELED\" (cobrança cancelada) ou \"SETTLED\" (cobrança paga/quitada). Ao realizar o cancelamento o status deverá ser retornado como \"CANCELED\".
updated_at	Indica a data de atualização do status, ou seja, data do cancelamento da cobrança.
updated_by	Indica o ID do usuário que realizou a alteração na cobrança, ou seja, quem procedeu com o cancelamento. Nos casos dos parceiros, será vinculado ao ID do token de autenticação.

Reason

Abaixo a lista de motivos aceitos para cancelamento de uma cobrança.
Este motivo é obrigatório para proceder com o cancelamento.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Valor	Descrição
CANCEL-BILLING-REASON-001	Baixado para acertos
CANCEL-BILLING-REASON-002	Baixado para devolução
CANCEL-BILLING-REASON-003	Baixado com pagamento direto ao cliente
CANCEL-BILLING-REASON-004	Baixado para substituição
CANCEL-BILLING-REASON-005	Baixado a pedido do cedente

","urlObject":{"path":["billings","cancel",":billing_id"],"host":["{{url_contbank}}"],"query":[],"variable":[{"description":{"content":"

ID da cobrança a ser cancelada.

\n","type":"text/plain"},"type":"any","value":null,"key":"billing_id"}]}},"response":[{"id":"ab9b0aa0-4951-4c8d-a4d2-a9260965acd4","name":"Create Billing - 200 OK","originalRequest":{"method":"POST","header":[{"key":"X-Current-Identity","value":"12345678901","type":"text","description":"CPF/CNPJ do usuário que está gerando a nova cobrança."}],"body":{"mode":"raw","raw":"{\n \"reason\" : \"Baixado com pagamento direto ao cliente\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{url_contbank}}/billings/cancel/:billing_id","host":["{{url_contbank}}"],"path":["billings","cancel",":billing_id"],"variable":[{"key":"billing_id","value":null,"description":"ID da cobrança a ser cancelada."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"_id\": \"6382dce123c71arrfa425a09\",\n \"billing_method\": \"BOLETO\",\n \"current_identity\": \"12345678901\",\n \"account\": {\n \"account_id\": \"6109864a1555f85450005e6e\",\n \"branch\": \"0001\",\n \"number\": \"123456\",\n \"identifier\": \"12345678901\"\n },\n \"payer\": {\n \"name\": \"NOME DO PAGADOR\",\n \"trade_name\": \"TRADE NAME DO PAGADOR\",\n \"identifier\": \"98798798789\",\n \"address\": {\n \"street\": \"RUA DA CONSOLAÇÃO, 1000 APTO ABC\",\n \"zip\": \"01301100\",\n \"city\": \"SÃO PAULO\",\n \"state\": \"SP\"\n },\n \"email\": \"teste@contbank.com\",\n \"phone\": {\n \"country_code\": \"55\",\n \"phone_number\": \"11999999999\"\n },\n \"notifications\": {\n \"send_email\": true,\n \"send_sms\": true\n }\n },\n \"due_date\": \"2023-02-01T00:00:00Z\",\n \"close_payment\": \"2023-04-02T00:00:00Z\",\n \"description\": \"EMISSÃO DE UMA COBRANÇA RECORRENTE\",\n \"amount\": 20,\n \"discounts\": {\n \"limit_date\": \"2023-01-31T23:59:59Z\",\n \"value\": 15,\n \"type\": \"FixedPercentUntilLimitDate\"\n },\n \"fine\": {\n \"start_date\": \"2023-02-02T00:00:00Z\",\n \"value\": 2,\n \"type\": \"Percent\"\n },\n \"interest\": {\n \"start_date\": \"2023-02-02T00:00:00Z\",\n \"value\": 1.75,\n \"type\": \"PercentPerMonth\"\n },\n \"status\": \"CANCELED\",\n \"status_history\": [\n {\n \"status\": \"NEW\",\n \"updated_at\": \"2022-11-27T03:43:33.467Z\",\n \"updated_by\": \"6079c518aa81769229db2da7\"\n },\n {\n \"status\": \"PENDING\",\n \"updated_at\": \"2022-11-27T03:43:48.732Z\",\n \"updated_by\": \"6079c518aa81769229db2da7\"\n },\n {\n \"status\": \"REGISTERED\",\n \"updated_at\": \"2022-11-27T03:44:09.263Z\",\n \"updated_by\": \"6079c518aa81769229db2da7\"\n }\n ],\n \"updated_at\": \"2022-11-27T03:45:08.433011878Z\",\n \"updated_by\": \"6079c518aa81769229db2da7\",\n \"created_at\": \"2022-11-27T03:43:33.467Z\",\n \"created_by\": \"6079c518aa81769229db2da7\",\n \"request_id\": \"5624bf84-7c2e-4a6e-8b88-13a992a83ea1\",\n \"billing_method_related\": {\n \"updated_at\": \"2022-11-27T03:43:48.732Z\",\n \"boleto_id\": \"6382dce5b1c9cd5b926e349e\",\n \"authentication_code\": \"9d97a92e-b10f-44c9-850e-10dfd6882890\"\n },\n \"installment\": 1,\n \"total_of_installments\": 4,\n \"partner\": {\n \"fee_rate\": 2.75,\n \"fee_value\": 5\n }\n}"},{"id":"33bd1a1a-2b92-49c4-b845-e54a6fe0c23f","name":"Create Billing - 400 Bad Request (Invalid Reason)","originalRequest":{"method":"POST","header":[{"key":"X-Current-Identity","value":"12345678901","type":"text","description":"CPF/CNPJ do usuário que está gerando a nova cobrança."}],"url":{"raw":"{{url_contbank}}/billings/cancel/:billing_id","host":["{{url_contbank}}"],"path":["billings","cancel",":billing_id"],"variable":[{"key":"billing_id","value":null,"description":"ID da cobrança a ser cancelada."}]}},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"code\": 422,\n \"key\": \"INVALID_PARAMETER\",\n \"messages\": [\n \"validation failed for amount\"\n ]\n}"},{"id":"c1fbe1fa-4369-4834-b5c9-a010e97637bd","name":"Create Billing - 403 Forbidden (Invalid X-Current-Identity)","originalRequest":{"method":"POST","header":[{"key":"X-Current-Identity","value":"000000","type":"text","description":"CPF/CNPJ do usuário que está gerando a nova cobrança."}],"body":{"mode":"raw","raw":"{\n \"reason\" : \"Baixado com pagamento direto ao cliente\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{url_contbank}}/billings/cancel/:billing_id","host":["{{url_contbank}}"],"path":["billings","cancel",":billing_id"],"variable":[{"key":"billing_id","value":null,"description":"ID da cobrança a ser cancelada."}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"580a0e8e-3219-4405-a829-5d2e1c89fe43","name":"Create Billing - 404 Not Found (Billing Not Found)","originalRequest":{"method":"POST","header":[{"key":"X-Current-Identity","value":"12345678901","type":"text","description":"CPF/CNPJ do usuário que está gerando a nova cobrança."}],"body":{"mode":"raw","raw":"{\n \"reason\" : \"Baixado com pagamento direto ao cliente\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{url_contbank}}/billings/cancel/:billing_id","host":["{{url_contbank}}"],"path":["billings","cancel",":billing_id"],"variable":[{"key":"billing_id","value":"00000000000","description":"ID da cobrança a ser cancelada."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"code\": 404,\n \"key\": \"NOT_FOUND\",\n \"messages\": [\n \"not found\"\n ]\n}"}],"_postman_id":"7c451f22-d479-4559-a7aa-10f84cd8a046"},{"name":"List Billings","id":"317a3428-f9aa-467e-937a-6c2809884d1e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{partner_token}}"},"isInherited":false},"method":"GET","header":[],"url":"https://api.contbank.com.br/s2s/billings/list/:account_id?page=1&per_page=10&start_date=2023-03-01T00:00:00Z&end_date=2023-03-31T23:59:59Z","description":"

Este endpoint permite a listagem de todas as cobranças geradas de uma conta em um determinado período de tempo, especificado por uma data inicial e final, bem como pelo número da conta.

A resposta retornada pelo endpoint inclui informações detalhadas sobre cada cobrança, incluindo a data de vencimento, o status atual, o valor total da cobrança e um resumo com os dados do boleto, incluindo o número do boleto, o valor, a data de emissão e a data de vencimento.

Response Schema

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Campo	Tipo	Descrição
total	integer	Total de cobranças retornadas
pages	integer	Total de páginas de cobranças retornadas
billings	array	Lista de objetos de cobrança
billings.id	string	Identificador único da cobrança
billings.request_id	string	Identificador da requisição que gerou a cobrança
billings.current_identity	string	Identificador da conta que gerou a cobrança
billings.account	object	Objeto com informações da conta relacionada
billings.account.account_id	string	Identificador único da conta
billings.account.branch	string	Número da agência da conta
billings.account.number	string	Número da conta
billings.account.identifier	string	CPF ou CNPJ do titular da conta
billings.billing_method	string	Método de cobrança utilizado
billings.payer	object	Objeto com informações do pagador
billings.payer.name	string	Nome do pagador
billings.payer.identifier	string	CPF ou CNPJ do pagador
billings.payer.address	object	Objeto com informações de endereço do pagador
billings.payer.address.street	string	Endereço do pagador
billings.payer.address.zip	string	CEP do endereço do pagador
billings.payer.address.city	string	Cidade do endereço do pagador
billings.payer.address.state	string	Estado do endereço do pagador
billings.payer.notifications	object	Objeto com informações sobre notificações
billings.payer.notifications.send_email	boolean	Indica se a notificação deve ser enviada por e-mail
billings.payer.notifications.send_sms	boolean	Indica se a notificação deve ser enviada por SMS
billings.payer.save_as_contact	boolean	Indica se o pagador deve ser salvo como contato
billings.due_date	string	Data de vencimento da cobrança
billings.close_payment	string	Indica a data limite que o pagamento é aceito. Após esta data, não é mais possível receber o pagamento da cobrança, sendo a mesma automaticamente cancelada.
billings.close_payment_days	integer	Indica a data limite para o pagamento da cobrnça em dias.
billings.description	string	Descrição da cobrança
billings.amount	number	Valor da cobrança
billings.status	string	Status atual da cobrança
billings.installment	integer	Número da parcela atual da cobrança
billings.total_of_installments	integer	Número total de parcelas da cobrança
billings.installment_scheduled_to	string	Data programada para a próxima parcela da cobrança
billings.recurring_id	string	Identificador único da recorrência
billings.boleto_detail	object	Objeto com informações do boleto associado à cobrança
billings.boleto_detail.boleto_id	string	Identificador único do boleto associado à cobrança
billings.boleto_detail.our_number	string	Nosso número
billings.boleto_detail.authentication_code	string	Código de autenticação único gerado para o boleto associado à cobrança
billings.boleto_detail.digitable_line	string	Linha digitavel do boleto associado à cobrança
billings.boleto_detail.duplicate_payment	boolean	Indica se o boleto foi pago mais de uma vez
billings.boleto_detail.payment_date	string	Indica a data de pagamento do boleto. Este campo é retornado apenas para as cobranças com o status PAID_OUT
billings.boleto_detail.download_url	string	URL para download do boleto associado à cobrança
billings.updated_at	string	Timestamp com a data da ultima atualização da cobrança
billings.created_at	string	Timestamp com a data de geração da cobrança
billings.extra_data	object	Objeto contendo informações adicionais
billings.extra_data.total_amount	number	Indica a soma do valor(amount) de todas as cobranças retornadas pela consulta.

","urlObject":{"protocol":"https","path":["s2s","billings","list",":account_id"],"host":["api","contbank","com","br"],"query":[{"description":{"content":"

integer | Página a consultar | obrigatório

\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"

integer | Qtde registros por página | obrigatório

\n","type":"text/plain"},"key":"per_page","value":"10"},{"description":{"content":"

timestamp | Data Inicial | obrigatório

\n","type":"text/plain"},"key":"start_date","value":"2023-03-01T00:00:00Z"},{"description":{"content":"

timestamp | Data Final | obrigatório

\n","type":"text/plain"},"key":"end_date","value":"2023-03-31T23:59:59Z"},{"disabled":true,"description":{"content":"

Busca as cobranças que possuem a ocorrencia da string informada. Pode ser realizado consulta por, dados do pagador, como nome, numero da conta, ou dados do emitente.

\n","type":"text/plain"},"key":"search","value":""}],"variable":[{"description":{"content":"

string | Identificador único da conta (account_id) | obrigatório

\n","type":"text/plain"},"type":"any","value":"6247364ff4a7bf9524d187e9","key":"account_id"}]}},"response":[{"id":"0abfbc92-d989-4e08-847f-4f6e31ddaa87","name":"List Billings Partners","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.contbank.com.br/s2s/billings/list/:account_id?page=1&per_page=10&start_date=2023-03-01T00:00:00Z&end_date=2023-03-31T23:59:59Z","protocol":"https","host":["api","contbank","com","br"],"path":["s2s","billings","list",":account_id"],"query":[{"key":"page","value":"1","description":"integer | obrigatório"},{"key":"per_page","value":"10","description":"integer | obrigatório"},{"key":"start_date","value":"2023-03-01T00:00:00Z","description":"timestamp | obrigatório"},{"key":"end_date","value":"2023-03-31T23:59:59Z","description":"timestamp | obrigatório"},{"key":"search","value":"Nome","description":"Busca as cobranças que possuem a ocorrencia da string informada. Pode ser realizada consultas, por dados do pagador, como nome, numero da conta, ou dados do emitente.","disabled":true}],"variable":[{"key":"account_id","value":"6247364ff4a7bf9524d147e5","description":"Número da conta | obrigatório"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 21 Mar 2023 12:50:46 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, Accept, X-Token, X-Current-Identity, *"},{"key":"Access-Control-Allow-Methods","value":"*"},{"key":"Access-Control-Allow-Origin","value":""},{"key":"Request-Id","value":"2936f9d0-422c-4475-9011-921a0e80901e"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"total\": 1,\n \"pages\": 1,\n \"billings\": [\n {\n \"id\": \"63f92d6f3c918e884c7efrf9\",\n \"request_id\": \"c4d07cb8-3c06-4266-9655-b02c284b9e5t\",\n \"current_identity\": \"99999999999\",\n \"account\": {\n \"account_id\": \"6247364ff4a7bf9524d259r5\",\n \"branch\": \"0001\",\n \"number\": \"999999\",\n \"identifier\": \"99999999999\"\n },\n \"billing_method\": \"BOLETO\",\n \"payer\": {\n \"name\": \"NOME PAGADOR\",\n \"identifier\": \"99999999999\",\n \"address\": {\n \"street\": \"ENDEREÇO PAGADOR, 999\",\n \"zip\": \"9999999\",\n \"city\": \"SÃO PAULO\",\n \"state\": \"SP\"\n },\n \"notifications\": {\n \"send_email\": false,\n \"send_sms\": false\n },\n \"save_as_contact\": false\n },\n \"due_date\": \"2023-03-28T00:00:00Z\",\n \"close_payment\": \"2023-05-27T00:00:00Z\",\n \"close_payment_days\": 60,\n \"description\": \"COBRANÇA 2/4\",\n \"amount\": 25,\n \"status\": \"A Receber\",\n \"installment\": 2,\n \"total_of_installments\": 4,\n \"installment_scheduled_to\": \"2023-03-13T00:00:00Z\",\n \"recurring_id\": \"7f44648c-edad-434f-a9b0-68ab9815df87\",\n \"boleto_detail\": {\n \"boleto_id\": \"640ec54d7f917136fe08e11f\",\n \"our_number\": \"99999999999\",\n \"authentication_code\": \"eebd1b97-24ed-4654-a9d1-f032dGH48a78\",\n \"digitable_line\": \"33290001151275615888249002570106193030000002500\",\n \"duplicate_payment\": false,\n \"download_url\": \"https://s3.us-west-2.amazonaws.com/storage.contbank/257010/eebd1b97-24ed-4654-a9d1-f032dGH48a78.pdf\"\n },\n \"updated_at\": \"2023-03-13T06:41:05.84Z\",\n \"created_at\": \"2023-02-24T21:34:39.347Z\"\n }\n ],\n \"extra_data\": {\n \"total_amount\": 25\n }\n}"},{"id":"4276f1c5-c481-4500-86bf-c8500506cb62","name":"Status Recebido","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.contbank.com.br/s2s/billings/list/:account_id?page=1&per_page=10&start_date=2023-03-01T00:00:00Z&end_date=2023-03-31T23:59:59Z","protocol":"https","host":["api","contbank","com","br"],"path":["s2s","billings","list",":account_id"],"query":[{"key":"page","value":"1","description":"integer | obrigatório"},{"key":"per_page","value":"10","description":"integer | obrigatório"},{"key":"start_date","value":"2023-03-01T00:00:00Z","description":"timestamp | obrigatório"},{"key":"end_date","value":"2023-03-31T23:59:59Z","description":"timestamp | obrigatório"},{"key":"search","value":"Nome","description":"Busca as cobranças que possuem a ocorrencia da string informada. Pode ser realizada consultas, por dados do pagador, como nome, numero da conta, ou dados do emitente.","disabled":true}],"variable":[{"key":"account_id","value":"6247364ff4a7bf9524d147e5","description":"Número da conta | obrigatório"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 21 Mar 2023 12:50:46 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, Accept, X-Token, X-Current-Identity, *"},{"key":"Access-Control-Allow-Methods","value":"*"},{"key":"Access-Control-Allow-Origin","value":""},{"key":"Request-Id","value":"2936f9d0-422c-4475-9011-921a0e80901e"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"6389ab19262886caf1019999\",\n \"request_id\": \"85e33120-5709-4b36-a0ac-808a01359999\",\n \"current_identity\": \"99999999999\",\n \"account\": {\n \"account_id\": \"6109864e1965f85451119999\",\n \"branch\": \"0001\",\n \"number\": \"999999\",\n \"identifier\": \"99999999999\"\n },\n \"billing_method\": \"BOLETO\",\n \"payer\": {\n \"name\": \"NOME DO PAGADOR\",\n \"trade_name\": \"TRADE NAME DO PAGADOR\",\n \"identifier\": \"99999999999\",\n \"address\": {\n \"street\": \"RUA DA CONSOLAÇÃO, 999 APTO XYZ\",\n \"zip\": \"9999999\",\n \"city\": \"SÃO PAULO\",\n \"state\": \"SP\"\n },\n \"email\": \"teste@contbank.com\",\n \"phone\": {\n \"country_code\": \"55\",\n \"phone_number\": \"99999999999\"\n },\n \"notifications\": {\n \"send_email\": true,\n \"send_sms\": true\n }\n },\n \"due_date\": \"2023-02-01T00:00:00Z\",\n \"close_payment\": \"2023-04-02T00:00:00Z\",\n \"description\": \"TESTE COBRANÇA RECORRENTE\",\n \"amount\": 5.09,\n \"discounts\": {\n \"limit_date\": \"2023-01-31T00:00:00Z\",\n \"value\": 10,\n \"type\": \"FixedPercentUntilLimitDate\"\n },\n \"fine\": {\n \"start_date\": \"2023-02-02T00:00:00Z\",\n \"value\": 2,\n \"type\": \"Percent\"\n },\n \"interest\": {\n \"start_date\": \"2023-02-02T00:00:00Z\",\n \"value\": 1.25,\n \"type\": \"PercentPerMonth\"\n },\n \"status\": \"Recebido\",\n \"status_reason\": \"BANKSLIP_PAID_OUT\",\n \"installment\": 1,\n \"total_of_installments\": 2,\n \"recurring_id\": \"b6f0663b-ec51-4e8f-9fb4-565d48799999\",\n \"boleto_detail\": {\n \"boleto_id\": \"6389ab19eb9ad6b077b99999\",\n \"our_number\": \"99999999999\",\n \"authentication_code\": \"52c45957-8c10-451b-93df-47a93a348709\",\n \"digitable_line\": \"33290001151552618829571002078021892480000000999\",\n \"payment_date\": \"2023-03-02T07:38:43.265Z\",\n \"paid_amount\": 5.09,\n \"duplicate_payment\": false,\n \"download_url\": \"https://s3.us-west-2.amazonaws.com/storage.contbank/207802/9999999999.pdf\"\n },\n \"updated_at\": \"2022-12-20T23:01:52.758Z\",\n \"created_at\": \"2022-12-02T07:36:57.874Z\"\n }\n]"}],"_postman_id":"317a3428-f9aa-467e-937a-6c2809884d1e"},{"name":"Get Billing By ID","event":[{"listen":"test","script":{"id":"a84656d9-0788-4f86-b5e6-77bf1b8465ff","exec":["// var jsonData = JSON.parse(responseBody);","// postman.setEnvironmentVariable(\"boleto_id\", jsonData.id);"],"type":"text/javascript"}}],"id":"2c272ea9-abd8-4f82-ba4c-7cfb5f38b1a6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{partner_token}}"},"isInherited":false},"method":"GET","header":[{"key":"X-Current-Identity","value":"12345678901","type":"text","description":"

CPF/CNPJ do usuário que está consultando a cobrança. Ele deve ter permissão na conta que a gerou.

\n"}],"url":"{{url_contbank}}/s2s/billings/:billing_id","description":"

Endpoint para obter os dados de uma cobrança específica.

O ID da cobrança deve ser enviado como path param na URL.

O X-Current-Identity deve ser enviado no Header da requisição.

Response Schema

Campo	Tipo do Campo	Descrição do Campo
id	string	ID da cobrança.
billing_method	string	Método de cobrança.
current_identity	string	Identificador do emissor da cobrança.
account	object	Objeto contendo os detalhes da conta do emitente.
account.account_id	string	ID da conta.
account.branch	string	Agência da conta.
account.number	string	Número da conta.
account.identifier	string	Identificador da conta.
payer	object	Objeto contendo informações do pagador.
payer.name	string	Nome do pagador.
payer.identifier	string	Identificador do pagador.
payer.address.street	string	Rua do endereço do pagador.
payer.address.zip	string	CEP do endereço do pagador.
payer.address.city	string	Cidade do endereço do pagador.
payer.address.state	string	Estado do endereço do pagador.
payer.email	string	E-mail do pagador.
payerstatus.phone.country_code	string	Código do país do telefone do pagador.
payer.phone.phone_number	string	Número do telefone do pagador.
payer.notifications.send_email	boolean	Enviar e-mail de notificação para o pagador (true/false).
payer.notifications.send_sms	boolean	Enviar SMS de notificação para o pagador (true/false).
payer.save_as_contact	boolean	Salvar como contato do pagador (true/false).
due_date	string	Data de vencimento da cobrança.
close_payment	string	Data de fechamento do pagamento.
close_payment_days	integer	Dias para fechamento do pagamento.
description	string	Descrição da cobrança.
amount	number	Valor da cobrança.
discounts	object	Objeto contendo os detalhes do desconto.
discounts.limit_date	string	Data limite para desconto.
discounts.value	number	Valor do desconto.
discounts.type	string	Tipo de desconto (ex: PERCENT/CURRENCY).
discounts.interval_days	integer	Dias de intervalo para desconto.
fine	object	Objeto contendo os detalhes da multa.
fine.start_date	string	Data de início da multa.
fine.value	number	Valor da multa.
fine.type	string	Tipo de multa (ex: PERCENT/CURRENCY).
fine.interval_days	integer	Dias de intervalo para multa.
interest	object	Objeto contendo os detalhes dos juros.
interest.start_date	string	Data de início dos juros.
interest.value	number	Valor dos juros.
interest.type	string	Tipo de juros (ex: PERCENT/CURRENCY).
interest.interval_days	integer	Dias de intervalo para juros.
status	string	Status atual da cobrança.
status_reason	string	Campo opcional. Por vezes indica alguma outra informação em relação ao status atual. Exemplo : - BANKSLIP_LIMIT_REACHED : Limite operacional atingido. Neste caso, contate o setor comercial para maiores detalhes ou solicitação de aumento de cota de geração.
status_history	object	Array contendo o historico dos status da cobrança.
status_history.status	string	Status histórico da cobrança.
status_history.updated_at	string	Data de atualização do status histórico da cobrança.
status_history.updated_by	string	ID do usuário que atualizou o status histórico da cobrança.
updated_at	string	Data de atualização da cobrança.
updated_by	string	ID do usuário que atualizou a cobrança.
created_at	string	Data de criação da cobrança.
created_by	string	ID do usuário que criou a cobrança.
request_id	string	ID da requisição.
billing_method_related	object	Objeto contendo informações relacionadas ao método de cobrança.
billing_method_related.updated_at	timestamp	Data e hora da última atualização do método de cobrança.
billing_method_related.boleto_id	string	ID do boleto.
billing_method_related.authentication_code	string	Código de autenticação.
billing_method_related.barcode	string	Código de barras do boleto.
billing_method_related.digitable_line	string	Linha digitável do boleto.
billing_method_related.our_number	string	Nosso número do boleto.
billing_method_related.document	string	Documento relacionado ao boleto.
billing_method_related.pix_id	string	ID do pix.
billing_method_related.pix_encoded_value	string	Valor em decodificado base64 do PIX Copia e Cola. No campo billing_method_related.pix_copy_paste há o valor decodificado, se preferir.
billing_method_related.pix_encoded_file	string (data:image/png;base64)	Valor em base64 da imagem de extensão PNG. Refere-se ao PIX QRCode.
billing_method_related.pix_copy_paste	string	Valor em string do PIX Copia e Cola. Trata-se do campo billing_method_related.pix_encoded_value decodificado.
installment	integer	Número da parcela.
total_of_installments	integer	Total de parcelas.
recurring_id	string	ID do pagamento recorrente.
payments	array	Array contendo os dados relacionados ao pagamento da cobrança. Este objeto é retornado apenas quando o boleto possui o status PAID_OUT.
payments.id	string	ID da transação de pagamento.
payments.amount	number	Valor pago.
payments.channel	string	Nome do canal de pagamento.
payments.paid_out_date	timestamp	Data de pagamento da cobrança.

","urlObject":{"path":["s2s","billings",":billing_id"],"host":["{{url_contbank}}"],"query":[],"variable":[{"description":{"content":"

Id da cobrança gerada.

\n","type":"text/plain"},"type":"any","value":"{{billing_id}}","key":"billing_id"}]}},"response":[{"id":"1ad2aa09-17ab-4dea-a955-7dc5df994777","name":"Get Billing by ID","originalRequest":{"method":"GET","header":[{"key":"X-Current-Identity","value":"12345678901","type":"text","description":"CPF/CNPJ do usuário que está consultando a cobrança. Ele deve ter permissão na conta que a gerou."}],"url":{"raw":"{{url_contbank}}/billings/:billing_id","host":["{{url_contbank}}"],"path":["billings",":billing_id"],"variable":[{"key":"billing_id","value":"{{billing_id}}","description":"Id da cobrança gerada. Variavel de ambiente auto gerada na criação da cobrança na rota Create Billing."}]}},"code":202,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"_id\": \"63747b11f33f0e0c367fcbe1\",\n \"billing_method\": \"BOLETO\",\n \"current_identity\": \"12345678901\",\n \"account\": {\n \"account_id\": \"6100004e1965f85451115e6e\",\n \"branch\": \"0001\",\n \"number\": \"123456\",\n \"identifier\": \"12345678901\"\n },\n \"payer\": {\n \"name\": \"NOME DO PAGADOR DO BOLETO\",\n \"trade_name\": \"NOME DO PAGADOR DO BOLETO\",\n \"identifier\": \"99988877766\",\n \"address\": {\n \"street\": \"RUA DA CONSOLAÇÃO, 1000 APTO XYZ\",\n \"zip\": \"01301100\",\n \"city\": \"SÃO PAULO\",\n \"state\": \"SP\"\n },\n \"email\": \"email_da_notificacao@contbank.com\",\n \"phone\": {\n \"country_code\": \"55\",\n \"phone_number\": \"11999999999\"\n },\n \"notifications\": {\n \"send_email\": true,\n \"send_sms\": true\n }\n },\n \"due_date\": \"2023-02-01T00:00:00Z\",\n \"close_payment\": \"2023-04-02T00:00:00Z\",\n \"description\": \"DESCRIÇÃO DO BOLETO\",\n \"amount\": 20,\n \"discounts\": {\n \"limit_date\": \"2023-01-31T23:59:59Z\",\n \"value\": 15,\n \"type\": \"FixedPercentUntilLimitDate\"\n },\n \"fine\": {\n \"start_date\": \"2023-02-02T00:00:00Z\",\n \"value\": 2,\n \"type\": \"Percent\"\n },\n \"interest\": {\n \"start_date\": \"2023-02-02T00:00:00Z\",\n \"value\": 1.75,\n \"type\": \"PercentPerMonth\"\n },\n \"status\": \"REGISTERED\",\n \"status_history\": [\n {\n \"status\": \"NEW\",\n \"updated_at\": \"2022-11-16T05:56:24.753Z\",\n \"updated_by\": \"6079c518aa81769229db2da7\"\n },\n {\n \"status\": \"PENDING\",\n \"updated_at\": \"2022-11-16T05:56:24.837Z\",\n \"updated_by\": \"6079c518aa81769229db2da7\"\n }\n ],\n \"updated_at\": \"2022-11-16T05:57:10.493Z\",\n \"updated_by\": \"6079c518aa81769229db2da7\",\n \"created_at\": \"2022-11-16T05:56:24.753Z\",\n \"created_by\": \"6079c518aa81769229db2da7\",\n \"request_id\": \"26dc9ec6-db3e-4823-8621-e594c42abdab\",\n \"billing_method_related\": {\n \"updated_at\": \"2022-11-16T05:56:24.837Z\",\n \"boleto_id\": \"63747b88fbggae4d001519ff\"\n }\n}"}],"_postman_id":"2c272ea9-abd8-4f82-ba4c-7cfb5f38b1a6"},{"name":"[DEPRECATED] Get Billing by ID","event":[{"listen":"test","script":{"id":"a84656d9-0788-4f86-b5e6-77bf1b8465ff","exec":["// var jsonData = JSON.parse(responseBody);","// postman.setEnvironmentVariable(\"boleto_id\", jsonData.id);"],"type":"text/javascript"}}],"id":"70b50a77-e2c1-4f6d-befd-dbbf78af6364","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{partner_token}}"},"isInherited":false},"method":"GET","header":[{"key":"X-Current-Identity","value":"12345678901","type":"text","description":"

CPF/CNPJ do usuário que está consultando a cobrança. Ele deve ter permissão na conta que a gerou.

\n"}],"url":"{{url_contbank}}/billings/:billing_id","description":"

[Esta rota não é mais válida (DEPRECATED)]

Endpoint para obter os dados de uma cobrança específica.

O ID da cobrança deve ser enviado na URL.
O X-Current-Identity deve ser preenchido no Header da requisição.

Response Schema

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Campo	Descrição
current_identity	É o CPF/CNPJ do usuário que gerou a cobrança.
billing_method	Indica o tipo da cobrança.
Account.branch	Agência da conta que criou a cobrança.
Account.number	Número da conta de quem criou a cobrança.
amount	Valor da cobrança em Reais (BRL).
status	Pode ser \"PENDING\" (cobrança ainda sendo registrada), \"REGISTERED\" (cobrança já registrada e aguardando o pagamento), \"CANCELED\" (cobrança cancelada) ou \"SETTLED\" (cobrança paga/quitada).
due_date	Data de vencimento da cobrança. A data limite de pagamento de uma cobrança, por padrão, é de 60 dias após esta data de vencimento indicada.
description	Descrição da cobrança. Este valor será apresentado no PDF do Boleto.
payer	São os dados de quem está sendo cobrado, ou seja, do responsável pelo pagamento.
payer.trade_name	Campo opcional. Utilizado quando o pagador possui nome fantasia.
payer.email	Campo opcional. E-mail do pagador. Quando informado, enviaremos lembretes de vencimento e/ou confirmação do pagamento da cobrança.
payer.phone	Campo opcional. Telefone celular do pagador. Quando informado, enviaremos SMS ao número indicado, lembrando do vencimento e/ou confirmando o recebimento do pagamento da cobrança.
close_payment	Indica a data limite que o pagamento é aceito. Após esta data, não é mais possível receber o pagamento da cobrança, sendo a mesma automaticamente cancelada.
discount_rate	Percentual de desconto que será aplicado ao valor da cobrança quando ocorrer compensação até 1 (um) dia antes da data de vencimento.
fine_rate	Percentual referente a multa. Aplicado quando pago após o vencimento.
interest_rate	Percentual referente aos juros mensais. Aplicado quando pago após o vencimento.

","urlObject":{"path":["billings",":billing_id"],"host":["{{url_contbank}}"],"query":[],"variable":[{"description":{"content":"

Id da cobrança gerada.

\n","type":"text/plain"},"type":"any","value":"{{billing_id}}","key":"billing_id"}]}},"response":[{"id":"3bf43c11-da9d-4693-8cf6-cae8786e1c04","name":"Get Billing by ID","originalRequest":{"method":"GET","header":[{"key":"X-Current-Identity","value":"12345678901","type":"text","description":"CPF/CNPJ do usuário que está consultando a cobrança. Ele deve ter permissão na conta que a gerou."}],"url":{"raw":"{{url_contbank}}/billings/:billing_id","host":["{{url_contbank}}"],"path":["billings",":billing_id"],"variable":[{"key":"billing_id","value":"{{billing_id}}","description":"Id da cobrança gerada. Variavel de ambiente auto gerada na criação da cobrança na rota Create Billing."}]}},"code":202,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"_id\": \"63747b11f33f0e0c367fcbe1\",\n \"billing_method\": \"BOLETO\",\n \"current_identity\": \"12345678901\",\n \"account\": {\n \"account_id\": \"6100004e1965f85451115e6e\",\n \"branch\": \"0001\",\n \"number\": \"123456\",\n \"identifier\": \"12345678901\"\n },\n \"payer\": {\n \"name\": \"NOME DO PAGADOR DO BOLETO\",\n \"trade_name\": \"NOME DO PAGADOR DO BOLETO\",\n \"identifier\": \"99988877766\",\n \"address\": {\n \"street\": \"RUA DA CONSOLAÇÃO, 1000 APTO XYZ\",\n \"zip\": \"01301100\",\n \"city\": \"SÃO PAULO\",\n \"state\": \"SP\"\n },\n \"email\": \"email_da_notificacao@contbank.com\",\n \"phone\": {\n \"country_code\": \"55\",\n \"phone_number\": \"11999999999\"\n },\n \"notifications\": {\n \"send_email\": true,\n \"send_sms\": true\n }\n },\n \"due_date\": \"2023-02-01T00:00:00Z\",\n \"close_payment\": \"2023-04-02T00:00:00Z\",\n \"description\": \"DESCRIÇÃO DO BOLETO\",\n \"amount\": 20,\n \"discounts\": {\n \"limit_date\": \"2023-01-31T23:59:59Z\",\n \"value\": 15,\n \"type\": \"FixedPercentUntilLimitDate\"\n },\n \"fine\": {\n \"start_date\": \"2023-02-02T00:00:00Z\",\n \"value\": 2,\n \"type\": \"Percent\"\n },\n \"interest\": {\n \"start_date\": \"2023-02-02T00:00:00Z\",\n \"value\": 1.75,\n \"type\": \"PercentPerMonth\"\n },\n \"status\": \"REGISTERED\",\n \"status_history\": [\n {\n \"status\": \"NEW\",\n \"updated_at\": \"2022-11-16T05:56:24.753Z\",\n \"updated_by\": \"6079c518aa81769229db2da7\"\n },\n {\n \"status\": \"PENDING\",\n \"updated_at\": \"2022-11-16T05:56:24.837Z\",\n \"updated_by\": \"6079c518aa81769229db2da7\"\n }\n ],\n \"updated_at\": \"2022-11-16T05:57:10.493Z\",\n \"updated_by\": \"6079c518aa81769229db2da7\",\n \"created_at\": \"2022-11-16T05:56:24.753Z\",\n \"created_by\": \"6079c518aa81769229db2da7\",\n \"request_id\": \"26dc9ec6-db3e-4823-8621-e594c42abdab\",\n \"billing_method_related\": {\n \"updated_at\": \"2022-11-16T05:56:24.837Z\",\n \"boleto_id\": \"63747b88fbggae4d001519ff\"\n }\n}"}],"_postman_id":"70b50a77-e2c1-4f6d-befd-dbbf78af6364"},{"name":"Get PDF","id":"c04ddcbc-b334-4a68-ad18-c9f42f093c94","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{partner_token}}"},"isInherited":false},"method":"GET","header":[{"key":"X-Current-Identity","value":"99999999999999","description":"

CPF/CNPJ do cliente para o qual a cobrança foi gerada (REQUIRED)

\n"}],"url":"{{url_contbank}}/partner-bff/s2s/billings/:billing_id/download","description":"

Este endpoint faz uma solicitação HTTP GET para obter o arquivo PDF correspondente a um ID específico de cobrança. A solicitação não inclui um corpo de resposta JSON, a resposta devolverá o arquivo PDF para o ID da cobrança especificada.

Response Schema

\n\n\n\n\n\n\n\n\n\n\n\n\n

Header	Value
Content-Type	application/pdf

","urlObject":{"path":["partner-bff","s2s","billings",":billing_id","download"],"host":["{{url_contbank}}"],"query":[],"variable":[{"type":"any","value":"","key":"billing_id"}]}},"response":[],"_postman_id":"c04ddcbc-b334-4a68-ad18-c9f42f093c94"},{"name":"[DEPRECATED] Get PDF","event":[{"listen":"test","script":{"id":"a84656d9-0788-4f86-b5e6-77bf1b8465ff","exec":["// var jsonData = JSON.parse(responseBody);","// postman.setEnvironmentVariable(\"boleto_id\", jsonData.id);"],"type":"text/javascript"}}],"id":"de1c3b6b-1e5a-4d01-9c01-d96d981b5893","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{partner_token}}"},"isInherited":false},"method":"GET","header":[{"key":"X-Current-Identity","value":"12345678901","type":"text","description":"

CPF/CNPJ do usuário para o qual a cobrança foi gerada.

\n"}],"url":"{{url_contbank}}/s2s/billings/pdf/:billing_id","description":"

[Esta rota não é mais válida (DEPRECATED)]

Endpoint para fazer o download do boleto gerado na emissão da cobrança unica, ou recorrente.

O ID da cobrança deve ser enviado como path param na URL.

O X-Current-Identity deve ser enviado no Header da requisição.

Response Schema

\n\n\n\n\n\n\n\n\n\n\n\n\n

Header	Value
Content-Type	application/pdf

","urlObject":{"path":["s2s","billings","pdf",":billing_id"],"host":["{{url_contbank}}"],"query":[],"variable":[{"description":{"content":"

Id da cobrança gerada

\n","type":"text/plain"},"type":"any","value":"{{billing_id}}","key":"billing_id"}]}},"response":[],"_postman_id":"de1c3b6b-1e5a-4d01-9c01-d96d981b5893"}],"id":"6fe8996e-8c91-4440-91e2-4d17073b16ca","description":"

APIs de geração de cobranças por boleto ou por pix.

Cobrança única ou recorrente

Emita cobranças únicas ou recorrentes aos seus clientes.

A cobrança recorrente é gerada para 2 (dois) ou até 24 (vinte e quatro) meses e é sempre gerada em torno de 15 (quinze) dias antes da data de vencimento. O primeiro vencimento, por sua vez, é emitido de forma imediatada.

Você também consegue simular as datas de vencimentos futuras através de nossa API.

Multa / Juros / Desconto por Antecipação

Possibilitamos que você informe os percentuais a serem aplicados em caso de pagamento antecipado ou em casos de atrasos. Essa possibilidade se restringe a emissões de boletos, não se aplicando a emissões por PIX.

O percentual de desconto por antecipação é aplicado quando o pagamento ocorre até o dia do vencimento (D-1). Caso não seja informado ou seja informado 0 (zero), o desconto não é aplicado.
Exemplo : Se o boleto vence no dia 10/01/2027, o desconto somente será aplicado até o dia 09/01/2027.

O percentual de multa é aplicado apenas uma única vez e após a data de vencimento (D+1). Caso não seja informado ou seja informado 0 (zero), a multa não é aplicada.
Exemplo : Se o boleto vence no dia 10/01/2027, a multa será aplicada automaticamente a partir do dia 11/01/2027.

O percentual de juros é aplicado mensalmente a partir do dia seguinte ao vencimento. Caso não seja informado ou seja informado 0 (zero), os juros não serão aplicados.
Exemplo : Se o boleto vence no dia 10/01/2027,os juros serão aplicada mensalmente, de forma automática, a partir do dia 11/01/2027.

Notificações

Há a possibilidade de enviar alertas na geração do boleto, na data de vencimento e no dia em que recepcionarmos o pagamento. Desta forma o pagador fica ciente de todas as movimentações referente a cobrança gerada.

Incluir Dados do Pagador como Contato

Além disto, possibilitamos que o cadastro do cliente seja salvo automaticamente na listagem de contatos, facilitando quando alguma operação for realizada via aplicativo/tela.

\n","_postman_id":"6fe8996e-8c91-4440-91e2-4d17073b16ca"},{"name":"7. Webhooks","item":[{"name":"Create Configuration","id":"418c77ae-ee61-4145-bd01-a2d36ea1f54a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{partner_token}}"},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"context\": \"BILLINGS\",\r\n \"event_name\": \"CREATED\",\r\n \"url\": \"https://seudominio.com.br/suarota\",\r\n \"contingency_url\": \"https://seudominio.com.br/contingencia/suarota\",\r\n \"header_authorization\": [\r\n {\r\n \"key\": \"X-Token-Id\",\r\n \"value\": \"123456\"\r\n }\r\n ]\r\n}"},"url":"{{url_contbank}}/partner-bff/s2s/webhooks/configuration","description":"

Criar Configuração de Webhook

Esta funcionalidade permite criar uma nova configuração de webhook para um determinado contexto e evento. Ao criar uma configuração, é possível definir URLs de destino para notificações, incluindo uma URL de contingência para situações inesperadas. Além disso, é possível configurar cabeçalhos de autorização para garantir a segurança da comunicação.

Request Schema

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Campo	Descrição
context	Indica o segmento que o webhook será configurado. Use \"BILLINGS\" para receber eventos relacionados a boletos.
event_name	Define o tipo de evento para o qual o webhook será configurado. Opções disponíveis: \"CREATED\", \"UPDATED\", \"CANCELED\", \"PAID_OUT\".
url	URL de destino para receber as notificações.
contingency_url	URL de contingência para notificações em caso de falha na URL principal.
header_authorization	Cabeçalhos de autorização necessários para acesso à URL (opcional). (ex. [\"key\":\"X-token\", \"value\":\"valor da chave\"] )

Response Schema

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Campo	Descrição
id	ID único da configuração do webhook.
partner_id	ID do parceiro associado à configuração.
context	Indica o segmento que o webhook está configurado. Use \"BILLINGS\" para eventos relacionados a boletos.
event_name	Tipo de evento para o qual o webhook está configurado.
method	Método HTTP esperado para a notificação (ex: \"POST\").
url	URL de destino para receber as notificações.
contingency_url	URL de contingência para notificações em caso de falha na URL principal.
active	Indica se a configuração está ativa (`true`) ou não (`false`).
created_at	Data e hora de criação da configuração.
created_by	ID do usuário que criou a configuração.
updated_at	Data e hora da última atualização da configuração.
updated_by	ID do usuário responsável pela última atualização, se aplicável.
header_authorization	Cabeçalhos de autorização necessários para acesso à URL (opcional).
request_id	ID da requisição associada à configuração do webhook.

","urlObject":{"path":["partner-bff","s2s","webhooks","configuration"],"host":["{{url_contbank}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"418c77ae-ee61-4145-bd01-a2d36ea1f54a"},{"name":"Update Configuration","id":"f07e329b-0b39-46a2-815b-7b6cbc5e8a86","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{partner_token}}"},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"context\": \"BILLINGS\",\r\n \"event_name\": \"CREATED\",\r\n \"method\":\"POST\",\r\n \"url\": \"https://seudominio.com.br/suarotanova\",\r\n \"contingency_url\": \"https://seudominio.com.br/contigencia/suarotanova\",\r\n \"header_authorization\": [\r\n {\r\n \"key\": \"X-Client-ID\",\r\n \"value\": \"username123\"\r\n },\r\n {\r\n \"key\": \"X-Client-Secret\",\r\n \"value\": \"password123\"\r\n }\r\n ]\r\n}"},"url":"{{url_contbank}}/partner-bff/s2s/webhooks/configuration/:id","description":"

Atualizar Configuração de Webhook

Essa funcionalidade permite atualizar uma configuração de webhook existente com novos parâmetros, como URLs de destino e cabeçalhos de autorização. Para realizar essa operação, é necessário fornecer o ID da configuração que deseja atualizar.

Request Schema

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Campo	Descrição
context	Indica o segmento que o webhook será configurado. Use \"BILLINGS\" para receber eventos relacionados a boletos.
event_name	Define o tipo de evento para o qual o webhook será configurado. Opções disponíveis: \"CREATED\", \"UPDATED\", \"CANCELED\", \"PAID_OUT\".
method	Método HTTP esperado para a notificação (ex: \"POST\").
url	URL de destino para receber as notificações.
contingency_url	URL de contingência para notificações em caso de falha na URL principal.
header_authorization	Cabeçalhos de autorização necessários para acesso à URL (opcional). (ex. [\"key\":\"X-token\", \"value\":\"valor da chave\"] )

Response Schema

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Campo	Descrição
id	ID único da configuração do webhook.
partner_id	ID do parceiro associado à configuração.
context	Indica o segmento que o webhook está configurado. Use \"BILLINGS\" para eventos relacionados a boletos.
event_name	Tipo de evento para o qual o webhook está configurado.
method	Método HTTP esperado para a notificação (ex: \"POST\").
url	URL de destino para receber as notificações.
contingency_url	URL de contingência para notificações em caso de falha na URL principal.
active	Indica se a configuração está ativa (`true`) ou não (`false`).
created_at	Data e hora de criação da configuração.
created_by	ID do usuário que criou a configuração.
updated_at	Data e hora da última atualização da configuração.
updated_by	ID do usuário responsável pela última atualização, se aplicável.
header_authorization	Cabeçalhos de autorização necessários para acesso à URL (opcional).
request_id	ID da requisição associada à configuração do webhook.

","urlObject":{"path":["partner-bff","s2s","webhooks","configuration",":id"],"host":["{{url_contbank}}"],"query":[],"variable":[{"description":{"content":"

id da configuração

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"f07e329b-0b39-46a2-815b-7b6cbc5e8a86"},{"name":"Patch Configuration","id":"42b60532-489d-4658-8ecd-1d23b4c8f7fd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{partner_token}}"},"isInherited":false},"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"url\": \"https://seudominio.com.br/suarotanova\"\r\n}"},"url":"{{url_contbank}}/partner-bff/s2s/webhooks/configuration/:id","description":"

Atualização Parcial da Configuração de Webhook

Essa funcionalidade permite atualizar parcialmente uma configuração de webhook existente, possibilitando modificar campos específicos sem a necessidade de enviar todos os parâmetros novamente. Essa operação utiliza o método PATCH e requer o ID da configuração que deseja atualizar.

\n","urlObject":{"path":["partner-bff","s2s","webhooks","configuration",":id"],"host":["{{url_contbank}}"],"query":[],"variable":[{"description":{"content":"

id da configuração

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"42b60532-489d-4658-8ecd-1d23b4c8f7fd"},{"name":"Get By Configuration ID","id":"ac97101e-2b98-47df-9687-9057fb0f9f85","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{partner_token}}"},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{url_contbank}}/partner-bff/s2s/webhooks/configuration/:id","description":"

Obter Configuração de Webhook por ID

Esta funcionalidade permite recuperar os detalhes de uma configuração de webhook específica com base no seu ID único.

Response Schema

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Campo	Descrição
id	ID único da configuração do webhook.
partner_id	ID do parceiro associado à configuração.
context	Indica o segmento que o webhook está configurado. Use \"BILLINGS\" para eventos relacionados a boletos.
event_name	Tipo de evento para o qual o webhook está configurado.
method	Método HTTP esperado para a notificação (ex: \"POST\").
url	URL de destino para receber as notificações.
contingency_url	URL de contingência para notificações em caso de falha na URL principal.
active	Indica se a configuração está ativa (`true`) ou não (`false`).
created_at	Data e hora de criação da configuração.
created_by	ID do usuário que criou a configuração.
updated_at	Data e hora da última atualização da configuração.
updated_by	ID do usuário responsável pela última atualização, se aplicável.
header_authorization	Cabeçalhos de autorização necessários para acesso à URL (opcional).
request_id	ID da requisição associada à configuração do webhook.

","urlObject":{"path":["partner-bff","s2s","webhooks","configuration",":id"],"host":["{{url_contbank}}"],"query":[],"variable":[{"description":{"content":"

id da configuração

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"ac97101e-2b98-47df-9687-9057fb0f9f85"},{"name":"List Configuration","id":"78616d34-89ed-4830-8f9d-6158d1ca65f3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{partner_token}}"},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"context\": \"BILLINGS\"\r\n}"},"url":"{{url_contbank}}/partner-bff/s2s/webhooks/configuration?page=1&per_page=12","description":"

Listar Configurações de Webhooks

Esta funcionalidade permite listar as configurações de webhooks disponíveis, oferecendo opções de filtragem para encontrar configurações específicas com base em determinados critérios.

Parâmetros da Query (Opcionais):

page (Página desejada)
per_page (Número de resultados por página)

Request Schema - Filtros Disponíveis

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Campo	Descrição
context	Segmento para filtrar as configurações. Use \"BILLINGS\" para eventos relacionados a boletos.
event_name	Tipo de evento para filtrar as configurações.
url	URL de destino para filtrar as configurações.
contingency_url	URL de contingência para filtrar as configurações em caso de falha na URL principal.
active	Indica se a configuração está ativa (`true`) ou não (`false`).

Response Schema - Listagem de Configurações

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Campo	Descrição
total	Total de configurações disponíveis.
total_returned	Total de configurações retornadas nesta página.
per_page	Número máximo de configurações por página.
current_page	Página atual.
pages	Total de páginas disponíveis.
has_next_page	Indica se há mais páginas de configurações disponíveis (`true`) ou não (`false`).
configurations	Lista de configurações de webhooks retornadas.
configurations.id	ID único da configuração do webhook.
configurations.partner_id	ID do parceiro associado à configuração.
configurations.context	Indica o segmento que o webhook está configurado. Use \"BILLINGS\" para eventos relacionados a boletos.
configurations.event_name	Tipo de evento para o qual o webhook está configurado.
configurations.method	Método HTTP esperado para a notificação (ex: \"POST\").
configurations.url	URL de destino para receber as notificações.
configurations.contingency_url	URL de contingência para notificações em caso de falha na URL principal.
configurations.active	Indica se a configuração está ativa (`true`) ou não (`false`).
configurations.created_at	Data e hora de criação da configuração.
configurations.created_by	ID do usuário que criou a configuração.
configurations.updated_at	Data e hora da última atualização da configuração.
configurations.updated_by	ID do usuário responsável pela última atualização, se aplicável.
configurations.header_authorization	Cabeçalhos de autorização necessários para acesso à URL.
configurations.header_authorization.key	Chave de autorização necessária para acesso à URL.
configurations.header_authorization.value	Valor da chave de autorização para acesso à URL.

","urlObject":{"path":["partner-bff","s2s","webhooks","configuration"],"host":["{{url_contbank}}"],"query":[{"key":"page","value":"1"},{"key":"per_page","value":"12"}],"variable":[]}},"response":[],"_postman_id":"78616d34-89ed-4830-8f9d-6158d1ca65f3"}],"id":"a7f569d6-6cb0-4ac5-b0f2-33c96e246e52","description":"

A API de configuração de webhooks de parceiros oferece funcionalidades para configurar e gerenciar webhooks em um ambiente de parceiros. Com esta API, os parceiros podem criar configurações de webhooks para receber notificações específicas relacionadas à geração, atualização, cancelamento e liquidação de boletos.

Contextos Disponíveis:

\"BILLINGS\": Este contexto refere-se às operações relacionadas à geração e gestão de boletos.

Eventos Disponíveis:

\"CREATED\": Comunicação sobre a criação de um novo boleto.
\n
\"UPDATED\": Atualizações que ocorrem no boleto.
\n
\"CANCELED\": Notificação de cancelamento de um boleto.
\n
\"PAID_OUT\": Indicação de liquidação de um boleto.
\n

Observações Importantes:

Estes eventos se referem exclusivamente às ações geradas pela credencial do parceiro na plataforma.
\n
Após 48 horas de tentativas de entrega sem sucesso, as configurações que falharem serão automaticamente desativadas, como parte da política de gerenciamento de falhas.
\n

\n","_postman_id":"a7f569d6-6cb0-4ac5-b0f2-33c96e246e52"}]}