{"info":{"_postman_id":"9779cbf7-7d20-4357-934f-f877bbe4d8d1","name":"Canvi","description":"

Introdução

Bem-vindo à documentação oficial da API Gateway da Canvi.

Aqui você encontrará todas as informações necessárias para integrar sua plataforma às nossas soluções de pagamento — de forma rápida, segura e eficiente.

Com a Canvi, você pode automatizar cobranças, acompanhar transações em tempo real, configurar repasses financeiros e muito mais. Nossa infraestrutura foi pensada para oferecer controle total sobre seus recebimentos, simplificando a gestão financeira do seu negócio.

Visão Geral

A API da Canvi foi desenvolvida para proporcionar uma integração simples, segura e eficiente com o seu sistema, permitindo total controle sobre a gestão de pagamentos e operações financeiras de sua empresa. Confira abaixo as principais características que tornam nossa API uma escolha confiável para o seu negócio:

Padrão RestFul

Nossa API segue os princípios REST, com uma estrutura clara, intuitiva e compatível com as tecnologias mais utilizadas no mercado. Facilitando a implementação e reduzindo o tempo de desenvolvimento da sua equipe.

Meios de Pagamento

Oferecemos suporte aos principais meios de pagamento do mercado, incluindo:

PIX — dinâmico e estático.
\n
Boletos bancários.
\n
Cartões de débito, crédito e voucher — com suporte a diversas bandeiras nacionais e internacionais.
\n

Essa flexibilidade permite que seu negócio atenda diferentes perfis de clientes e amplie as opções de cobrança de forma eficiente.

Ambiente Sandbox

Antes de entrar em produção, você pode utilizar nosso ambiente Sandbox para realizar testes e simulações com segurança. Isso permite validar integrações e fluxos de pagamento sem impacto sobre dados reais ou operações financeiras.

Webhooks

Mantenha seu sistema sempre atualizado com notificações em tempo real.

Nossos webhooks informam automaticamente eventos importantes, como confirmações de pagamento, envio de saldo e atualizações de status nas cobranças.

Simulação de Pagamentos

Para facilitar o processo de desenvolvimento e homologação, oferecemos a funcionalidade de simulação de pagamentos, permitindo testar diferentes cenários de cobrança com agilidade — evitando a necessidade de transações financeiras reais.

Estrutura da Resposta

Todas as requisições aos nossos endpoints retornam uma estrutura padrão de resposta, facilitando o tratamento de erros e respostas dentro da sua aplicação:

{\n    \"code\": \"string\",\n    \"mensagem\": \"string\",\n    \"data\": \"any\"\n}\n\n

Data e Hora

Todos os registros de data e hora utilizados na API da Canvi seguem o fuso horário oficial de Manaus (UTC-4) e são formatados de acordo com o padrão ISO 8601.

Ex: 2025-05-20T14:30:00

URLs Base

Sandbox: https://gateway-homol.service-canvi.com.br
Produção: Sob demanda.

Primeiros Passos

Ao integrar sua plataforma com a API Canvi, você terá acesso a um conjunto completo de endpoints para geração de cobranças, controle de repasses, gestão de usuários e muito mais.

Para iniciar o processo de integração:

Ainda não é cliente Canvi? faça seu pré-cadastro a qui.
\n
Nossa equipe entrará em contato para informar as credenciais de homologação.
\n
Acesse o ambiente Sandbox e realize sua autenticação.
\n

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Introdução","slug":"introducao"},{"content":"Visão Geral","slug":"visao-geral"},{"content":"Estrutura da Resposta","slug":"estrutura-da-resposta"},{"content":"Data e Hora","slug":"data-e-hora"},{"content":"URLs Base","slug":"urls-base"},{"content":"Primeiros Passos","slug":"primeiros-passos"}],"owner":"34606726","collectionId":"9779cbf7-7d20-4357-934f-f877bbe4d8d1","publishedId":"2sB34hFfDH","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2025-07-14T13:18:18.000Z"},"item":[{"name":"Autenticação","item":[{"name":"Gerar Token","id":"c0a7bf0a-d98d-4469-aa64-5ccf5967d4b1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"client_id\": \"SEU_ID_DE_CLIENTE_AQUI\",\r\n \"private_key\": \"SUA_CHAVE_SECRETA_AQUI\"\r\n}","options":{"raw":{"language":"json"}}},"url":"/bt/token","description":"

Descrição

Esta rota permite realizar a autenticação inicial com a API da Canvi, utilizando as credenciais fornecidas durante o processo de integração.

Ao autenticar-se com sucesso, você receberá um token JWT que deverá ser enviado no cabeçalho das requisições futuras para acessar os recursos protegidos da API.

⚠️ Os campos obrigatórios estão sinalizados com ( * )

Corpo da Requisição

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

Campo	Tipo	Descrição
client_id*	string	Identificador único da credencial Canvi
private_key*	string	Chave secreta vinculada ao client_id

Respostas

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

HTTP Status	Descrição
200	Autenticação realizada com sucesso.
401	Credenciais inválidas ou expiradas.

","urlObject":{"path":["bt","token"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"dac3bdf0-39c8-4a1e-8e3a-071cd8004e21","name":"Sucesso","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"client_id\": \"SEU_ID_DE_CLIENTE_AQUI\",\r\n \"private_key\": \"SUA_CHAVE_SECRETA_AQUI\"\r\n}","options":{"raw":{"language":"json"}}},"url":"/bt/token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"authorization","value":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzaWQiOiJlZTExM2Q3Mi02NDNmLTRmZjAtYjJjNi1jZmRjMmU3MjFlZjEiLCJleHAiOjE3MjQyNTMyODksImlhdCI6MTcyMzY0ODQ4OX0.zZi0xvi-vw-6wNgfKKp6V-2Ia3XSa-nyjXvSwTDxMIk"},{"key":"vary","value":"origin,accept-encoding"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"set-cookie","value":"token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzaWQiOiJlZTExM2Q3Mi02NDNmLTRmZjAtYjJjNi1jZmRjMmU3MjFlZjEiLCJleHAiOjE3MjQyNTMyODksImlhdCI6MTcyMzY0ODQ4OX0.zZi0xvi-vw-6wNgfKKp6V-2Ia3XSa-nyjXvSwTDxMIk; Max-Age=31536000; Expires=Thu, 14 Aug 2025 15:14:49 GMT; HttpOnly; SameSite=Strict; Path=/"},{"key":"cache-control","value":"no-cache"},{"key":"content-encoding","value":"gzip"},{"key":"Date","value":"Wed, 14 Aug 2024 15:14:49 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"mensagem\": \"Logado com sucesso!\",\n \"token\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzaWQiOiJlZTExM2Q3Mi02NDNmLTRmZjAtYjJjNi1jZmRjMmU3MjFlZjEiLCJleHAiOjE3MjQyNTMyODksImlhdCI6MTcyMzY0ODQ4OX0.zZi0xvi-vw-6wNgfKKp6V-2Ia3XSa-nyjXvSwTDxMIk\"\n}"},{"id":"6bd61c4c-f252-44ce-ba19-9af03397c3bf","name":"Erro","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"client_id\": \"SEU_ID_DE_CLIENTE_AQUI\",\r\n \"private_key\": \"SUA_CHAVE_SECRETA_AQUI\"\r\n}","options":{"raw":{"language":"json"}}},"url":"/bt/token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"vary","value":"origin,accept-encoding"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"set-cookie","value":"token=; Max-Age=31536000; Expires=Sat, 29 Nov 2025 20:51:52 GMT; HttpOnly; SameSite=Strict; Path=/"},{"key":"cache-control","value":"no-cache"},{"key":"content-encoding","value":"gzip"},{"key":"Date","value":"Fri, 29 Nov 2024 20:51:52 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 401,\n \"mensagem\": \"Credencial não encontrada!\"\n}"}],"_postman_id":"c0a7bf0a-d98d-4469-aa64-5ccf5967d4b1"}],"id":"1e5f1219-e2f2-4073-93ac-336e9dac4a3a","description":"

Com as credenciais em mãos, você já pode iniciar a integração do seu sistema com a API da Canvi!

A autenticação é baseada em JWT (JSON Web Token). Após a validação bem-sucedida das suas credenciais, você receberá um token de acesso, que deverá ser incluído no cabeçalho (Authorization: Bearer SEU_TOKEN_AQUI ) de todas as requisições subsequentes à nossa API.

Detalhes importantes:

O token JWT possui validade de 7 dias. Recomendamos que sua aplicação renove o token antes do vencimento para evitar falhas de autenticação.
\n
A geração de um novo token invalida o anterior, encerrando a sessão ativa.
\n

\n
Certifique-se de armazenar o token de forma segura e atualizar seu sistema automaticamente sempre que uma nova autenticação for realizada.
\n

O diagrama a seguir detalha o fluxo completo de autenticação.

\n $\"Fluxo%20de%20autenticação\"$ \n\n

Boas Práticas

Para acessar os recursos protegidos da API, é necessário obter um token de autenticação válido por meio do endpoint de login. A seguir, destacamos boas práticas essenciais para o uso correto e seguro desse token, com foco na performance, estabilidade e segurança da integração:

✅ Armazene e reutilize seu token

Evite gerar um novo token a cada requisição. Recomendamos que, após a autenticação inicial, sua aplicação armazene o token com segurança (por exemplo, em memória, cache, banco de dados seguro ou vault) e o reutilize enquanto estiver válido.

⚠️ Gerar um novo token a cada requisição é uma prática não recomendada, pois:

Aumenta a carga desnecessária no servidor de autenticação;
\n
Atrasa o processo do lado do cliente, pois adiciona uma camada extra de requisição a cada consulta.
\n
Introduz risco de conflitos e invalidação: um novo token revoga imediatamente o anterior;
\n
Pode causar erros inesperados se múltiplas instâncias do seu sistema estiverem compartilhando a mesma credencial sem sincronização.
\n

⏳ Validade do Token

Os tokens gerados possuem validade de 7 dias (168 horas). Esse tempo é suficiente para a maioria dos cenários de uso contínuo, permitindo que você implemente estratégias eficientes de revalidação.

Exemplo de boas práticas:

Verifique a validade do token antes de cada uso;
\n
Renove o token apenas se ele estiver expirado ou prestes a expirar;
\n
Implemente um middleware ou interceptor que cuide dessa lógica de forma transparente para sua aplicação.
\n

🔒 Segurança

Nunca exponha o token em clientes públicos (ex: front-end);
\n
Utilize sempre conexões HTTPS;
\n
Considere criptografar o armazenamento local do token se sua aplicação for distribuída.
\n

\n","_postman_id":"1e5f1219-e2f2-4073-93ac-336e9dac4a3a"},{"name":"Baas","item":[{"name":"Cobranças","item":[{"name":"Pix Estático","item":[{"name":"Gerar Pix","id":"1a42f7e3-38e0-498b-b59f-1a2bf15ef105","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{}},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"valor\": \"10000\",\r\n \"tipo_transacao\": \"pixStaticCashin\",\r\n \"descricao\": \"Descrição da cobrança...\",\r\n \"texto_instrucao\": \"Instruções adicionais...\",\r\n \"identificador_externo\": \"cf075187-c34a-4ffd-898c-84f3ed4e978d\",\r\n \"identificador_movimento\": \"5f4023ed-58da-48f4-a866-c6218a35ad32\",\r\n \"enviar_qr_code\": true,\r\n \"tag\": [\r\n \"mensalidade\",\r\n \"produto-xyz\"\r\n ],\r\n \"cliente\": {\r\n \"nome\": \"Sabrina Cardoso\",\r\n \"tipo_documento\": \"cpf\",\r\n \"numero_documento\": \"838.979.530-21\",\r\n \"e-mail\": \"sabrina.cardoso@email.com.br\"\r\n },\r\n \"split\": [\r\n {\r\n \"tipo\": \"percentual\",\r\n \"valor\": \"0.80\",\r\n \"conta\": \"89392367-30d4-11f0-a96f-42010a400013\"\r\n },\r\n {\r\n \"tipo\": \"valor\",\r\n \"valor\": \"0.45\",\r\n \"conta\": \"89392367-30d4-11f0-a96f-42010a400013\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"/bt/pix","description":"

Descrição

Esta rota permite a criação de cobranças do tipo Pix Estático, gerando um QR Code fixo e reutilizável com os dados da transação.

⚠️ Os campos obrigatórios estão sinalizados com ( * )

Corpo da Requisiçã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\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Campo	Tipo	Descrição
valor*	string / number	Valor da cobrança a ser gerada
tipo_transacao*	string	`pixStaticCashin` ou `pixStaticCashinSemStatus`
descricao*	string	Breve descrição que aparece no layout da cobrança, aceita até 255 caracteres
texto_instrucao*	string	Instruções adicionais relacionadas à cobrança. Máximo de 1000 caracteres
identificador_externo*	string	Identificador principal e único da cobrança
identificador_movimento*	string	Identificador secundário da cobrança
enviar_qr_code	boolean	Define se o QR Code deve ser incluído na resposta da requisição. Por padrão é `true`
tag	string[ ]	Lista de etiquetas para categorização ou filtragem da cobrança. Cada item deve conter no máximo 100 caracteres

Cliente

Embora cobranças do tipo Pix Estático possam ser pagas por diferentes clientes e receber múltiplos pagamentos, é possível sim associar a cobrança a um devedor específico informando os dados abaixo.

\n

⚠️ Este campo é opcional, mas todos os subcampos se tornam obrigatórios quando informado.

\n\n\n\n\n\n\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
nome*	string	Nome completo do devedor.
tipo_documento*	string	Define o tipo de documento a ser informado: `cpf` ou `cnpj`
documento*	string	Numero de documento do cliente. Deve seguir o seguinte modelo: • CPF: `XXX.XXX.XXX-XX` • CNPJ: `XX.XXX.XXX/XXXX-XX`
e-mail*	string	E-mail válido do cliente.

Split

O split tem como finalidade dividir o valor da cobrança entre diferentes contas Canvi, podendo ser feito por valor fixo ou percentual do valor total (ou ambos). O uso do split é opcional, mas quando utilizado, todos os campos do objeto são obrigatórios.

\n\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
conta*	string	Identificador da conta Canvi que irá receber a parte do valor
tipo*	string	Define o tipo de divisão: • valor: valor fixo. • percentual: porcentagem do valor total da cobrança
valor*	string	Valor da divisão, conforme o tipo escolhido: • Se tipo for valor, o valor informado não pode ultrapassar o total da cobrança. • Se tipo for percentual, deve ser um número entre 0.01% e 100.00%

Informações relevantes

📌 Como informar corretamente valores monetários

Para gerar cobranças via Pix, o valor deve ser informado em centavos, sem casas decimais. Por exemplo: Para uma cobrança de R$ 100,00, envie o valor como 10000.

\n
No caso de Pix Estático, o valor informado pode ser igual ou maior que zero. Enviar 0 permite que o pagador defina o valor da transação livremente no momento do pagamento.
\n

✨ Diferença entre `pixStaticCashin` e `pixStaticCashinSemStatus`

Esses dois tipos de transação definem se você deseja ou não receber notificações em tempo real via Webhook sempre que um pagamento for realizado.

pixStaticCashin: A cada pagamento recebido, a Canvi envia automaticamente uma notificação para a URL de Webhook previamente configurada, contendo os dados completos da transação.
\n
pixStaticCashinSemStatus: Os pagamentos são registrados normalmente no sistema da Canvi, mas nenhuma notificação é enviada ao seu sistema. Nesse caso, é necessário consultar manualmente ou periodicamente a API para obter os dados.
\n

ℹ️ Sobre os campos `identificador_externo` e `identificador_movimento`

Ambos os campos têm como objetivo facilitar o gerenciamento interno das cobranças, permitindo relacioná-las a informações do seu sistema.

O campo identificador_externo é o identificador principal e único de cada cobrança. Ele deve ser exclusivo por transação e serve como referência direta para consultas, atualizações ou controle individual.
\n
Já o campo identificador_movimento pode ser reutilizado em várias cobranças e funciona como um agrupador. Ele permite associar múltiplas transações a um mesmo contexto, como um cliente, um lote, uma movimentação financeira ou uma série de cobranças referentes ao mesmo produto ou serviço.
\n

\n","urlObject":{"path":["bt","pix"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"fa6e9e45-c1c3-4947-880a-da323c10835d","name":"Sucesso","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"valor\": \"10000\",\r\n \"descricao\": \"Cobrança de Teste\",\r\n \"tipo_transacao\": \"pixStaticCashin\",\r\n \"texto_instrucao\": \"Instruções\",\r\n \"identificador_externo\": \"bf5a8ad7-40c3-4f30-afb2-32782f6f6bd2\",\r\n \"identificador_movimento\": \"021b8cea-b6cc-4dd9-a24d-f1ecfca160c1\",\r\n \"enviar_qr_code\": true,\r\n \"tag\": [\r\n \"tag1\",\r\n \"tag2\"\r\n ],\r\n \"cliente\": {\r\n \"nome\": \"João de Souza\",\r\n \"tipo_documento\": \"cpf\",\r\n \"numero_documento\": \"123.456.789-00\",\r\n \"e-mail\": \"joao.souza@email.com.br\"\r\n },\r\n \"split\": [\r\n {\r\n \"tipo\": \"percentual\",\r\n \"valor\": \"0.70\",\r\n \"conta\": \"89392367-30d4-11f0-a96f-42010a400013\"\r\n },\r\n {\r\n \"tipo\": \"valor\",\r\n \"valor\": \"0.40\",\r\n \"conta\": \"89392367-30d4-11f0-a96f-42010a400013\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"/bt/pix"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 27 Jun 2025 20:32:06 GMT"},{"key":"Server","value":"Apache/2.4.58 (Ubuntu)"},{"key":"vary","value":"origin,accept-encoding"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"cache-control","value":"no-cache"},{"key":"content-encoding","value":"gzip"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"mensagem\": \"Pix Estático Gerado\",\n \"data\": {\n \"id_invoice_pix_documento\": 731,\n \"valor\": \"100.00\",\n \"id_cobrador\": \"12345678901\",\n \"nome_cobrador\": \"NOME_DA_SUA_EMPRESA\",\n \"brcode\": \"00020126790014BR.GOV.BCB.PIX0136868317c2-53c2-4a56-xaa8-f1566a2fd49f0217Cobranca de Teste5204000053039865406100.005802BR5911Trocados 016009SAO PAULO62290525CSC00000000000000000004116304YFG2\",\n \"criacao\": \"2025-06-27T16:32:04.100+00:00\",\n \"qrcode\": \"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAPoAAAD6AQAAAACgl2eQAAACu0lEQVR4Xu2WQXIcIRAE4SPw/1/4KfARcGYjeXfnoPBB06dB8sYspCNK8VXNlP3z+lOuO5f1AGc9wFkPcNb/AaOUukede7U+Vyt9lT5jMw+Y/M7ROHUbpk5x9/OA768obK0KfTOpAFWyOOjcPA0E5wOqVFq1om2z/1OeB/ALoVvqVqVnbiYC+nNe19XV1/NfBlxoxCvomqP7XYGuLGAUjNrskoZtkuaoSWYBEZg6Pm5V3MA6rRvmRMBN9Dk/Og+b5GrgD9PeDWyzuvqKj+YU49kgZwLT3hRnBk1rxV6VE6E8gJvE4UlxuhNMz3RrlQgMGhPj0zJBxjjxMxFwo1VF+Q/XeHJp1t3AFGFuMD/pGlp9mG8iMwBEdgc5UsdpG80ar2YlTEdVqKRMXxNMJhEgJl2lAnZJmXy8/RUJQJTK8JaYZdg3rpa3bt4ODG8RW2R443rjSzU7iQAmQZUzPIrUrZk7iUD0qVkgjDujdRyeDKcB7hIbOlVjfER4/W95AN+3Y8zwWiFbFrIzAZoVTfJSw7ur+nDp5u0AhuVAz3AwIrahOg/QqsVioY1LpUbv/EkE0BM1MrwQ4V9D1BOB7QA/LlleJlgW65LhRABVlofuaJU5fMnhayqwnJyKpWKeLd/3DHAi4BoOMJvWDO+0Zq/wJgAeYhHDu7xK4m711TcT0KHo62Eczi2WN2wisGLD8BaDo11lPrp5NxAE1XKWBde18TZKaQCJ9byjyvAqs8UMyQRwSQ9iOT/1yleA8wCmtscx0z01vEx3+pYHuBTXN471LtE/+iYRGCqqStWp+GU6wcarWQnAdIRql2lyoZW438KbAaiJVz3Cy6mq5d7CmwVM06LeHeOUvVezsgCFaVdatLxV91lpgIytoVleredtp3x282ZAj8wTXm959kcgNRH4aT3AWQ9w1gOc9QvAX353SWU7teELAAAAAElFTkSuQmCC\",\n \"tx_id\": \"CSC0000000000000000000731\"\n }\n}"},{"id":"d811ffad-1e6c-4231-9f7b-67958bd9d3fc","name":"Conta para split não encontrada","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"valor\": \"10000\",\r\n \"descricao\": \"Cobrança de Teste\",\r\n \"tipo_transacao\": \"pixStaticCashin\",\r\n \"texto_instrucao\": \"Instruções\",\r\n \"identificador_externo\": \"2e827fb1-80f3-40b0-ace6-f1e8104a755f\",\r\n \"identificador_movimento\": \"da7ef958-09dd-41f9-86df-186c90007977\",\r\n \"enviar_qr_code\": true,\r\n \"tag\": [\r\n \"tag1\",\r\n \"tag2\"\r\n ],\r\n \"split\": [\r\n {\r\n \"tipo\": \"percentual\",\r\n \"valor\": \"0.70\",\r\n \"conta\": \"89392367-30d4-11f0-a96f-42010a400014\"\r\n },\r\n {\r\n \"tipo\": \"valor\",\r\n \"valor\": \"0.40\",\r\n \"conta\": \"89392367-30d4-11f0-a96f-42010a400014\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"/bt/pix"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 30 Jun 2025 14:53:43 GMT"},{"key":"Server","value":"Apache/2.4.58 (Ubuntu)"},{"key":"vary","value":"origin,accept-encoding"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"cache-control","value":"no-cache"},{"key":"content-encoding","value":"gzip"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 400,\n \"mensagem\": \"Erro ao gerar a cobrança.\",\n \"erros\": [\n \"a conta para split 89392367-30d4-11f0-a96f-42010a400014 não foi encontrada\",\n \"a conta para split 89392367-30d4-11f0-a96f-42010a400014 não foi encontrada\"\n ]\n}"}],"_postman_id":"1a42f7e3-38e0-498b-b59f-1a2bf15ef105"},{"name":"Consultar Pix Documento","id":"6cd0eeb1-2299-4a21-99a9-175d361dd0cb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"id_documento\": \"731\"\r\n}","options":{"raw":{"language":"json"}}},"url":"/bt/pix/estatico/documento","description":"

Descrição

Esta rota permite consultar os dados de uma cobrança do tipo Pix Estático a partir do seu ID do documento.

Corpo da Requisição

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

Campo	Tipo	Descrição
id_documento	string / number	id da cobrança, retornado no corpo da resposta de criação da cobrança.

","urlObject":{"path":["bt","pix","estatico","documento"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"284a768c-f68c-4e16-be67-a13180653170","name":"Sucesso","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"id_documento\": 731\r\n}","options":{"raw":{"language":"json"}}},"url":"/bt/pix/estatico/documento"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 30 Jun 2025 14:13:03 GMT"},{"key":"Server","value":"Apache/2.4.58 (Ubuntu)"},{"key":"vary","value":"origin,accept-encoding"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"cache-control","value":"no-cache"},{"key":"content-encoding","value":"gzip"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"mensagem\": \"Dados do Pix\",\n \"data\": {\n \"id_documento\": 731,\n \"valor\": \"100.00\",\n \"id_cobrador\": \"12345678901\",\n \"nome_cobrador\": \"NOME_DA_SUA_EMPRESA\",\n \"texto_instrucao\": \"Instruções\",\n \"descricao\": \"Cobrança de Teste\",\n \"brcode\": \"00020126790014BR.GOV.BCB.PIX0136868317c2-53c2-4a56-xaa8-f1566a2fd49f0217Cobranca de Teste5204000053039865406100.005802BR5911Trocados 016009SAO PAULO62290525CSC00000000000000000004116304YFG2\",\n \"ativo\": 1,\n \"criacao\": \"2025-06-27 16:32:04\",\n \"qrcode\": {\n \"type\": \"Buffer\",\n \"data\": [\n 100,\n 97,\n 116\n // ...997 itens\n ]\n }\n }\n}"},{"id":"824f9de8-287f-4e0c-9d9b-03581644a283","name":"Não Encontrado","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"id_documento\": 729\r\n}","options":{"raw":{"language":"json"}}},"url":"/bt/pix/estatico/documento"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 30 Jun 2025 14:40:53 GMT"},{"key":"Server","value":"Apache/2.4.58 (Ubuntu)"},{"key":"vary","value":"origin,accept-encoding"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"cache-control","value":"no-cache"},{"key":"content-encoding","value":"gzip"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 400,\n \"mensagem\": \"Invoice não encontrado\",\n \"data\": \"\"\n}"}],"_postman_id":"6cd0eeb1-2299-4a21-99a9-175d361dd0cb"},{"name":"Listar Pix Estáticos","id":"d0d830fe-f876-41d4-ad46-65f435acd059","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"data_inicial\": \"2025-06-01\",\r\n \"data_final\": \"2025-07-30\"\r\n}","options":{"raw":{"language":"json"}}},"url":"/bt/pix/estatico/lista","description":"

Descrição

Retorna uma lista detalhada das cobranças do tipo Pix Estático registradas dentro do período de tempo especificado no corpo da requisição.

Corpo da Requisição

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

Campo	Tipo	Descrição
data_inicial	date	Data inicial do filtro busca da cobrança
data_final	date	Data final do filtro de busca

","urlObject":{"path":["bt","pix","estatico","lista"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"676c0e7d-97cf-48ac-8ec8-b0f246a756fe","name":"Sucesso","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"data_inicial\": \"2025-06-01\",\r\n \"data_final\": \"2025-07-30\"\r\n}","options":{"raw":{"language":"json"}}},"url":"/bt/pix/estatico/lista"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 02 Jul 2025 21:49:04 GMT"},{"key":"Server","value":"Apache/2.4.58 (Ubuntu)"},{"key":"vary","value":"origin,accept-encoding"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"cache-control","value":"no-cache"},{"key":"content-encoding","value":"gzip"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"mensagem\": \"Consulta PIX\",\n \"data\": [\n {\n \"sigla\": \"pixEstatico\",\n \"nome_servico\": \"PIX ESTÁTICO\",\n \"id\": 270,\n \"id_transacao\": 20978,\n \"valor_bruto\": \"100.00\",\n \"valor_taxa\": \"1.10\",\n \"data_criacao\": \"2025-06-30 13:37:00\",\n \"data_efetivacao\": \"2025-06-30 13:37:00\",\n \"data_baixa\": \"2025-06-30 13:37:00\",\n \"nome_situacao\": \"EFETUADO\",\n \"id_pagador\": \"12345678910\",\n \"nome_pagador\": \"João Gomes\",\n \"codigo_rastreio\": \"7b455b39-74a7-4cc5-6916-f1a7c4e34ecf\",\n \"texto_instrucao\": \"Instruções da cobrança...\",\n \"identificador_externo\": \"b55417ec-15fc-4733-8fxa-bb0f07912h9c\",\n \"soma_saldo\": \"445.10\",\n \"id_empresa\": 329,\n \"texto_descricao\": \"Descrição da cobrança...\",\n \"nome_banco\": null,\n \"codigo\": null,\n \"agencia\": null,\n \"id_recebedor\": null,\n \"nome_recebedor\": null,\n \"ativo_liberar_devolucao\": 1\n },\n {\n \"sigla\": \"pixEstatico\",\n \"nome_servico\": \"PIX ESTÁTICO\",\n \"id\": 271,\n \"id_transacao\": 20979,\n \"valor_bruto\": \"100.00\",\n \"valor_taxa\": \"50.40\",\n \"data_criacao\": \"2025-07-01 13:40:28\",\n \"data_efetivacao\": \"2025-07-01 13:40:28\",\n \"data_baixa\": \"2025-07-01 13:40:28\",\n \"nome_situacao\": \"EFETUADO\",\n \"id_pagador\": \"09876543210\",\n \"nome_pagador\": \"Marina Lima\",\n \"codigo_rastreio\": \"8a634348-g965-4a08-873c-bf6ae6yc8024\",\n \"texto_instrucao\": \"Instruções da cobrança...\",\n \"identificador_externo\": \"3b8455xa-12fb-49e3-be69-44251cgd90a4\",\n \"soma_saldo\": \"445.10\",\n \"id_empresa\": 329,\n \"texto_descricao\": \"Descrição da cobrança...\",\n \"nome_banco\": null,\n \"codigo\": null,\n \"agencia\": null,\n \"id_recebedor\": null,\n \"nome_recebedor\": null,\n \"ativo_liberar_devolucao\": 0\n }\n ]\n}"},{"id":"b9cdb817-eb14-4c69-b48d-ffefa354afc7","name":"Lista vazia","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"data_inicial\": \"2025-01-01\",\r\n \"data_final\": \"2025-02-30\"\r\n}","options":{"raw":{"language":"json"}}},"url":"/bt/pix/estatico/lista"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 03 Jul 2025 12:14:59 GMT"},{"key":"Server","value":"Apache/2.4.58 (Ubuntu)"},{"key":"vary","value":"origin,accept-encoding"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"cache-control","value":"no-cache"},{"key":"content-encoding","value":"gzip"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 400,\n \"mensagem\": \"Registros não encontrados\",\n \"data\": \"\"\n}"}],"_postman_id":"d0d830fe-f876-41d4-ad46-65f435acd059"},{"name":"Criar Devolução Pix","id":"294f58d6-c26c-4e1d-a50b-ddd7b0a1f970","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{}},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"id_invoice_pix\":\"5542\",\r\n \"identificador_externo\": \"eca986cc-de46-44ee-9ba0-f61db4dfe6f3\",\r\n \"descricao\": \"Devolução referente à...\",\r\n \"texto_instrucao\": \"Instruções adicionais...\" \r\n}","options":{"raw":{"language":"json"}}},"url":"/bt/pix/estatico/devolucao","description":"

\n
⚠️ Este recurso não está disponível em SandBox
\n

Descrição

Esta rota permite solicitar a devolução de um pagamento recebido por meio de uma cobrança do tipo Pix Estático.

⚠️ Os campos obrigatórios estão sinalizados com ( * )

Corpo da Requisiçã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

Campo	Tipo	Descrição
id_invoice_pix*	string	Id único da cobrança pix documento
identificador_externo*	string	Identificador primário da cobrança, para gerenciamento do lado do cliente.
descricao*	string	Descrição da transação de devolução
texto_instrucao*	string	Instruções adicionais relacionadas à devolução

","urlObject":{"path":["bt","pix","estatico","devolucao"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"294f58d6-c26c-4e1d-a50b-ddd7b0a1f970"},{"name":"Simular Pagamento","id":"e8b5b47b-47a1-4f0f-933a-1fb1ee512929","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"id\": \"731\",\r\n \"tipo_transacao\": \"pixStaticCashin\",\r\n \"pix\": {\r\n \"pagamento\": {\r\n \"valor\": \"100.00\",\r\n \"pagador\": {\r\n \"id\": \"83897953021\",\r\n \"nome\": \"Sabrina Cardoso\"\r\n }\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"/bt/desenvolvedor/simular_baixa","description":"

\n
⚠️ Recurso exclusivo para ambiente de SandBox
\n

Descrição

Após gerar suas cobranças, você pode utilizar esta rota para simular o pagamento de uma cobrança do tipo Pix Estático.

Essa simulação é útil para testes e validações durante o processo de integração.

Corpo da Requisiçã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

Campo	Tipo	Descrição
id*	string / number	ID da cobrança Pix que deseja simular o pagamento.
tipo_transacao*	string	Deve ser preenchido com pixCashin para indicar que a transação é do tipo Pix Dinâmico.
pix	object	Objeto que agrupa os dados de pagamento da cobrança Pix.

Pagamento

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

Campo de `pix.pagamento`	Tipo	Descrição
valor*	string	Valor que deseja simular no pagamento.
pagador*	object	Informações do pagador simulado. Deve conter: • id: CPF ou CNPJ do pagador • nome: Nome completo do pagador.

","urlObject":{"path":["bt","desenvolvedor","simular_baixa"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"afd9a559-f1f5-4e23-8e52-a2ac91b3e838","name":"Sucesso","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"id\": \"123\",\r\n \"tipo_transacao\": \"pixStaticCashin\",\r\n \"pix\": {\r\n \"pagamento\": {\r\n \"valor\": \"14.00\",\r\n \"pagador\": {\r\n \"id\": \"70949523412\",\r\n \"nome\": \"Evandro Júnior\"\r\n }\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"/bt/desenvolvedor/simular_baixa"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 03 Jul 2025 14:40:04 GMT"},{"key":"Server","value":"Apache/2.4.58 (Ubuntu)"},{"key":"vary","value":"origin,accept-encoding"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"cache-control","value":"no-cache"},{"key":"content-encoding","value":"gzip"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"mensagem\": \"Evento registrado\",\n \"data\": \"\"\n}"},{"id":"a260d4aa-1889-4340-a614-031674ad0c6a","name":"Não encontrado","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"id\": \"000\",\r\n \"tipo_transacao\": \"pixStaticCashin\",\r\n \"pix\": {\r\n \"pagamento\": {\r\n \"valor\": \"14.00\",\r\n \"pagador\": {\r\n \"id\": \"70949523412\",\r\n \"nome\": \"Evandro Júnior\"\r\n }\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"/bt/desenvolvedor/simular_baixa"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 03 Jul 2025 14:42:20 GMT"},{"key":"Server","value":"Apache/2.4.58 (Ubuntu)"},{"key":"vary","value":"origin,accept-encoding"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"cache-control","value":"no-cache"},{"key":"content-encoding","value":"gzip"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 400,\n \"mensagem\": \"Pix estático não encontrado\",\n \"data\": \"\"\n}"}],"_postman_id":"e8b5b47b-47a1-4f0f-933a-1fb1ee512929"}],"id":"dada7956-5d94-45d5-ae9f-54f03c931d0b","description":"

O Pix Estático é uma forma de cobrança que gera um QR Code fixo e reutilizável, com as informações do pagamento já incluídas no próprio código — como a chave Pix, o nome do recebedor, um valor e descrição da cobrança.

Você pode configurar o QR Code de duas formas:

Com valor fixo: o valor é definido no momento da geração do QR Code.
\n
Com valor em aberto: o pagador pode inserir manualmente o valor no aplicativo do banco.
\n

Recomendações de uso:

Casos onde não há necessidade de controlar cada pagamento individualmente (ex: doações, vendas rápidas ou pagamentos avulsos)
\n
Ambientes onde o QR Code será impresso ou exposto de forma permanente
\n
Sistemas simples ou sem back-end que gere cobranças de forma dinâmica
\n

Fluxo de Cobranças Estáticas

\n $\"Criação%20de%20Cobrança%20via%20Pix%20Estático\"$ ","_postman_id":"dada7956-5d94-45d5-ae9f-54f03c931d0b"},{"name":"Pix Dinâmico","item":[{"name":"Gerar Pix Dinâmico","id":"270f7c07-a435-4cd2-a631-d009a625818e","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{}},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"valor\": \"145\",\r\n \"tipo_transacao\": \"pixCashin\",\r\n \"vencimento\": \"2025-07-10T18:00:00\",\r\n \"descricao\": \"Descrição da cobrança...\",\r\n \"texto_instrucao\": \"Instruções da cobrança...\",\r\n \"identificador_externo\": \"b52eb2ed-6fcc-4484-ab5a-fe7cf6f2a068\",\r\n \"identificador_movimento\": \"09d818c2-59a9-4c86-9064-6739e6f9f6ae\",\r\n \"enviar_qr_code\": true,\r\n \"tag\": [\r\n \"categoria-xyz\",\r\n \"promoção\"\r\n ],\r\n \"cliente\": {\r\n \"nome\": \"Maria Eduarda\",\r\n \"tipo_documento\": \"cpf\",\r\n \"numero_documento\": \"255.539.850-30\",\r\n \"e-mail\": \"maria.eduarda@email.com.br\"\r\n },\r\n \"split\": [ // (Opicional) \r\n { \r\n \"tipo\": \"percentual\",\r\n \"valor\": \"0.70\",\r\n \"conta\": \"89392367-30d4-11f0-a96f-42010a400013\",\r\n \"dias_repasse\": \"6\" // (Opcional) Dias após a baixa do valor na conta principal\r\n \r\n },\r\n { \r\n \"tipo\": \"valor\",\r\n \"valor\": \"0.40\",\r\n \"conta\": \"89392367-30d4-11f0-a96f-42010a400013\",\r\n \"data_repasse\": \"2025-10-30\" // (Opcional) Dia para liberação da baixa. Caso abaixo do dia de baixa na conta principal, o valor é liberado no dia da baixa.\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"/bt/pix","description":"

Descrição

Esta rota permite registrar uma nova cobrança do tipo Pix Dinâmico, gerando um QR Code único para cada transação.

⚠️ Os campos obrigatórios estão sinalizados com ( * )

Corpo da Requisiçã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\n\n\n\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
valor*	string / number	Valor da cobrança a ser gerada
tipo_transacao*	string	`pixCashin` ou `pixCashinSemStatus`
vencimento	date	Data limite para o pagamento da cobrança. Se não for especificada, é automaticamente definida para 1 hora após a criação
descricao*	string	Breve descrição que aparece no layout da cobrança, aceita até 255 caracteres
texto_instrucao*	string	Instruções adicionais relacionadas à cobrança. Máximo de 1000 caracteres
identificador_externo*	string	Identificador principal e único da cobrança
identificador_movimento*	string	Identificador secundário da cobrança
enviar_qr_code	boolean	Define se o QR Code deve ser incluído na resposta da requisição. Por padrão é true
aceitar_qualquer_pagador	boolean	Indica se a cobrança pode ser paga exclusivamente pelo cliente informado ou se está liberada para qualquer pessoa. Por padrão, o valor é true.
tag	string[ ]	Lista de etiquetas para categorização ou filtragem da cobrança. Cada item deve conter no máximo 100 caracteres

Cliente

Identifica o devedor da cobrança.
Embora este campo seja opcional, caso seja informado, todos os seus subcampos tornam-se obrigatórios.

\n\n\n\n\n\n\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
nome*	string	Nome completo do devedor.
tipo_documento*	string	Define o tipo de documento a ser informado: `cpf` ou `cnpj`
documento*	string	Numero de documento do cliente. Deve seguir o seguinte modelo: • CPF: `XXX.XXX.XXX-XX` • CNPJ: `XX.XXX.XXX/XXXX-XX`
e-mail*	string	E-mail válido do cliente.

Split

\n\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
conta*	string	Identificador da conta Canvi que irá receber a parte do valor
tipo*	string	Define o tipo de divisão: • valor: valor fixo. • percentual: porcentagem do valor total da cobrança
valor*	string	Valor da divisão, conforme o tipo escolhido: • Se tipo for valor, o valor informado não pode ultrapassar o total da cobrança. • Se tipo for percentual, deve ser um número entre 0.01% e 100.00%

Informações relevantes

📌 Como informar corretamente valores monetários

Para gerar cobranças via Pix Dinâmico, o valor deve ser informado em centavos, sem casas decimais e ser maior que 0. Por exemplo: Para uma cobrança de R$ 100,00, envie o valor como 10000.

✨ Diferença entre `pixCashin` e `pixCashinSemStatus`

Esses dois tipos de transação definem se você deseja ou não receber notificações em tempo real via Webhook sempre que um pagamento for realizado.

pixCashin: A cada pagamento recebido, a Canvi envia automaticamente uma notificação para a URL de Webhook previamente configurada, contendo os dados completos da transação.
\n
pixCashinSemStatus: Os pagamentos são registrados normalmente no sistema da Canvi, mas nenhuma notificação é enviada ao seu sistema. Nesse caso, é necessário consultar manualmente ou periodicamente a API para obter os dados.
\n

ℹ️ Sobre os campos `identificador_externo` e `identificador_movimento`

Ambos os campos têm como objetivo facilitar o gerenciamento interno das cobranças, permitindo relacioná-las a informações do seu sistema.

O campo identificador_externo é o identificador principal e único de cada cobrança. Ele deve ser exclusivo por transação e serve como referência direta para consultas, atualizações ou controle individual.
\n
Já o campo identificador_movimento pode ser reutilizado em várias cobranças e funciona como um agrupador. Ele permite associar múltiplas transações a um mesmo contexto, como um cliente, um lote, uma movimentação financeira ou uma série de cobranças referentes ao mesmo produto ou serviço.
\n

\n","urlObject":{"path":["bt","pix"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"d870f49f-55c7-4f5b-84c0-4927a152738c","name":"Sucesso","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"valor\": \"145\",\r\n \"vencimento\": \"2025-07-10T18:00:00\",\r\n \"descricao\": \"Descrição da cobrança...\",\r\n \"texto_instrucao\": \"Instruções da cobrança...\",\r\n \"tipo_transacao\": \"pixCashin\",\r\n \"identificador_externo\": \"5ca87c38-ca12-4046-a4a8-050e7d2d3b71\",\r\n \"identificador_movimento\": \"896491e9-5161-4362-bc03-ab2388522273\",\r\n \"enviar_qr_code\": true,\r\n \"tag\": [\r\n \"categoria-xyz\",\r\n \"promoção\"\r\n ],\r\n \"cliente\": {\r\n \"nome\": \"Maria Eduarda\",\r\n \"tipo_documento\": \"cpf\",\r\n \"numero_documento\": \"123.456.789-00\",\r\n \"e-mail\": \"maria.eduarda@email.com.br\"\r\n },\r\n \"split\": [ // (Opicional) \r\n { \r\n \"tipo\": \"percentual\",\r\n \"valor\": \"0.70\",\r\n \"conta\": \"89392367-30d4-11f0-a96f-42010a400013\",\r\n \"dias_repasse\": \"6\" // (Opcional) Dias após a baixa do valor na conta principal\r\n \r\n },\r\n { \r\n \"tipo\": \"valor\",\r\n \"valor\": \"0.40\",\r\n \"conta\": \"89392367-30d4-11f0-a96f-42010a400013\",\r\n \"data_repasse\": \"2025-10-30\" // (Opcional) Dia para liberação da baixa. Caso abaixo do dia de baixa na conta principal, o valor é liberado no dia da baixa.\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"/bt/pix"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 10 Jul 2025 21:55:06 GMT"},{"key":"Server","value":"Apache/2.4.58 (Ubuntu)"},{"key":"vary","value":"origin,accept-encoding"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"cache-control","value":"no-cache"},{"key":"content-encoding","value":"gzip"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"mensagem\": \"Invoice PIX gerado\",\n \"data\": {\n \"id_invoice_pix\": 59775,\n \"valor\": \"1.45\",\n \"vencimento\": \"2025-07-10T18:00:00.100+00:00\",\n \"id_cobrador\": \"70368501248\",\n \"nome_cobrador\": \"NOME_DA_SUA_EMPRESA\",\n \"brcode\": \"00020101023456860014BR.GOV.BCB.PIX2564spi-h.itau.com.br/pix/qr/v2/0df1f1e5-b932-47c7-b136-d14570fc2be152040dfg7030398hj802BR5911Trocados 016009SAO PAULO62070503***6304F972\",\n \"status\": \"created\",\n \"criacao\": \"2025-07-10T17:55:05.100+00:00\",\n \"qrcode\": \"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAPoAAAD6AQAAAACgl2eQAAACv0lEQVR4Xu2XUXLjIBBE4SJw/1vsUeAisP0al6PoI7Ufce+PsKOyhueqzkzPIJf98/pT7pHbeoCzHuCsBzjr34BRSuXa+up71bn36vMEY4AiU4E6+qjG6hxgMwnoVvIGCglz+2KiwGilrtYUXKUvKf0PgMrDWxVigyyFAW5tllb1SZdRHQwC+HPe193V9/1fBrzkWCTKvquO1vornALoGancRxp5KqIPlAJOpSbS5mrk5/jnLTIAKDNSVUmWlK4q6xa6512sBOC4MlOYYMoaW/rOl8jPA9pWjORgF5KlmarwDAIK8O4WJ5EuE2gQ0LwazhCeLVhHnu2IzwE4ZSGysSuKma5iJQFMKrN0zy56VgZ2LweBaZtMkqWXZgmKT61yAMyibZofLuRZOkjTLAcoU50RjsaG2k7qLs0bALTveb7Y0AiTXyjUtZofByTQV0YHDEniREFlCiAttK9kDSomjZthcvkvPg74HKFUUsohj8rqaA7YHO3MECmbzpou0wWLAZOXN9CmSabm5UMPAqqMitXJ2EvmQO++/BcfBxZucfc0BmqlYgvjBoHt6TnPyUrCcDFqg4BGp7pFWfIMr9zpfmPiIKAJrq0CZfPwh5FygDLVzkOORvnwRymU4CDA4w0xpFI5bdHKX8UKAHqeMKYSIYzfxfrgWsUAB8eZ50arBTe+lwKQhyy2Bg9c24es6RTghpXIJdMyRhutqzn2FpkBMInfkmeB34fY5wHd8AOwa5ae45RCSfhMAtqYKJ3OzmCMrPOMEwMIdgXZZ5yfhx1rjAEs9poStjGPXMx3koAVIXIy1dkTwBkfBLAIwWZtrpdFvg2TAAaD213jFuaURXca0FmmfayKZ5y8vsOATpFWPMMkzRa+DNIEACPLDlxLC7fXTAsCrowmma7yy3bzanwMEpYCfloPcNYDnPUAZ/0C8BdOenx99GnmVwAAAABJRU5ErkJggg==\",\n \"tx_id\": \"CDC00000000000000000000011269\"\n }\n}"}],"_postman_id":"270f7c07-a435-4cd2-a631-d009a625818e"},{"name":"Consultar PIX","id":"3691a37d-7809-462a-800a-13a7099a3e57","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"id_invoice_pix\": \"59776\"\r\n}","options":{"raw":{"language":"json"}}},"url":"/bt/pix/dinamico/consulta","description":"

Descrição

Esta rota permite consultar os dados de uma cobrança do tipo Pix Dinâmico a partir do seu ID de Invoice (id_invoice_pix), que é retornado na resposta da requisição de criação da cobrança.

\n","urlObject":{"path":["bt","pix","dinamico","consulta"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"cd347735-3c2b-437b-829c-9514cf7e40ff","name":"Consultar PIX","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"id_invoice_pix\": \"59776\"\r\n}","options":{"raw":{"language":"json"}}},"url":"/bt/pix/dinamico/consulta"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 18 Jul 2025 13:50:02 GMT"},{"key":"Server","value":"Apache/2.4.58 (Ubuntu)"},{"key":"vary","value":"origin,accept-encoding"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"cache-control","value":"no-cache"},{"key":"content-encoding","value":"gzip"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"code\": 200,\n \"mensagem\": \"Dados do Pix\",\n \"data\": {\n \"id\": 59776,\n \"valor\": \"1.45\",\n \"vencimento\": \"2025-07-10 18:02:00\",\n \"id_cobrador\": \"70368501248\",\n \"nome_cobrador\": \"NOME_DA_SUA_EMPRESA\",\n \"juros\": \"0.00\",\n \"multa\": \"0.00\",\n \"brcode\": \"00020103421226866714BR.GOV.BCB.PIX2564spi-h.itau.com.br/pix/qr/v2/btm5f452-9xae-479a-a4fc-7ee5897b7d57520400005303989602BR5911Trocados 016009SAO PAULO62070503***63041610\",\n \"status\": \"expired\",\n \"criacao\": \"2025-07-10 18:00:00\",\n \"data_efetivacao\": null,\n \"id_pagador\": null,\n \"nome_pagador\": null,\n \"numero_conta\": null,\n \"tipo_conta\": null,\n \"agencia_conta\": null,\n \"codigo_banco\": null,\n \"nome_banco\": \"******\",\n \"codigo_rastreio\": null,\n \"qrcode\": {\n \"type\": \"Buffer\",\n \"data\": [\n 100,\n 97,\n 116\n // ... 1034 itens\n ]\n },\n \"tx_id\": \"CDC00000000000000000000012240\"\n }\n}"},{"id":"f4aabb2b-fd93-4446-9ada-c245dd015e70","name":"Não encontrado","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"id_invoice_pix","value":"56090","type":"text"}]},"url":"/bt/pix/dinamico/consulta"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 16 Jun 2025 13:06:58 GMT"},{"key":"Server","value":"Apache/2.4.58 (Ubuntu)"},{"key":"vary","value":"origin,accept-encoding"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"cache-control","value":"no-cache"},{"key":"content-encoding","value":"gzip"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 400,\n \"mensagem\": \"Invoice não encontrado\",\n \"data\": \"\"\n}"}],"_postman_id":"3691a37d-7809-462a-800a-13a7099a3e57"},{"name":"Listar Pix Dinâmicos","id":"bb06c976-ec3c-40fa-88d9-3c3f85fd9017","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"data_inicial\": \"2025-06-01\",\r\n \"data_final\": \"2025-07-30\"\r\n}","options":{"raw":{"language":"json"}}},"url":"/bt/pix/dinamico/lista","description":"

Descrição

Retorna uma lista detalhada das cobranças do tipo Pix Dinâmico registradas dentro do período de tempo especificado no corpo da requisição.

\n","urlObject":{"path":["bt","pix","dinamico","lista"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"9a07240a-b092-4762-983e-bd738c76f999","name":"Sucesso","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"data_inicial\": \"2025-06-01\",\r\n \"data_final\": \"2025-07-30\" \r\n}","options":{"raw":{"language":"json"}}},"url":"/bt/pix/dinamico/lista"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 16 Jul 2025 15:23:37 GMT"},{"key":"Server","value":"Apache/2.4.58 (Ubuntu)"},{"key":"vary","value":"origin,accept-encoding"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"cache-control","value":"no-cache"},{"key":"content-encoding","value":"gzip"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"code\": 200,\n \"mensagem\": \"Consulta PIX\",\n \"data\": [\n {\n \"sigla\": \"invoicePix\",\n \"nome_servico\": \"PIX DINÂMICO\",\n \"id\": 59630,\n \"id_transacao\": 11030,\n \"valor_bruto\": \"1.40\",\n \"valor_taxa\": \"0.00\",\n \"data_criacao\": \"2025-07-01 10:13:40\",\n \"data_efetivacao\": null,\n \"data_baixa\": null,\n \"nome_situacao\": \"CRIADO\",\n \"id_pagador\": null,\n \"nome_pagador\": null,\n \"codigo_rastreio\": null,\n \"texto_instrucao\": \"Instruções\",\n \"identificador_externo\": \"49fd4956-95b5-4a53-a1fb-0355c514d8df\",\n \"soma_saldo\": \"688.60\",\n \"id_empresa\": 329,\n \"texto_descricao\": \"CRIADO\",\n \"nome_banco\": null,\n \"codigo\": null,\n \"agencia\": null,\n \"id_recebedor\": null,\n \"nome_recebedor\": null,\n \"ativo_liberar_devolucao\": 0\n },\n {\n \"sigla\": \"invoicePix\",\n \"nome_servico\": \"PIX DINÂMICO\",\n \"id\": 59631,\n \"id_transacao\": 11033,\n \"valor_bruto\": \"1.40\",\n \"valor_taxa\": \"0.00\",\n \"data_criacao\": \"2025-07-01 10:16:48\",\n \"data_efetivacao\": null,\n \"data_baixa\": null,\n \"nome_situacao\": \"CRIADO\",\n \"id_pagador\": null,\n \"nome_pagador\": null,\n \"codigo_rastreio\": null,\n \"texto_instrucao\": \"Instruções\",\n \"identificador_externo\": \"0c18818d-a7f4-4f4e-a933-e16be7a5b229\",\n \"soma_saldo\": \"688.60\",\n \"id_empresa\": 329,\n \"texto_descricao\": \"CRIADO\",\n \"nome_banco\": null,\n \"codigo\": null,\n \"agencia\": null,\n \"id_recebedor\": null,\n \"nome_recebedor\": null,\n \"ativo_liberar_devolucao\": 0\n },\n {\n \"sigla\": \"invoicePix\",\n \"nome_servico\": \"PIX DINÂMICO\",\n \"id\": 59637,\n \"id_transacao\": 11047,\n \"valor_bruto\": \"1.40\",\n \"valor_taxa\": \"0.00\",\n \"data_criacao\": \"2025-07-01 14:10:30\",\n \"data_efetivacao\": null,\n \"data_baixa\": null,\n \"nome_situacao\": \"CRIADO\",\n \"id_pagador\": null,\n \"nome_pagador\": null,\n \"codigo_rastreio\": null,\n \"texto_instrucao\": \"Instruções\",\n \"identificador_externo\": \"dc6db3bf-18cd-40a7-a83b-e53c2ad74f88\",\n \"soma_saldo\": \"688.60\",\n \"id_empresa\": 329,\n \"texto_descricao\": \"CRIADO\",\n \"nome_banco\": null,\n \"codigo\": null,\n \"agencia\": null,\n \"id_recebedor\": null,\n \"nome_recebedor\": null,\n \"ativo_liberar_devolucao\": 0\n },\n {\n \"sigla\": \"invoicePix\",\n \"nome_servico\": \"PIX DINÂMICO\",\n \"id\": 59638,\n \"id_transacao\": 11048,\n \"valor_bruto\": \"1.40\",\n \"valor_taxa\": \"0.00\",\n \"data_criacao\": \"2025-07-01 14:10:54\",\n \"data_efetivacao\": null,\n \"data_baixa\": null,\n \"nome_situacao\": \"CRIADO\",\n \"id_pagador\": null,\n \"nome_pagador\": null,\n \"codigo_rastreio\": null,\n \"texto_instrucao\": \"Instruções\",\n \"identificador_externo\": \"75f597e5-2789-497f-a6a8-d49c29e1a461\",\n \"soma_saldo\": \"688.60\",\n \"id_empresa\": 329,\n \"texto_descricao\": \"CRIADO\",\n \"nome_banco\": null,\n \"codigo\": null,\n \"agencia\": null,\n \"id_recebedor\": null,\n \"nome_recebedor\": null,\n \"ativo_liberar_devolucao\": 0\n }\n ]\n}"},{"id":"9efb4019-be7b-442e-9313-1f92eb3c325c","name":"Lista vazia","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"data_inicial\": \"2025-07-15\",\r\n \"data_final\": \"2025-07-30\"\r\n}","options":{"raw":{"language":"json"}}},"url":"/bt/pix/dinamico/lista"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 18 Jul 2025 15:10:26 GMT"},{"key":"Server","value":"Apache/2.4.58 (Ubuntu)"},{"key":"vary","value":"origin,accept-encoding"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"cache-control","value":"no-cache"},{"key":"content-encoding","value":"gzip"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 400,\n \"mensagem\": \"Registros não encontrados\",\n \"data\": \"\"\n}"}],"_postman_id":"bb06c976-ec3c-40fa-88d9-3c3f85fd9017"},{"name":"Criar Devolução Pix","id":"cf20b4cd-f38c-444e-ae14-a498cdb91b34","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{}},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"\r\n{\r\n \"id_invoice_pix\":\"169327\",\r\n \"identificador_externo\": \"dfb2f6b7-7410-4dfa-9800-b424a5e5f25b\",\r\n \"descricao\": \"Devolução de teste\",\r\n \"texto_instrucao\": \"Instrução...\" \r\n}","options":{"raw":{"language":"json"}}},"url":"/bt/pix/dinamico/devolucao","description":"

\n
⚠️ Este recurso não está disponível em SandBox
\n

Descrição

Esta rota permite solicitar a devolução de um pagamento recebido por meio de uma cobrança do tipo Pix Dinâmico.

⚠️ Os campos obrigatórios estão sinalizados com ( * )

Corpo da Requisiçã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

Campo	Tipo	Descrição
id_invoice_pix*	string	Id único da cobrança pix documento
identificador_externo*	string	Identificador primário da cobrança, para gerenciamento do lado do cliente.
descricao*	string	Descrição da transação de devolução
texto_instrucao*	string	Instruções adicionais relacionadas à devolução

","urlObject":{"path":["bt","pix","dinamico","devolucao"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"cf20b4cd-f38c-444e-ae14-a498cdb91b34"},{"name":"Simular Pagamento","id":"114834b7-33b3-44eb-b7bb-790d03b240d3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"id\": 60014,\r\n \"tipo_transacao\": \"pixCashin\",\r\n \"pix\": {\r\n \"pagamento\": {\r\n \"valor\": \"49.90\",\r\n \"pagador\": {\r\n \"id\": \"25553985030\",\r\n \"nome\": \"Maria Eduarda\"\r\n }\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"/bt/desenvolvedor/simular_baixa","description":"

Descrição

\n
⚠️ Recurso exclusivo para ambiente SandBox
\n

Esta rota permite simular o pagamento de uma cobrança do tipo Pix Dinâmico, sendo ideal para testes e validações durante o processo de integração com a API.

Corpo da Requisiçã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

Campo	Tipo	Descrição
id*	string / number	ID da cobrança Pix que deseja simular o pagamento.
tipo_transacao*	string	Deve ser preenchido com pixCashin para indicar que a transação é do tipo Pix Dinâmico.
pix	object	Objeto que agrupa os dados de pagamento da cobrança Pix.

Pagamento

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

Campo de `pix.pagamento`	Tipo	Descrição
valor*	string	Valor que deseja simular no pagamento.
pagador*	object	Informações do pagador simulado. Deve conter: • id: CPF ou CNPJ do pagador • nome: Nome completo do pagador.

","urlObject":{"path":["bt","desenvolvedor","simular_baixa"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"868600aa-bbba-4d7d-9cab-cadc26012596","name":"Sucesso","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"id\": 60014,\r\n \"tipo_transacao\": \"pixCashin\",\r\n \"pix\": {\r\n \"pagamento\": {\r\n \"valor\": \"49.90\",\r\n \"pagador\": {\r\n \"id\": \"25553985030\",\r\n \"nome\": \"Maria Eduarda\"\r\n }\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"/bt/desenvolvedor/simular_baixa"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Fri, 01 Aug 2025 17:35:03 GMT"},{"key":"Server","value":"Apache/2.4.58 (Ubuntu)"},{"key":"vary","value":"origin,accept-encoding"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"cache-control","value":"no-cache"},{"key":"content-encoding","value":"gzip"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"mensagem\": \"Informação Recebida\",\n \"data\": \"\"\n}"}],"_postman_id":"114834b7-33b3-44eb-b7bb-790d03b240d3"}],"id":"797cef4d-bf6f-4049-85db-362da7e2d849","description":"

Descrição

O Pix Dinâmico é uma modalidade de cobrança que permite a geração de QR Codes associados a transações específicas e consultadas em tempo real.

Ele oferece um fluxo de pagamento individualizado, seguro e automatizável, ideal para cenários onde é necessário controle total sobre cada cobrança — incluindo identificação do pagador, valor fixo, data de vencimento e outras informações detalhadas.

É possível definir o pagador, a data de vencimento, valores específicos, e muito mais.

Características principais:

O QR Code contém apenas um link (payload URL), que direciona o app bancário do pagador para uma cobrança consultada em tempo real.
\n
Permite definir:
\n
- Valor fixo por transação
  \n
- Identificação do devedor
  \n
- Descrição personalizada
  \n
- Data de vencimento
  \n
\n
Suporta:
\n
- Consulta de status do pagamento
  \n
- Cancelamento da cobrança
  \n
- Devolução parcial ou total
  \n
- Notificações via Webhook
  \n
- Split de pagamento entre contas
  \n
\n

Recomendações de uso:

E-commerces e marketplaces
\n
Aplicações que exigem rastreabilidade e automação
\n
Sistemas que geram cobranças em tempo real para usuários únicos
\n
Integrações via API com controle completo do ciclo de vida da cobrança
\n

Vantagens:

Maior segurança e controle
\n
Mais flexibilidade para o recebedor
\n
Integração com fluxo de conciliação automática
\n

\n $\"Fluxo%20de%20Cobranças%20de%20Pix%20Dinâmico\"$ \n\n

Status das Cobranças

Durante o ciclo de vida de uma cobrança Pix Dinâmico, diferentes status podem ser atribuídos conforme o andamento da transação. Abaixo estão os possíveis valores do campo status, com suas descrições e orientações de uso:

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

Status	Descrição
`CREATED`	A cobrança foi criada com sucesso e está aguardando pagamento.
`PAID`	Um pagamento foi identificado e validado, mas o valor ainda não foi creditado à conta recebedora.
`CREDITED`	O valor da cobrança foi efetivamente creditado na conta do recebedor.
`EXPIRED`	A cobrança foi criada com um vencimento e não foi paga dentro do prazo, tornando-se inválida.
`CANCELED`	A cobrança foi cancelada manualmente antes da finalização do pagamento, ou automaticamente graças a um problema externo.

","_postman_id":"797cef4d-bf6f-4049-85db-362da7e2d849"},{"name":"Boleto","item":[{"name":"Gerar Boleto","id":"6e83b2e9-5f10-48ab-bc51-7bf55ebb6dc5","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{}},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"valor\": \"79.99\",\r\n \"tipo_transacao\": \"boletoCashin\",\r\n \"identificador_externo\": \"7ef8b779-16a0-440b-bb39-9f49cda3fb38\",\r\n \"descricao\": \"Teste de criação de boleto...\",\r\n \"instrucao\": [\r\n \"Cobrança referente a...\",\r\n \"Vencimento após dia...\",\r\n \"Demais instruções...\"\r\n ],\r\n \"aplicar_multa\": true,\r\n \"tipo_multa\": \"percentual\",\r\n \"multa\": \"1.00\",\r\n \"aplicar_juros\": true,\r\n \"tipo_juros\": \"percentual\",\r\n \"juros\": \"2.00\",\r\n \"aplicar_desconto\": true,\r\n \"tipo_desconto\": \"percentual\",\r\n \"desconto\": \"10.00\",\r\n \"data_limite_desconto\": \"2025-08-29\",\r\n \"vencimento\": \"2025-08-30\",\r\n \"dias_expirar\": \"1\",\r\n \"pagador\": {\r\n \"nome\": \"Daniela Sena\",\r\n \"documento\": \"160.522.930-04\",\r\n \"endereco\": {\r\n \"cep\": \"69000000\",\r\n \"cidade\": \"Manaus\",\r\n \"uf\": \"AM\",\r\n \"rua\": \"Av. Norte Sul\",\r\n \"numero\": \"10\",\r\n \"complemento\": \"Ap 1208\",\r\n \"bairro\": \"Centro\"\r\n }\r\n },\r\n \"cliente\": {\r\n \"nome\": \"Danilo Sena\",\r\n \"tipo_documento\": \"cpf\",\r\n \"numero_documento\": \"201.350.520-50\",\r\n \"e-mail\": \"danilo.sena@email.com\"\r\n },\r\n \"split\": [ // (Opicional) \r\n {\r\n \"tipo\": \"percentual\",\r\n \"valor\": \"0.70\",\r\n \"conta\": \"89392367-30d4-11f0-a96f-42010a400013\",\r\n \"dias_repasse\": \"6\" // (Opcional) Dias após a baixa do valor na conta principal\r\n },\r\n {\r\n \"tipo\": \"valor\",\r\n \"valor\": \"0.40\",\r\n \"conta\": \"89392367-30d4-11f0-a96f-42010a400013\",\r\n \"data_repasse\": \"2025-10-30\" // (Opcional) Dia para liberação da baixa. Caso abaixo do dia de baixa na conta principal, o valor é liberado no dia da baixa.\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"/bt/boleto","description":"

Descrição

Esta rota permite a criação de cobranças via Boleto Bancário, possibilitando a definição de vencimento, instruções personalizadas, aplicação de multa, juros e desconto, além de permitir o envio de dados detalhados sobre o pagador.

⚠️ Os campos obrigatórios estão sinalizados com ( * )

Corpo da Requisição

\n
⚠️ Importante: Para a geração de boletos, os campos de data devem seguir o formato YYYY-MM-DD, sem informar as horas. Isso ocorre porque o serviço de liquidação dos boletos não reconhece a especificação de horas.
\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\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
valor*	string / number	Define o valor da cobrança em centavos (sem casas decimais) ou reais (com no máximo duas casas decimais separadas por um ponto). Mínimo: `5.00` — Máximo: `20000.00`
tipo_transacao*	string	Define o tipo da cobrança a ser utilizada: `boletoCashin`
vencimento*	date	Data de vencimento da cobrança. Não pode ser anterior à data atual nem superior a 2190 dias.
identificador_externo*	string	Identificador único da transação. Não pode ser reutilizado.
descricao*	string	Breve descrição da cobrança, com até 255 caracteres.
instrucao*	string[]	Lista de informações que serão exibidas no layout do boleto. Pode ser usada para adicionar detalhes importantes para a cobrança, como juros, multas, etc; Suporta até 10 itens com no máximo 60 caracteres cada.
dias_expirar*	string	Quantidade de dias após o vencimento em que o boleto ainda pode ser pago. Valores entre 0 e 999. Se for 0, o boleto expira no próprio dia do vencimento.

Multa

Valor único em reais ou percentual a ser cobrado após o vencimento da cobrança. Se o campo aplicar_multa for true, os campos seguintes são obrigatórios:

\n\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
aplicar_multa*	boolean	Informa se haverá aplicação de multa após o vencimento
tipo_multa	string	`percentual`: porcentagem sobre o valor total da cobrança. `valor`: valor fixo
multa	string	Define o valor ou percentual da multa. Deve ser sempre menor que o valor da cobrança

Juros

Valor, em reais ou porcentagem, cobrado diariamente por dias de atraso após a data de vencimento:

\n\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
aplicar_juros*	boolean	Informa se deverá ser aplicado juros após o vencimento
tipo_juros	string	`percentual`: porcentagem sobre o valor total da cobrança `valor`: valor fixo
juros	string	Define o valor ou percentual dos juros. Deve ser sempre menor que o valor da cobrança.

Desconto

Valor a ser deduzido da cobrança se o pagamento for realizado até a data definida

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

Chave	Tipo	Descrição
aplicar_desconto*	boolean	Informa se haverá aplicação de desconto caso o pagamento seja realizado antes do vencimento
tipo_desconto	string	`percentual`: porcentagem sobre o valor total da cobrança. `valor`: valor fixo
data_limite_desconto	date	Data limite para concessão do desconto
desconto	string	Define o valor do desconto de acordo com o tipo previamente informado. Deve ser sempre menor que o valor da cobrança

Pagador*

Identifica o responsável pelo pagamento efetivo deste boleto.

\n\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
nome*	string	Nome completo do devedor
documento*	string	Número de documento do devedor
endereco*	object	Objeto com dados do endereço do devedor

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\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 de `endereco`	Tipo	Descrição
cep*	string	Código postal sem traços ou pontos. O CEP deve pertencer ao endereço enviado na requisição e conter exatos 8 caracteres
cidade*	string	Nome da cidade, deve conter até 50 caracteres
uf*	string	Unidade Federativa (Estado) abreviada em dois caracteres, 2 caracteres.
rua*	string	Nome do logradouro, deve conter até 50 caracteres
numero*	string	Número da residencia, deve conter até 10 caracteres
complemento*	string	Complemento do endereço, até 40 caracteres
bairro*	string	Nome do bairro, deve conter até 40 caracteres

Cliente

Este campo representa o cliente final vinculado à cobrança. Ele permite que você identifique internamente quem está sendo cobrado, mesmo que o responsável pelo pagamento (informado no campo pagador) seja outra pessoa.

Por exemplo, em um contexto educacional, o campo cliente pode conter os dados do aluno matriculado, enquanto o campo pagador representará o responsável financeiro, ou seja, quem efetivamente efetuará o pagamento do boleto.

O preenchimento correto deste campo facilita a conciliação de cobranças, o relacionamento com seus clientes e a organização das suas informações internas.

\n\n\n\n\n\n\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
nome*	string	Nome completo do cliente (máximo de 255 caracteres).
tipo_documento*	string	Aceita `cpf` ou `cnpj`
numero_documento*	string	Documento do cliente. Deve seguir o seguinte modelo: CPF: `XXX.XXX.XXX-XX` CNPJ: `XX.XXX.XXX/XXXX-XX`
e-mail*	string	E-mail válido do cliente.

Split

⚠️ Novo recurso!

Agora também é possível realizar split de cobranças na modalidade de boleto. Para isso, basta informar o ID da conta Canvi e o tipo e valor a ser repassado.

\n
O campo de split é opcional, porém, caso seja enviado, todos os seus subcampos tornam-se obrigatórios.
\n

\n\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
conta*	string	Identificador da conta Canvi que irá receber a parte do valor
tipo*	string	Define o tipo de divisão: • valor: valor fixo. • percentual: porcentagem do valor total da cobrança
valor*	string	Valor da divisão, conforme o tipo escolhido: • Se tipo for valor, o valor informado não pode ultrapassar o total da cobrança. • Se tipo for percentual, deve ser um número entre 0.01% e 100.00%

","urlObject":{"path":["bt","boleto"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"abf6f500-bc70-4cf5-9ab4-69bcbc729aff","name":"Sucesso","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text","disabled":true}],"body":{"mode":"raw","raw":"{\r\n \"valor\": \"79.99\",\r\n \"tipo_transacao\": \"boletoCashin\",\r\n \"identificador_externo\": \"8f36b891-c5b7-4b6d-98c2-95978b47b13c\",\r\n \"descricao\": \"Teste de criação de boleto...\",\r\n \"instrucao\": [\r\n \"Cobrança referente a...\",\r\n \"Vencimento após dia...\",\r\n \"Demais instruções...\"\r\n ],\r\n \"aplicar_multa\": true,\r\n \"tipo_multa\": \"percentual\",\r\n \"multa\": \"1.00\",\r\n \"aplicar_juros\": true,\r\n \"tipo_juros\": \"percentual\",\r\n \"juros\": \"2.00\",\r\n \"aplicar_desconto\": true,\r\n \"tipo_desconto\": \"percentual\",\r\n \"desconto\": \"10.00\",\r\n \"data_limite_desconto\": \"2025-07-29\",\r\n \"vencimento\": \"2025-07-30T16:59:59\",\r\n \"dias_expirar\": \"1\",\r\n \"pagador\": {\r\n \"nome\": \"Daniela Sena\",\r\n \"documento\": \"160.522.930-04\",\r\n \"endereco\": {\r\n \"cep\": \"69000000\",\r\n \"cidade\": \"Manaus\",\r\n \"uf\": \"AM\",\r\n \"rua\": \"Av. Norte Sul\",\r\n \"numero\": \"10\",\r\n \"complemento\": \"Ap 1208\",\r\n \"bairro\": \"Centro\"\r\n }\r\n },\r\n \"cliente\": {\r\n \"nome\": \"Danilo Sena\",\r\n \"tipo_documento\": \"cpf\",\r\n \"numero_documento\": \"201.350.520-50\",\r\n \"e-mail\": \"danilo.sena@email.com\"\r\n },\r\n \"split\": [ // (Opicional) \r\n { \r\n \"tipo\": \"percentual\",\r\n \"valor\": \"0.70\",\r\n \"conta\": \"89392367-30d4-11f0-a96f-42010a400013\",\r\n \"dias_repasse\": \"6\" // (Opcional) Dias após a baixa do valor na conta principal\r\n \r\n },\r\n { \r\n \"tipo\": \"valor\",\r\n \"valor\": \"0.40\",\r\n \"conta\": \"89392367-30d4-11f0-a96f-42010a400013\",\r\n \"data_repasse\": \"2025-10-30\" // (Opcional) Dia para liberação da baixa. Caso abaixo do dia de baixa na conta principal, o valor é liberado no dia da baixa.\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"/bt/boleto"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 24 Jul 2025 13:42:31 GMT"},{"key":"Server","value":"Apache/2.4.58 (Ubuntu)"},{"key":"vary","value":"origin,accept-encoding"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"cache-control","value":"no-cache"},{"key":"content-encoding","value":"gzip"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"mensagem\": \"Boleto Gerado\",\n \"data\": {\n \"id_boleto\": 1185,\n \"valor\": \"79.99\",\n \"vencimento\": \"2025-07-30\",\n \"link\": \"https://homologacao.service-canvi.com.br/3h7fb9e0-5ebe-4e8f-a7e3-224ac91ta71c\",\n \"linha_digitavel\": \"23792.85600 99011.265941 61022.265203 5 11580000007999\",\n \"hash\": \"3f7fb6e0-5ebe-4d8f-a7e3-224ac91aa71c\",\n \"status\": \"created\",\n \"data_emissao\": \"2025-07-24\",\n \"nosso_numero\": \"90112659461\",\n \"boleto\": {\n \"beneficiario_final\": {\n \"beneficiario_final_nome\": \"NOME_DA_SUA_EMPRESA\",\n \"beneficiario_final_cnpj\": \"01.234.567/890-\"\n },\n \"beneficiario\": {\n \"beneficiario_nome\": \"CANVI INOVACAO E TECNOLOGIA INOVA LTDA por Aarin\",\n \"beneficiario_nome_secundario\": \"REPASSES FINANCEIROS E SOLUCOES TECNOLOGICAS INSTITUICAO DE PAGAMENTO\",\n \"beneficiario_cnpj\": \"40.473.435/0001-78\",\n \"beneficiario_endereco\": \"AVENIDA PAULISTA, 688 - SÃO PAULO, SP\"\n },\n \"emissao\": \"24/07/2025\",\n \"linha_digitavel\": \"23792.85600 99011.265941 61022.265203 5 11580000007999\",\n \"codigo_barras\": \"23795115800000079992856099011265946102226520\",\n \"cip\": \"865\",\n \"vencimento\": \"30/07/2025\",\n \"nosso_numero\": \"09/90112659461-5\",\n \"numero_documento\": \"90112659461\",\n \"carteira\": \"09\",\n \"especie\": \"R$\",\n \"valor_documento\": \"R$ 79,99\",\n \"instrucao\": [\n \"Beneficiário Final: 70368501248\",\n \"NOME_DA_SUA_EMPRESA\",\n \"Cobrança referente a...\",\n \"Vencimento após dia...\",\n \"Demais instruções...\"\n ],\n \"codigo_banco\": \"237\",\n \"banco\": \"Bradesco\",\n \"local_pagamento\": \"Pagável preferencialmente em qualquer agência Bradesco.\",\n \"pagador\": {\n \"nome\": \"Daniela Sena\",\n \"documento\": \"***.522.930-**\",\n \"endereco\": {\n \"cep\": \"69000000\",\n \"cidade\": \"Manaus\",\n \"uf\": \"AM\",\n \"rua\": \"Av. Norte Sul\",\n \"numero\": \"10\",\n \"complemento\": \"Ap 1208\",\n \"bairro\": \"Centro\"\n },\n \"sacador\": \"NOME_DA_SUA_EMPRESA por Aarin\"\n },\n \"tipo_retorno\": \"pdf\",\n \"data_vencimento\": \"2025-07-30 00:00:00\",\n \"descricao\": \"Teste de criação de boleto...\",\n \"aplicar_multa\": 1,\n \"tipo_multa\": \"percentual\",\n \"multa\": \"1.00\",\n \"aplicar_juros\": 1,\n \"tipo_juros\": \"percentual\",\n \"juros\": \"2.00\",\n \"aplicar_desconto\": 1,\n \"tipo_desconto\": \"percentual\",\n \"data_limite_desconto\": \"2025-07-29 00:00:00\",\n \"desconto\": \"10.00\"\n },\n \"pix\": {\n \"valor\": \"R$ 79,99\",\n \"vencimento\": \"30/07/2025\",\n \"beneficiario\": \"NOME_DA_SUA_EMPRESA\",\n \"numero_cnpj\": \"01234567890\",\n \"qrcode\": {\n \"type\": \"Buffer\",\n \"data\": [\n 100,\n 97,\n 116\n // 1050 itens restantes...\n ]\n },\n \"brcode\": \"00020101021226910014BR.GOV.BCB.PIX2569spi-h.itau.com.br/pix/qr/v2/cobv/8f98b43b-aa7f-4584-8b9d-be8a8f8be28d5204000053039865802BR5911Trocados 016009FORTALEZA62070503***6304005C\"\n }\n }\n}"}],"_postman_id":"6e83b2e9-5f10-48ab-bc51-7bf55ebb6dc5"},{"name":"Consultar Boleto","event":[{"listen":"test","script":{"id":"935fece0-8b44-4882-9159-74d99ec436c5","exec":["\r","pm.test(\"Response status code is 200\", function () {\r"," pm.expect(pm.response.code).to.equal(200);\r","});\r","\r","\r","pm.test(\"Response has the required fields - code, mensagem, data\", function () {\r"," const responseData = pm.response.json();\r"," \r"," pm.expect(responseData).to.be.an('object');\r"," pm.expect(responseData).to.have.property('code');\r"," pm.expect(responseData).to.have.property('mensagem');\r"," pm.expect(responseData).to.have.property('data');\r","});\r","\r","\r","pm.test(\"Response time is within acceptable range\", function () {\r"," pm.expect(pm.response.responseTime).to.be.below(200);\r","});\r","\r","// Stores the data_vencimento (due date) from the response in an environment or global variable\r","var responseBody = pm.response.json();\r","var dueDate = responseBody.data.boleto.data_vencimento;\r","pm.globals.set(\"dueDate\", dueDate);"],"type":"text/javascript","packages":{}}}],"id":"17941902-3242-46f9-89b4-4a6e16114e78","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{}},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n // \"id_boleto\": \"1743\" // A CONSULTA DEVE SER FEITA OU PELO ID_BOLETO OU PELO IDENTIFICADOR_EXTERNO\r\n \"identificador_externo\": \"21265\"\r\n}","options":{"raw":{"language":"json"}}},"url":"/bt/consulta_boleto","description":"

Descrição

Este rota permite consultar os dados de uma cobrança de Boleto a partir de seu ID.

Corpo da Requisição

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

Campo	Tipo	Descrição
id_boleto	string / number	id da cobrança, retornado no corpo da resposta de criação do boleto.

","urlObject":{"path":["bt","consulta_boleto"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"28e2a7aa-44ad-4cfe-9e2b-34f3526ad95c","name":"Sucesso - Com dados","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text","disabled":true}],"body":{"mode":"raw","raw":"{\r\n \"id_boleto\": \"1185\" \r\n}","options":{"raw":{"language":"json"}}},"url":"/bt/consulta_boleto"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 24 Jul 2025 20:04:46 GMT"},{"key":"Server","value":"Apache/2.4.58 (Ubuntu)"},{"key":"vary","value":"origin,accept-encoding"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"cache-control","value":"no-cache"},{"key":"content-encoding","value":"gzip"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"mensagem\": \"Dados do Boleto\",\n \"data\": {\n \"id_boleto\": 1185,\n \"valor\": \"79.99\",\n \"vencimento\": \"2025-07-30 00:00:00\",\n \"link\": \"https://homologacao.service-canvi.com.br/9977b1f4-a261-4449-9e68-a96278b7a404\",\n \"linha_digitavel\": \"23792.85600 99011.265941 61022.265203 5 11580000007999\",\n \"hash\": \"3f7fb6e0-5ebe-4d8f-a7e3-224ac91aa71c\",\n \"status\": \"created\",\n \"data_emissao\": \"2025-07-24 09:42:24\",\n \"nosso_numero\": \"90112659461\",\n \"boleto\": {\n \"beneficiario_final\": {\n \"beneficiario_final_nome\": \"NOME_DA_SUA_EMPRESA\",\n \"beneficiario_final_cnpj\": \"01.234.567/890-\"\n },\n \"beneficiario\": {\n \"beneficiario_nome\": \"CANVI INOVACAO E TECNOLOGIA INOVA LTDA por Aarin\",\n \"beneficiario_nome_secundario\": \"REPASSES FINANCEIROS E SOLUCOES TECNOLOGICAS INSTITUICAO DE PAGAMENTO\",\n \"beneficiario_cnpj\": \"40.473.435/0001-78\",\n \"beneficiario_endereco\": \"AVENIDA PAULISTA, 688 - SÃO PAULO, SP\"\n },\n \"emissao\": \"24/07/2025\",\n \"linha_digitavel\": \"23792.85600 99011.265941 61022.265203 5 11580000007999\",\n \"codigo_barras\": \"23795115800000079992856099011265946102226520\",\n \"cip\": \"865\",\n \"vencimento\": \"30/07/2025\",\n \"nosso_numero\": \"09/90112659461-5\",\n \"numero_documento\": \"90112659461\",\n \"carteira\": \"09\",\n \"especie\": \"R$\",\n \"valor_documento\": \"R$ 79,99\",\n \"instrucao\": [\n \"Beneficiário Final: 70368501248\",\n \"NOME_DA_SUA_EMPRESA\",\n \"Cobrança referente a...\",\n \"Vencimento após dia...\",\n \"Demais instruções...\"\n ],\n \"codigo_banco\": \"237\",\n \"banco\": \"Bradesco\",\n \"local_pagamento\": \"Pagável preferencialmente em qualquer agência Bradesco.\",\n \"pagador\": {\n \"nome\": \"Daniela Sena\",\n \"documento\": \"***.522.930-**\",\n \"endereco\": {\n \"cep\": \"69000000\",\n \"cidade\": \"Manaus\",\n \"uf\": \"AM\",\n \"rua\": \"Av. Norte Sul\",\n \"numero\": \"10\",\n \"complemento\": \"Ap 1208\",\n \"bairro\": \"Centro\"\n },\n \"sacador\": \"NOME_DA_SUA_EMPRESA por Aarin\"\n },\n \"tipo_retorno\": \"pdf\",\n \"data_vencimento\": \"2025-07-30 00:00:00\",\n \"descricao\": \"Teste de criação de boleto...\",\n \"aplicar_multa\": 1,\n \"tipo_multa\": \"percentual\",\n \"multa\": \"1.00\",\n \"aplicar_juros\": 1,\n \"tipo_juros\": \"percentual\",\n \"juros\": \"2.00\",\n \"aplicar_desconto\": 1,\n \"tipo_desconto\": \"percentual\",\n \"data_limite_desconto\": \"2025-07-29 00:00:00\",\n \"desconto\": \"10.00\"\n },\n \"pix\": {\n \"valor\": \"R$ 79,99\",\n \"vencimento\": \"30/07/2025\",\n \"beneficiario\": \"NOME_DA_SUA_EMPRESA\",\n \"numero_cnpj\": \"01234567890\",\n \"qrcode\": {\n \"type\": \"Buffer\",\n \"data\": [\n 100,\n 97,\n 116\n // 1050 itens restantes...\n ]\n },\n \"brcode\": \"00020101021226910014BR.GOV.BCB.PIX2569spi-h.itau.com.br/pix/qr/v2/cobv/8f98b43b-aa7f-4584-8b9d-be8a8f8be28d5204000053039865802BR5911Trocados 016009FORTALEZA62070503***6304005C\"\n },\n \"pagamento\": null\n }\n}"},{"id":"a0bb1bf9-41f0-4828-ae20-c58e1c3cc91b","name":"Sucesso - Sem dados","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text","disabled":true}],"body":{"mode":"raw","raw":"{\r\n \"id_boleto\": \"118556\" \r\n}","options":{"raw":{"language":"json"}}},"url":"/bt/consulta_boleto"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 28 Jul 2025 18:31:36 GMT"},{"key":"Server","value":"Apache/2.4.58 (Ubuntu)"},{"key":"vary","value":"origin,accept-encoding"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"cache-control","value":"no-cache"},{"key":"content-encoding","value":"gzip"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 400,\n \"mensagem\": \"Documento não encontrado\",\n \"data\": \"\"\n}"}],"_postman_id":"17941902-3242-46f9-89b4-4a6e16114e78"},{"name":"Listar Boletos","id":"17ef6982-2177-42bb-bb87-c2e04f3f611a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"data_inicial\": \"2025-07-01\",\r\n \"data_final\": \"2025-07-31\"\r\n}","options":{"raw":{"language":"json"}}},"url":"/bt/consulta_boletos","description":"

Descrição

Esta rota permite consultar uma lista de todos os boletos gerados em um determinado período de tempo, especificado no corpo da requisição através das propriedades data_inicial e data_final.

\n","urlObject":{"path":["bt","consulta_boletos"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"b879eb2a-4c54-4e41-94c8-f7948072cfdf","name":"Sucesso - Com dados","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"data_inicial\": \"2025-07-01\",\r\n \"data_final\": \"2025-07-31\"\r\n}","options":{"raw":{"language":"json"}}},"url":"/bt/consulta_boletos"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 24 Jul 2025 20:48:29 GMT"},{"key":"Server","value":"Apache/2.4.58 (Ubuntu)"},{"key":"vary","value":"origin,accept-encoding"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"cache-control","value":"no-cache"},{"key":"content-encoding","value":"gzip"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"mensagem\": \"Consulta das transações PIX\",\n \"data\": [\n {\n \"sigla\": \"boletoCobranca\",\n \"nome_servico\": \"BOLETO\",\n \"id\": 1185,\n \"id_transacao\": 11736,\n \"valor_bruto\": \"79.99\",\n \"valor_taxa\": \"0.00\",\n \"data_criacao\": \"2025-07-24 09:42:24\",\n \"data_efetivacao\": null,\n \"data_baixa\": null,\n \"nome_situacao\": \"PROCESSANDO CANCELAMENTO\",\n \"id_pagador\": null,\n \"nome_pagador\": null,\n \"codigo_rastreio\": null,\n \"texto_instrucao\": \"Cobrança referente a...|Vencimento após dia...|Demais instruções... [23792.85600 99011.265941 61022.265203 5 11580000007999]\",\n \"identificador_externo\": \"666613c5-c0b9-4d65-8c8c-263e40fe988e\",\n \"soma_saldo\": \"688.60\",\n \"id_empresa\": 329,\n \"texto_descricao\": \"AGUARDANDO PAGAMENTO\",\n \"nome_banco\": null,\n \"codigo\": null,\n \"agencia\": null,\n \"id_recebedor\": null,\n \"nome_recebedor\": null,\n \"tipo_baixa\": null\n },\n {\n \"sigla\": \"boletoCobranca\",\n \"nome_servico\": \"BOLETO\",\n \"id\": 1180,\n \"id_transacao\": 11704,\n \"valor_bruto\": \"79.99\",\n \"valor_taxa\": \"0.00\",\n \"data_criacao\": \"2025-07-23 10:47:57\",\n \"data_efetivacao\": null,\n \"data_baixa\": null,\n \"nome_situacao\": \"CRIADO\",\n \"id_pagador\": null,\n \"nome_pagador\": null,\n \"codigo_rastreio\": null,\n \"texto_instrucao\": null,\n \"identificador_externo\": \"51ddc7f3-bbec-47e5-aedb-d336c3463bb5\",\n \"soma_saldo\": \"688.60\",\n \"id_empresa\": 329,\n \"texto_descricao\": \"AGUARDANDO PAGAMENTO\",\n \"nome_banco\": null,\n \"codigo\": null,\n \"agencia\": null,\n \"id_recebedor\": null,\n \"nome_recebedor\": null,\n \"tipo_baixa\": null\n },\n {\n \"sigla\": \"boletoCobranca\",\n \"nome_servico\": \"BOLETO\",\n \"id\": 1179,\n \"id_transacao\": 11687,\n \"valor_bruto\": \"79.99\",\n \"valor_taxa\": \"0.00\",\n \"data_criacao\": \"2025-07-23 08:47:55\",\n \"data_efetivacao\": null,\n \"data_baixa\": null,\n \"nome_situacao\": \"FALHA\",\n \"id_pagador\": null,\n \"nome_pagador\": null,\n \"codigo_rastreio\": null,\n \"texto_instrucao\": null,\n \"identificador_externo\": \"181f66d6-4761-4b93-bdad-f71f54e5e8a4\",\n \"soma_saldo\": \"688.60\",\n \"id_empresa\": 329,\n \"texto_descricao\": \"AGUARDANDO PAGAMENTO\",\n \"nome_banco\": null,\n \"codigo\": null,\n \"agencia\": null,\n \"id_recebedor\": null,\n \"nome_recebedor\": null,\n \"tipo_baixa\": null\n }\n ]\n}"},{"id":"fb93f2d2-7576-431c-be04-cfd6177016ae","name":"Sucesso - Sem dados","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"data_inicial\": \"2025-03-01\",\r\n \"data_final\": \"2025-03-31\"\r\n}","options":{"raw":{"language":"json"}}},"url":"/bt/consulta_boletos"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 24 Jul 2025 21:02:58 GMT"},{"key":"Server","value":"Apache/2.4.58 (Ubuntu)"},{"key":"vary","value":"origin,accept-encoding"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"cache-control","value":"no-cache"},{"key":"content-encoding","value":"gzip"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 400,\n \"mensagem\": \"Registros não encontrados\",\n \"data\": \"\"\n}"}],"_postman_id":"17ef6982-2177-42bb-bb87-c2e04f3f611a"},{"name":"Cancelar Boleto","id":"fae81ce9-cb4e-4ae4-b4d2-460f012c7c89","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{}},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"id_boleto\": \"1185\" \r\n}","options":{"raw":{"language":"json"}}},"url":"/bt/cancelar_boleto","description":"

\n
⚠️ Este recurso não está disponível em SandBox
\n

Descrição

Esta rota inicia o processo de cancelamento de um boleto, enviando a solicitação ao agente bancário responsável pela liquidação.

Após a solicitação ser registrada, o status da cobrança é atualizado para PROCESSINGCANCELLATION, indicando que o cancelamento está em andamento.

⚠️ Atenção:
Na processadora de boletos, o cancelamento é efetivado imediatamente após a solicitação. Nesses casos, qualquer tentativa de pagamento posterior será automaticamente recusada. Entretanto, na API Canvi o cancelamento é assíncrono e ocorre durante o processamento noturno. A efetivação ocorre diariamente às 6h (UTC-3), até esse momento, a cobrança permanece com status PROCESSINGCANCELLATION. Somente após a conclusão bem-sucedida do processo, o status será atualizado definitivamente para CANCELED.

Corpo da Requisição

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

Campo	Tipo	Descrição
id_boleto	string / number	id da cobrança, retornado no corpo da resposta de criação do boleto.

","urlObject":{"path":["bt","cancelar_boleto"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"c59aa17a-ffab-47ec-a443-c2dec4477d26","name":"Sucesso - Com dados","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text","disabled":true}],"body":{"mode":"raw","raw":"{\r\n \"id_boleto\": \"1185\" \r\n}","options":{"raw":{"language":"json"}}},"url":"/bt/cancelar_boleto"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 24 Jul 2025 20:18:18 GMT"},{"key":"Server","value":"Apache/2.4.58 (Ubuntu)"},{"key":"vary","value":"origin,accept-encoding"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"cache-control","value":"no-cache"},{"key":"content-encoding","value":"gzip"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"mensagem\": \"Solicitação de cancelamento de boleto realizada com sucesso!\",\n \"data\": {\n \"id_boleto\": 1185,\n \"valor\": \"79.99\"\n }\n}"},{"id":"34a1001d-3c99-4400-b38c-2f8c3530af18","name":"Sucesso - Sem dados","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text","disabled":true}],"body":{"mode":"raw","raw":"{\r\n \"id_boleto\": \"118556\" \r\n}","options":{"raw":{"language":"json"}}},"url":"/bt/cancelar_boleto"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 28 Jul 2025 18:24:21 GMT"},{"key":"Server","value":"Apache/2.4.58 (Ubuntu)"},{"key":"vary","value":"origin,accept-encoding"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"cache-control","value":"no-cache"},{"key":"content-encoding","value":"gzip"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 400,\n \"mensagem\": \"Documento não encontrado\",\n \"data\": \"\"\n}"}],"_postman_id":"fae81ce9-cb4e-4ae4-b4d2-460f012c7c89"},{"name":"Simular Pagamento","id":"62d65074-240c-4eda-9b51-00469e209240","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"id\": 1434,\r\n \"tipo_transacao\": \"boletoCashin\",\r\n \"boleto\": {\r\n \"pagamento\": {\r\n \"valor\": \"79.99\",\r\n \"data\": \"2025-08-04T11:10:00\",\r\n \"pix\": {\r\n \"E2EId\": \"E5336713439632507523\" \r\n } \r\n }\r\n \r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"/bt/desenvolvedor/simular_baixa","description":"

Descrição

\n
⚠️ Recurso exclusivo para ambiente SandBox
\n

Esta rota permite simular o pagamento de uma cobrança do tipo Boleto, sendo ideal para testes e validações durante o processo de integração com a API.

Corpo da Requisiçã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

Campo	Tipo	Descrição
id*	string / number	ID do Boleto que deseja simular o pagamento.
tipo_transacao*	string	Deve ser preenchido com boletoCashin para indicar que a transação é do tipo Boleto Bancário.
boleto	object	Objeto que agrupa os dados de pagamento do boleto.

Pagamento

\n\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 de `boleto.pagamento`	Tipo	Descrição
valor*	string	Valor que deseja simular no pagamento. Deve ser informado com duas casas decimais.
data*	date	Data simulada em que o pagamento foi realizado.
pix	object	Objeto contendo o E2EId (código end-to-end) de um pagamento via Pix. Se informado, o sistema considerará que o boleto foi pago via Pix.

","urlObject":{"path":["bt","desenvolvedor","simular_baixa"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"99948bb3-8b3d-4ab1-bdc9-6f501ef7262e","name":"Sucesso","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"id\": 1434,\r\n \"tipo_transacao\": \"boletoCashin\",\r\n \"boleto\": {\r\n \"pagamento\": {\r\n \"valor\": \"79.99\",\r\n \"data\": \"2025-08-04T11:10:00\",\r\n \"pix\": {\r\n \"E2EId\": \"E5336713439632507523\" \r\n } \r\n }\r\n \r\n }\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"/bt/desenvolvedor/simular_baixa"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 01 Aug 2025 17:35:03 GMT"},{"key":"Server","value":"Apache/2.4.58 (Ubuntu)"},{"key":"vary","value":"origin,accept-encoding"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"cache-control","value":"no-cache"},{"key":"content-encoding","value":"gzip"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"mensagem\": \"Informação Recebida\",\n \"data\": \"\"\n}"}],"_postman_id":"62d65074-240c-4eda-9b51-00469e209240"}],"id":"28cc5d1b-342d-4ea8-8760-f3ebe8822d84","description":"

Descrição

A cobrança via Boleto Bancário é uma alternativa tradicional e amplamente aceita no mercado brasileiro, ideal para clientes que preferem pagar fora do ambiente digital ou que buscam alternativas aos cartões ou Pix.

O processo de geração de boletos pela API permite total automação, definição de vencimento, multa, juros e identificação do pagador. A compensação bancária segue as regras da rede bancária nacional.

Características principais

Geração de boleto com:
\n
- Valor fixo e vencimento personalizado
  \n
- Nome e CPF/CNPJ do pagador
  \n
- Descrição da cobrança
  \n
- Multa, juros e desconto (opcional)
  \n
\n
Linha digitável para pagamento manual
\n
URL de visualização e impressão
\n
Layout compatível com as principais carteiras e apps bancários
\n

Suporta:

Consulta do status do boleto
\n
Cancelamento da cobrança
\n
Notificações por Webhook
\n
Identificação por nosso número para reconciliação
\n

Recomendações de uso

A cobrança via boleto é ideal para:

Plataformas de serviços com opção de pagamento offline
\n
Cobranças com vencimento agendado
\n
Cobranças de valores altos até R$20.000,00
\n

Vantagens

Ampla aceitação no mercado brasileiro
\n
Pagamento pode ser feito em qualquer banco, lotérica ou pix
\n
Vencimento flexível
\n
Integração simples com sistemas de ERP e contabilidade
\n

Fluxo de Cobrança com Boleto

Geração

\n $\"Fluxo%20de%20geração%20do%20boleto\"$ \n\n

Liquidação

\n $\"Fluxo%20de%20liquidação%20dos%20pagamentos\"$ \n\n

Status da Cobrança

Durante o ciclo de vida de um boleto, os seguintes status podem ser atribuídos:

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

Status	Descrição
`CREATED`	O boleto foi criado com sucesso e está aguardando pagamento.
`PAID`	O pagamento foi confirmado, mas ainda não compensado.
`CREDITED`	O valor foi compensado e o boleto está totalmente quitado.
`EXPIRED`	O boleto venceu e não foi pago até a data de vencimento.
`PROCESSINGCANCELLATION`	O boleto está em processo de cancelamento, que acontece todos os dias às 6h (UTC-3).
`CANCELED`	O boleto foi cancelado antes do vencimento.

Observações Importantes

A liquidação do pagamento ocorre toda manhã as 6h (UTC-3).
\n
É possível aplicar descontos à cobrança se ela for paga antes do vencimento.
\n
Após o vencimento, é possível aplicar juros e multas à cobrança.
\n
Após o vencimento, a cobrança será válida pelo período específicado na geração da cobrança, até finalmente expirar.
\n

\n","_postman_id":"28cc5d1b-342d-4ea8-8760-f3ebe8822d84"}],"id":"2b7079a6-1a25-44f3-b643-55ac762dc18b","description":"

Agora que você já está autenticado, é hora de integrar sua aplicação aos recursos de cobrança da API Canvi. Nossa plataforma oferece suporte completo para emissão e acompanhamento de cobranças nos principais meios de pagamento:

Pix — nas modalidades dinâmico e estático
\n
Boletos bancários
\n
Cartões — débito, crédito e voucher
\n

Também oferecemos funcionalidades avançadas para diferentes modelos de negócio, como:

Split de pagamentos — ideal para marketplaces
\n
Cobrança recorrente (assinaturas) — em breve disponível
\n

Recursos disponíveis

A API da Canvi foi projetada para oferecer controle total sobre o ciclo de vida das cobranças, da geração ao encerramento. Entre as principais operações disponíveis, você pode:

Consultar o status e os detalhes de cobranças
\n
Cancelar cobranças ativas (quando aplicável)
\n
Iniciar processos de devolução de valores
\n
Simular pagamentos — ideal para testes e ambientes de homologação.
\n

\n
Todos os recursos foram desenvolvidos para proporcionar uma integração segura, transparente e eficiente — facilitando desde a criação da cobrança até o recebimento ou cancelamento do pagamento.
\n

\n","_postman_id":"2b7079a6-1a25-44f3-b643-55ac762dc18b"},{"name":"Split","item":[{"name":"Consulta por Periodo","id":"e603525f-31c7-4825-879b-dc00a6af756b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"data_inicial\": \"2023-05-01\",\r\n \"data_final\": \"2023-06-30\"\r\n}","options":{"raw":{"language":"json"}}},"url":"/bt/split/periodo","urlObject":{"path":["bt","split","periodo"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"204c300d-0ce0-4a07-91e8-94a47ddfaae4","name":"Consultar Extrato Detalhado","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"data_inicial\": \"2023-05-01\",\r\n \"data_final\": \"2023-06-30\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox-gateway.service-canvi.com.br:8080/bt/transferencia_extrato_detalhado"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"vary","value":"origin,accept-encoding"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"cache-control","value":"no-cache"},{"key":"content-encoding","value":"gzip"},{"key":"Date","value":"Wed, 14 Aug 2024 15:17:27 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"mensagem\": \"Extrato Detalhado\",\n \"data\": [\n {\n \"sigla\": \"retiradaSaldo\",\n \"nome_servico\": \"RETIRADA DE SALDO\",\n \"id\": 94281,\n \"id_transacao\": 317,\n \"valor_bruto\": \"20.00\",\n \"valor_taxa\": \"2.80\",\n \"data_criacao\": \"2023-05-04T14:29:44.000Z\",\n \"data_efetivacao\": \"2023-05-04T14:32:12.000Z\",\n \"data_baixa\": \"2023-05-04T14:29:44.000Z\",\n \"nome_situacao\": \"FALHA\",\n \"id_pagador\": null,\n \"nome_pagador\": null,\n \"codigo_rastreio\": null,\n \"texto_instrucao\": null,\n \"identificador_externo\": \"r8n_2AFmrxQOqOQ3VkVL\",\n \"soma_saldo\": \"-531.93\",\n \"id_empresa\": 2,\n \"texto_descricao\": \"KGKEZ Ltda.\",\n \"nome_banco\": \"\",\n \"codigo\": null,\n \"agencia\": \"4019\",\n \"id_recebedor\": \"00.255.365/0001-67\",\n \"nome_recebedor\": \"KGKEZ Ltda.\",\n \"data_previsao_repasse\": null\n },\n {\n \"sigla\": \"retiradaSaldo\",\n \"nome_servico\": \"RETIRADA DE SALDO\",\n \"id\": 94280,\n \"id_transacao\": 298,\n \"valor_bruto\": \"50.10\",\n \"valor_taxa\": \"2.80\",\n \"data_criacao\": \"2023-04-30T02:06:00.000Z\",\n \"data_efetivacao\": \"2023-04-30T02:08:23.000Z\",\n \"data_baixa\": \"2023-04-30T02:06:00.000Z\",\n \"nome_situacao\": \"EFETUADO\",\n \"id_pagador\": null,\n \"nome_pagador\": null,\n \"codigo_rastreio\": null,\n \"texto_instrucao\": null,\n \"identificador_externo\": \"hOn0t4upnpTGKQ-xMm67\",\n \"soma_saldo\": \"-531.93\",\n \"id_empresa\": 2,\n \"texto_descricao\": \"Millard Rowe\",\n \"nome_banco\": \"\",\n \"codigo\": null,\n \"agencia\": \"8531\",\n \"id_recebedor\": \"***.102.752-**\",\n \"nome_recebedor\": \"Millard Rowe\",\n \"data_previsao_repasse\": null\n }\n ]\n}"}],"_postman_id":"e603525f-31c7-4825-879b-dc00a6af756b"},{"name":"Ajustar Split","id":"9e232684-b6b5-4c40-b0e9-4de7fbe0fd82","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"id_transacao\": 17298,\r\n \"id_split\": 26167,\r\n \"tipo_ajuste\": \"reverter\" // reverter, antecipar \r\n}","options":{"raw":{"language":"json"}}},"url":"/bt/split/ajuste","urlObject":{"path":["bt","split","ajuste"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"10a6b157-b844-466d-84cc-1bcc0baf6692","name":"Consultar Extrato Detalhado","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"data_inicial\": \"2023-05-01\",\r\n \"data_final\": \"2023-06-30\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox-gateway.service-canvi.com.br:8080/bt/transferencia_extrato_detalhado"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"vary","value":"origin,accept-encoding"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"cache-control","value":"no-cache"},{"key":"content-encoding","value":"gzip"},{"key":"Date","value":"Wed, 14 Aug 2024 15:17:27 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"mensagem\": \"Extrato Detalhado\",\n \"data\": [\n {\n \"sigla\": \"retiradaSaldo\",\n \"nome_servico\": \"RETIRADA DE SALDO\",\n \"id\": 94281,\n \"id_transacao\": 317,\n \"valor_bruto\": \"20.00\",\n \"valor_taxa\": \"2.80\",\n \"data_criacao\": \"2023-05-04T14:29:44.000Z\",\n \"data_efetivacao\": \"2023-05-04T14:32:12.000Z\",\n \"data_baixa\": \"2023-05-04T14:29:44.000Z\",\n \"nome_situacao\": \"FALHA\",\n \"id_pagador\": null,\n \"nome_pagador\": null,\n \"codigo_rastreio\": null,\n \"texto_instrucao\": null,\n \"identificador_externo\": \"r8n_2AFmrxQOqOQ3VkVL\",\n \"soma_saldo\": \"-531.93\",\n \"id_empresa\": 2,\n \"texto_descricao\": \"KGKEZ Ltda.\",\n \"nome_banco\": \"\",\n \"codigo\": null,\n \"agencia\": \"4019\",\n \"id_recebedor\": \"00.255.365/0001-67\",\n \"nome_recebedor\": \"KGKEZ Ltda.\",\n \"data_previsao_repasse\": null\n },\n {\n \"sigla\": \"retiradaSaldo\",\n \"nome_servico\": \"RETIRADA DE SALDO\",\n \"id\": 94280,\n \"id_transacao\": 298,\n \"valor_bruto\": \"50.10\",\n \"valor_taxa\": \"2.80\",\n \"data_criacao\": \"2023-04-30T02:06:00.000Z\",\n \"data_efetivacao\": \"2023-04-30T02:08:23.000Z\",\n \"data_baixa\": \"2023-04-30T02:06:00.000Z\",\n \"nome_situacao\": \"EFETUADO\",\n \"id_pagador\": null,\n \"nome_pagador\": null,\n \"codigo_rastreio\": null,\n \"texto_instrucao\": null,\n \"identificador_externo\": \"hOn0t4upnpTGKQ-xMm67\",\n \"soma_saldo\": \"-531.93\",\n \"id_empresa\": 2,\n \"texto_descricao\": \"Millard Rowe\",\n \"nome_banco\": \"\",\n \"codigo\": null,\n \"agencia\": \"8531\",\n \"id_recebedor\": \"***.102.752-**\",\n \"nome_recebedor\": \"Millard Rowe\",\n \"data_previsao_repasse\": null\n }\n ]\n}"}],"_postman_id":"9e232684-b6b5-4c40-b0e9-4de7fbe0fd82"}],"id":"3fc50836-07d2-43a7-8436-eb975891ab20","_postman_id":"3fc50836-07d2-43a7-8436-eb975891ab20","description":""},{"name":"Clientes","item":[{"name":"Consultar/Listar Clientes","id":"f3af40e8-4a3f-469b-acc4-6d0bb3d8a4ab","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[{"key":"cnpj_unidade","value":"23867835000149","type":"text","disabled":true}]},"url":"/bt/clientes","urlObject":{"path":["bt","clientes"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"34598861-78a1-441c-a9ed-8dcc42dfdd52","name":"Clientes","originalRequest":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[{"key":"cnpj_unidade","value":"23867835000149","type":"text","disabled":true}]},"url":"/bt/clientes"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 20 May 2025 20:22:26 GMT"},{"key":"Server","value":"Apache/2.4.58 (Ubuntu)"},{"key":"vary","value":"origin,accept-encoding"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"cache-control","value":"no-cache"},{"key":"content-encoding","value":"gzip"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"mensagem\": \"Consulta Cliente\",\n \"data\": [\n {\n \"id\": 2,\n \"nome\": \"Diandro Viana\",\n \"numero_documento\": \"74467408096\",\n \"tipo_documento\": \"cpf\",\n \"email\": \"eduarda@gmail.com\",\n \"numero_celular\": null\n },\n {\n \"id\": 4,\n \"nome\": \"Eric Vieira\",\n \"numero_documento\": \"74467408081\",\n \"tipo_documento\": \"cpf\",\n \"email\": \"diandro@gmail.com\",\n \"numero_celular\": null\n }\n ]\n}"}],"_postman_id":"f3af40e8-4a3f-469b-acc4-6d0bb3d8a4ab"},{"name":"Consultar Extrato Detalhado por Cliente","id":"14e1abd3-16f4-4161-bd94-b6aeb6b03a83","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"data_inicial","value":"2023-05-01","type":"text"},{"key":"data_final","value":"2024-06-30","type":"text"},{"key":"id_cliente","value":"2","type":"text"}]},"url":"/bt/cliente_detalhado","urlObject":{"path":["bt","cliente_detalhado"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"14e1abd3-16f4-4161-bd94-b6aeb6b03a83"}],"id":"719acca3-8af1-4db4-bd72-62773554959e","description":"

Os Clientes representam os pagadores finais das cobranças emitidas via API Canvi.

Durante a geração de uma cobrança, é possível associar um cliente específico, e essas informações são registradas em nossa base de dados, vinculadas à conta emissora da cobrança.

Dessa forma, você consegue manter um histórico organizado, identificar facilmente os clientes da sua plataforma e consultar o extrato completo das cobranças relacionadas a cada um deles.

Abaixo estão listados os endpoints disponíveis para consulta e gerenciamento de clientes.

\n","_postman_id":"719acca3-8af1-4db4-bd72-62773554959e"},{"name":"Minha Conta","item":[{"name":"Extrato","item":[{"name":"Consultar Extrato Sintético","id":"2871189a-daac-422c-98dc-d4c870cde82d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"data_inicial\": \"2023-05-01\",\r\n \"data_final\": \"2023-06-30\"\r\n}","options":{"raw":{"language":"json"}}},"url":"/bt/transferencia_extrato_sintetico","urlObject":{"path":["bt","transferencia_extrato_sintetico"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"a4bcee7f-7586-4370-a830-1136fce51474","name":"Consultar Extrato Sintético","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"data_inicial\": \"2023-05-01\",\r\n \"data_final\": \"2023-06-30\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox-gateway.service-canvi.com.br:8080/bt/transferencia_extrato_sintetico"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"vary","value":"origin,accept-encoding"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"cache-control","value":"no-cache"},{"key":"content-encoding","value":"gzip"},{"key":"Date","value":"Wed, 14 Aug 2024 15:17:00 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"mensagem\": \"Extrato Sintetico\",\n \"data\": [\n {\n \"nome_servico\": \"Saldo Inicial\",\n \"soma_valor_bruto\": \"47037.88\",\n \"quantidade\": 1,\n \"ordem\": 1\n }\n ]\n}"}],"_postman_id":"2871189a-daac-422c-98dc-d4c870cde82d"},{"name":"Consultar Extrato Detalhado","id":"1b3ff758-0c81-4068-9aa3-fa75359cb0df","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"data_inicial\": \"2023-05-01\",\r\n \"data_final\": \"2023-06-30\"\r\n}","options":{"raw":{"language":"json"}}},"url":"/bt/transferencia_extrato_detalhado","urlObject":{"path":["bt","transferencia_extrato_detalhado"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"d80e3070-da6b-4717-bc8a-1ca81529f3ec","name":"Consultar Extrato Detalhado","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"data_inicial\": \"2023-05-01\",\r\n \"data_final\": \"2023-06-30\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox-gateway.service-canvi.com.br:8080/bt/transferencia_extrato_detalhado"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"vary","value":"origin,accept-encoding"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"cache-control","value":"no-cache"},{"key":"content-encoding","value":"gzip"},{"key":"Date","value":"Wed, 14 Aug 2024 15:17:27 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"mensagem\": \"Extrato Detalhado\",\n \"data\": [\n {\n \"sigla\": \"retiradaSaldo\",\n \"nome_servico\": \"RETIRADA DE SALDO\",\n \"id\": 94281,\n \"id_transacao\": 317,\n \"valor_bruto\": \"20.00\",\n \"valor_taxa\": \"2.80\",\n \"data_criacao\": \"2023-05-04T14:29:44.000Z\",\n \"data_efetivacao\": \"2023-05-04T14:32:12.000Z\",\n \"data_baixa\": \"2023-05-04T14:29:44.000Z\",\n \"nome_situacao\": \"FALHA\",\n \"id_pagador\": null,\n \"nome_pagador\": null,\n \"codigo_rastreio\": null,\n \"texto_instrucao\": null,\n \"identificador_externo\": \"r8n_2AFmrxQOqOQ3VkVL\",\n \"soma_saldo\": \"-531.93\",\n \"id_empresa\": 2,\n \"texto_descricao\": \"KGKEZ Ltda.\",\n \"nome_banco\": \"\",\n \"codigo\": null,\n \"agencia\": \"4019\",\n \"id_recebedor\": \"00.255.365/0001-67\",\n \"nome_recebedor\": \"KGKEZ Ltda.\"\n },\n {\n \"sigla\": \"retiradaSaldo\",\n \"nome_servico\": \"RETIRADA DE SALDO\",\n \"id\": 94280,\n \"id_transacao\": 298,\n \"valor_bruto\": \"50.10\",\n \"valor_taxa\": \"2.80\",\n \"data_criacao\": \"2023-04-30T02:06:00.000Z\",\n \"data_efetivacao\": \"2023-04-30T02:08:23.000Z\",\n \"data_baixa\": \"2023-04-30T02:06:00.000Z\",\n \"nome_situacao\": \"EFETUADO\",\n \"id_pagador\": null,\n \"nome_pagador\": null,\n \"codigo_rastreio\": null,\n \"texto_instrucao\": null,\n \"identificador_externo\": \"hOn0t4upnpTGKQ-xMm67\",\n \"soma_saldo\": \"-531.93\",\n \"id_empresa\": 2,\n \"texto_descricao\": \"Millard Rowe\",\n \"nome_banco\": \"\",\n \"codigo\": null,\n \"agencia\": \"8531\",\n \"id_recebedor\": \"***.102.752-**\",\n \"nome_recebedor\": \"Millard Rowe\"\n }\n ]\n}"}],"_postman_id":"1b3ff758-0c81-4068-9aa3-fa75359cb0df"},{"name":"Consultar Extrato Consolidado Diário","id":"89c91053-01be-483e-b94a-bfc10a50df5b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"data_inicial\": \"2023-05-01\",\r\n \"data_final\": \"2023-06-30\"\r\n}","options":{"raw":{"language":"json"}}},"url":"/bt/transferencia_extrato_diario","urlObject":{"path":["bt","transferencia_extrato_diario"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"e3fbe698-8164-47e7-a231-c31f5c5382bb","name":"Consultar Extrato Consolidado Diário","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"data_inicial\": \"2023-05-01\",\r\n \"data_final\": \"2023-06-30\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{url_sandbox_canvi}}/bt/transferencia_extrato_diario"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"vary","value":"origin,accept-encoding"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"cache-control","value":"no-cache"},{"key":"content-encoding","value":"gzip"},{"key":"Date","value":"Wed, 14 Aug 2024 15:17:49 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"mensagem\": \"Extrato Diário\",\n \"data\": [\n {\n \"data\": \"2023-04-30\",\n \"nome_servico\": \"Saldo Inicial\",\n \"soma_valor_bruto\": \"47037.88\",\n \"quantidade\": 1,\n \"ordem\": 1\n },\n {\n \"data\": \"2023-06-29\",\n \"nome_servico\": \"Saldo Final\",\n \"soma_valor_bruto\": \"329812.38\",\n \"quantidade\": 1,\n \"ordem\": 10\n }\n ]\n}"}],"_postman_id":"89c91053-01be-483e-b94a-bfc10a50df5b"},{"name":"Consultar Histórico Status","id":"d85c5fcd-2f6a-4be7-8eff-5acb6023227b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"id_transacao\":\"2920\",\r\n \"tipo_transacao\": \"invoicePix\"\r\n}","options":{"raw":{"language":"json"}}},"url":"/bt/consulta_status","urlObject":{"path":["bt","consulta_status"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"832fe558-1827-4227-8c67-56ea05b8f01a","name":"Consultar Extrato Consolidado Diário","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"data_inicial\": \"2023-05-01\",\r\n \"data_final\": \"2023-06-30\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{url_sandbox_canvi}}/bt/transferencia_extrato_diario"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"vary","value":"origin,accept-encoding"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"cache-control","value":"no-cache"},{"key":"content-encoding","value":"gzip"},{"key":"Date","value":"Wed, 14 Aug 2024 15:17:49 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"mensagem\": \"Extrato Diário\",\n \"data\": [\n {\n \"data\": \"2023-04-30\",\n \"nome_servico\": \"Saldo Inicial\",\n \"soma_valor_bruto\": \"47037.88\",\n \"quantidade\": 1,\n \"ordem\": 1\n },\n {\n \"data\": \"2023-06-29\",\n \"nome_servico\": \"Saldo Final\",\n \"soma_valor_bruto\": \"329812.38\",\n \"quantidade\": 1,\n \"ordem\": 10\n }\n ]\n}"}],"_postman_id":"d85c5fcd-2f6a-4be7-8eff-5acb6023227b"}],"id":"5d8855dd-8e7e-491c-8c20-daaa5f9b2864","_postman_id":"5d8855dd-8e7e-491c-8c20-daaa5f9b2864","description":""},{"name":"Consulta","item":[{"name":"Consultar Saldo","id":"27ce161a-8f0b-408a-887e-5735f5ce2c30","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"/bt/saldo","description":"

Descrição

Esta rota permite consultar o saldo atual da sua conta Canvi, juntamente com a data da última atualização e o código identificador da conta.

\n","urlObject":{"path":["bt","saldo"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"ddec50b9-95c4-4fbe-ba0d-4fb70cfa59e1","name":"Sucesso","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"/bt/saldo"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 04 Aug 2025 21:10:58 GMT"},{"key":"Server","value":"Apache/2.4.58 (Ubuntu)"},{"key":"vary","value":"origin,accept-encoding"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"cache-control","value":"no-cache"},{"key":"content-encoding","value":"gzip"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"code\": 200,\n \"mensagem\": \"Saldo da Empresa\",\n \"data\": {\n \"soma_saldo\": \"1276.62\",\n \"data_atualizacao\": \"2025-08-04 16:46:35\",\n \"conta\": \"91cak4f9-4u72-17f0-a36f-42810b400012\"\n }\n}"}],"_postman_id":"27ce161a-8f0b-408a-887e-5735f5ce2c30"},{"name":"Consultar Consulta Detalhado","id":"ec39da66-e527-4fb4-9c09-5b0c9eb14965","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"data_inicial\": \"2023-05-01\",\r\n \"data_final\": \"2023-06-30\"\r\n}","options":{"raw":{"language":"json"}}},"url":"/bt/consulta/detalhado","urlObject":{"path":["bt","consulta","detalhado"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"c621b593-7262-4dbd-8406-b67e26e01e96","name":"Consultar Extrato Detalhado","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"data_inicial\": \"2023-05-01\",\r\n \"data_final\": \"2023-06-30\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox-gateway.service-canvi.com.br:8080/bt/transferencia_extrato_detalhado"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"vary","value":"origin,accept-encoding"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"cache-control","value":"no-cache"},{"key":"content-encoding","value":"gzip"},{"key":"Date","value":"Wed, 14 Aug 2024 15:17:27 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"mensagem\": \"Extrato Detalhado\",\n \"data\": [\n {\n \"sigla\": \"retiradaSaldo\",\n \"nome_servico\": \"RETIRADA DE SALDO\",\n \"id\": 94281,\n \"id_transacao\": 317,\n \"valor_bruto\": \"20.00\",\n \"valor_taxa\": \"2.80\",\n \"data_criacao\": \"2023-05-04T14:29:44.000Z\",\n \"data_efetivacao\": \"2023-05-04T14:32:12.000Z\",\n \"data_baixa\": \"2023-05-04T14:29:44.000Z\",\n \"nome_situacao\": \"FALHA\",\n \"id_pagador\": null,\n \"nome_pagador\": null,\n \"codigo_rastreio\": null,\n \"texto_instrucao\": null,\n \"identificador_externo\": \"r8n_2AFmrxQOqOQ3VkVL\",\n \"soma_saldo\": \"-531.93\",\n \"id_empresa\": 2,\n \"texto_descricao\": \"KGKEZ Ltda.\",\n \"nome_banco\": \"\",\n \"codigo\": null,\n \"agencia\": \"4019\",\n \"id_recebedor\": \"00.255.365/0001-67\",\n \"nome_recebedor\": \"KGKEZ Ltda.\",\n \"data_previsao_repasse\": null\n },\n {\n \"sigla\": \"retiradaSaldo\",\n \"nome_servico\": \"RETIRADA DE SALDO\",\n \"id\": 94280,\n \"id_transacao\": 298,\n \"valor_bruto\": \"50.10\",\n \"valor_taxa\": \"2.80\",\n \"data_criacao\": \"2023-04-30T02:06:00.000Z\",\n \"data_efetivacao\": \"2023-04-30T02:08:23.000Z\",\n \"data_baixa\": \"2023-04-30T02:06:00.000Z\",\n \"nome_situacao\": \"EFETUADO\",\n \"id_pagador\": null,\n \"nome_pagador\": null,\n \"codigo_rastreio\": null,\n \"texto_instrucao\": null,\n \"identificador_externo\": \"hOn0t4upnpTGKQ-xMm67\",\n \"soma_saldo\": \"-531.93\",\n \"id_empresa\": 2,\n \"texto_descricao\": \"Millard Rowe\",\n \"nome_banco\": \"\",\n \"codigo\": null,\n \"agencia\": \"8531\",\n \"id_recebedor\": \"***.102.752-**\",\n \"nome_recebedor\": \"Millard Rowe\",\n \"data_previsao_repasse\": null\n }\n ]\n}"}],"_postman_id":"ec39da66-e527-4fb4-9c09-5b0c9eb14965"},{"name":"Consulta Split Tarifa","id":"7c198a0b-3f11-4242-83e4-bcfcb3bac5ea","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"data_inicial\": \"2023-05-01\",\r\n \"data_final\": \"2023-06-30\"\r\n}","options":{"raw":{"language":"json"}}},"url":"/bt/consulta_split_tarifa","urlObject":{"path":["bt","consulta_split_tarifa"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"b3735e13-4e28-4e35-acce-7a4752ff3388","name":"Consultar Extrato Detalhado","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"data_inicial\": \"2023-05-01\",\r\n \"data_final\": \"2023-06-30\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox-gateway.service-canvi.com.br:8080/bt/transferencia_extrato_detalhado"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"vary","value":"origin,accept-encoding"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"cache-control","value":"no-cache"},{"key":"content-encoding","value":"gzip"},{"key":"Date","value":"Wed, 14 Aug 2024 15:17:27 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"mensagem\": \"Extrato Detalhado\",\n \"data\": [\n {\n \"sigla\": \"retiradaSaldo\",\n \"nome_servico\": \"RETIRADA DE SALDO\",\n \"id\": 94281,\n \"id_transacao\": 317,\n \"valor_bruto\": \"20.00\",\n \"valor_taxa\": \"2.80\",\n \"data_criacao\": \"2023-05-04T14:29:44.000Z\",\n \"data_efetivacao\": \"2023-05-04T14:32:12.000Z\",\n \"data_baixa\": \"2023-05-04T14:29:44.000Z\",\n \"nome_situacao\": \"FALHA\",\n \"id_pagador\": null,\n \"nome_pagador\": null,\n \"codigo_rastreio\": null,\n \"texto_instrucao\": null,\n \"identificador_externo\": \"r8n_2AFmrxQOqOQ3VkVL\",\n \"soma_saldo\": \"-531.93\",\n \"id_empresa\": 2,\n \"texto_descricao\": \"KGKEZ Ltda.\",\n \"nome_banco\": \"\",\n \"codigo\": null,\n \"agencia\": \"4019\",\n \"id_recebedor\": \"00.255.365/0001-67\",\n \"nome_recebedor\": \"KGKEZ Ltda.\",\n \"data_previsao_repasse\": null\n },\n {\n \"sigla\": \"retiradaSaldo\",\n \"nome_servico\": \"RETIRADA DE SALDO\",\n \"id\": 94280,\n \"id_transacao\": 298,\n \"valor_bruto\": \"50.10\",\n \"valor_taxa\": \"2.80\",\n \"data_criacao\": \"2023-04-30T02:06:00.000Z\",\n \"data_efetivacao\": \"2023-04-30T02:08:23.000Z\",\n \"data_baixa\": \"2023-04-30T02:06:00.000Z\",\n \"nome_situacao\": \"EFETUADO\",\n \"id_pagador\": null,\n \"nome_pagador\": null,\n \"codigo_rastreio\": null,\n \"texto_instrucao\": null,\n \"identificador_externo\": \"hOn0t4upnpTGKQ-xMm67\",\n \"soma_saldo\": \"-531.93\",\n \"id_empresa\": 2,\n \"texto_descricao\": \"Millard Rowe\",\n \"nome_banco\": \"\",\n \"codigo\": null,\n \"agencia\": \"8531\",\n \"id_recebedor\": \"***.102.752-**\",\n \"nome_recebedor\": \"Millard Rowe\",\n \"data_previsao_repasse\": null\n }\n ]\n}"}],"_postman_id":"7c198a0b-3f11-4242-83e4-bcfcb3bac5ea"},{"name":"Consultar Retirada Detalhado","id":"15dd12f8-7c54-4ff1-a87c-89c43c937394","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"/bt/extrato/retirada/detalhado","description":"

Descrição

Esta rota permite consultar o saldo atual da sua conta Canvi, juntamente com a data da última atualização e o código identificador da conta.

\n","urlObject":{"path":["bt","extrato","retirada","detalhado"],"host":[""],"query":[{"disabled":true,"key":"id_transacao","value":"519319"},{"disabled":true,"key":"pagina","value":""},{"disabled":true,"key":"limite","value":""}],"variable":[]}},"response":[{"id":"773f0c3d-0bd6-4477-a08f-b4a7d496ce2f","name":"Sucesso","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"/bt/saldo"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 04 Aug 2025 21:10:58 GMT"},{"key":"Server","value":"Apache/2.4.58 (Ubuntu)"},{"key":"vary","value":"origin,accept-encoding"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"cache-control","value":"no-cache"},{"key":"content-encoding","value":"gzip"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"code\": 200,\n \"mensagem\": \"Saldo da Empresa\",\n \"data\": {\n \"soma_saldo\": \"1276.62\",\n \"data_atualizacao\": \"2025-08-04 16:46:35\",\n \"conta\": \"91cak4f9-4u72-17f0-a36f-42810b400012\"\n }\n}"}],"_postman_id":"15dd12f8-7c54-4ff1-a87c-89c43c937394"}],"id":"15414b64-ddc0-4a30-8097-05cdd08e2455","_postman_id":"15414b64-ddc0-4a30-8097-05cdd08e2455","description":""}],"id":"960eb572-f102-4d09-a597-b54b1e162d61","description":"

Esta seção é dedicada à consulta de informações da sua conta Canvi, incluindo saldo disponível e relatórios financeiros essenciais para o acompanhamento das suas movimentações.

Através dos endpoints abaixo, você pode monitorar a saúde financeira da sua conta de forma prática e centralizada.

\n","_postman_id":"960eb572-f102-4d09-a597-b54b1e162d61"},{"name":"Transferência","item":[{"name":"Consulta Pix Retirada","id":"4f173f78-a4b9-4020-b5c2-d1d4db2b87b0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"/bt/consulta_pix_retirada","urlObject":{"path":["bt","consulta_pix_retirada"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"4f173f78-a4b9-4020-b5c2-d1d4db2b87b0"},{"name":"Configurar Pix Retirada","id":"a31249db-826a-439d-88aa-52a20da9db0a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"horario\": \"6\",\r\n \"chave_pix\": \"60422761000163\",\r\n \"valor_remanescente\": 50.00\r\n}","options":{"raw":{"language":"json"}}},"url":"/bt/configurar_pix_retirada","urlObject":{"path":["bt","configurar_pix_retirada"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"a31249db-826a-439d-88aa-52a20da9db0a"}],"id":"1085eb71-3b27-4b5b-beea-4dd6f67d14e7","_postman_id":"1085eb71-3b27-4b5b-beea-4dd6f67d14e7","description":""},{"name":"Subcontas","item":[{"name":"Comerciante","item":[{"name":"Comerciante Extrato Detalhado","id":"5081cb25-0f31-4684-9c35-76684571a632","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"/ac/consulta/extrato/detalhado?data_inicial=2025-05-01&data_final=2025-09-30&numero_cnpj=41404602000191","urlObject":{"path":["ac","consulta","extrato","detalhado"],"host":[""],"query":[{"key":"data_inicial","value":"2025-05-01"},{"key":"data_final","value":"2025-09-30"},{"disabled":true,"key":"conta","value":"81e39286-0f32-4b81-9363-d06a0cbcf785"},{"key":"numero_cnpj","value":"41404602000191"}],"variable":[]}},"response":[],"_postman_id":"5081cb25-0f31-4684-9c35-76684571a632"},{"name":"Comerciante Extrato Sintético","id":"308f0cdb-9c5a-410f-88ce-0a47ca008fcf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"/ac/consulta/extrato/sintetico?data_inicial=2025-05-01&data_final=2025-05-31&numero_cnpj=41404602000191","urlObject":{"path":["ac","consulta","extrato","sintetico"],"host":[""],"query":[{"key":"data_inicial","value":"2025-05-01"},{"key":"data_final","value":"2025-05-31"},{"disabled":true,"key":"conta","value":"81e39286-0f32-4b81-9363-d06a0cbcf785"},{"key":"numero_cnpj","value":"41404602000191"}],"variable":[]}},"response":[],"_postman_id":"308f0cdb-9c5a-410f-88ce-0a47ca008fcf"},{"name":"Comerciante Consulta Detalhado","id":"70cc1ed9-12c4-404e-a7b4-1cfe29640f5a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"/ac/consulta/detalhado?data_inicial=2025-05-01&data_final=2025-05-31&numero_cnpj=41404602000191","urlObject":{"path":["ac","consulta","detalhado"],"host":[""],"query":[{"key":"data_inicial","value":"2025-05-01"},{"key":"data_final","value":"2025-05-31"},{"disabled":true,"key":"conta","value":"81e39286-0f32-4b81-9363-d06a0cbcf785"},{"key":"numero_cnpj","value":"41404602000191"}],"variable":[]}},"response":[],"_postman_id":"70cc1ed9-12c4-404e-a7b4-1cfe29640f5a"},{"name":"Comerciante Histórico Status","id":"30754175-3269-4d7c-bdcc-e5259f1bc38e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"/ac/consulta/transacao/status?id_transacao=10199&tipo_transacao=pixCashin&numero_cnpj=41404602000191","urlObject":{"path":["ac","consulta","transacao","status"],"host":[""],"query":[{"key":"id_transacao","value":"10199"},{"key":"tipo_transacao","value":"pixCashin"},{"disabled":true,"key":"conta","value":"81e39286-0f32-4b81-9363-d06a0cbcf785"},{"key":"numero_cnpj","value":"41404602000191"}],"variable":[]}},"response":[],"_postman_id":"30754175-3269-4d7c-bdcc-e5259f1bc38e"},{"name":"Listar Comerciantes","id":"48c6a76d-f48b-4e0c-a9c2-6f0461e1071a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"/ac/comerciante?numero_cnpj=12345678000198","urlObject":{"path":["ac","comerciante"],"host":[""],"query":[{"disabled":true,"key":"nome_fantasia","value":"EMPRESA 1"},{"disabled":true,"key":"conta","value":"a2dce822-760e-4588-98f6-d07709efa642"},{"key":"numero_cnpj","value":"12345678000198"}],"variable":[]}},"response":[],"_postman_id":"48c6a76d-f48b-4e0c-a9c2-6f0461e1071a"},{"name":"Cadastrar Comerciante","id":"ed2c2c05-0d48-4da0-a0bf-ab3986908520","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"geral\": {\r\n \"tipo_pessoa\": \"pf\",\r\n \"numero_cnpj\": \"00408979232\",\r\n \"nome_comerciante\": \"GABITECH\",\r\n \"nome_social\": \"Gabriel Nascimento Costa\",\r\n \"data_nascimento\": \"1990-04-02\",\r\n \"inscricao_estadual\": null,\r\n \"inscricao_municipal\": \"000000\",\r\n \"email\": \"nascimentog.costa@gmail.com\",\r\n \"financeiro\": {\r\n \"chave_pix\": \"00408979232\",\r\n \"horario_retirada\": 6,\r\n \"celular_financeiro\": \"92981871211\",\r\n \"email_financeiro\": \"nascimentog.costa@gmail.com\"\r\n },\r\n \"endereco\": {\r\n \"cep\": \"69058581\",\r\n \"estado\": \"AM\",\r\n \"cidade\": \"Manaus\",\r\n \"endereco\": \"Rua Barão do Rio Branco\",\r\n \"numero\": \"699\",\r\n \"bairro\": \"Flores\",\r\n \"complemento\": \"Bl09 ap 101\"\r\n }\r\n },\r\n \"responsavel\": {\r\n \"nome\": \"Gabriel Nascimento Costa\",\r\n \"cpf\": \"00408979232\",\r\n \"rg\": \"12.345.678-9\",\r\n \"nacionalidade\": \"Brasileiro\",\r\n \"celular\": \"+55 92 981871211\",\r\n \"email\": \"nascimentog.costa@gmail.com\",\r\n \"data_nascimento\": \"1990-04-02\",\r\n \"endereco\": {\r\n \"cep\": \"69058581\",\r\n \"estado\": \"AM\",\r\n \"cidade\": \"Manaus\",\r\n \"endereco\": \"Rua Barão do Rio Branco\",\r\n \"numero\": \"699\",\r\n \"bairro\": \"Flores\",\r\n \"complemento\": \"Bl09 ap 101\"\r\n }\r\n },\r\n \"id_externo\": \"12345789\",\r\n \"tipo_conta\": \"liquidacao\",\r\n \"configuracao\": {\r\n \"validar_ip\": false,\r\n \"ip\": [\"000.000.0.0\"]\r\n }\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"/ac/comerciante","description":"

Geral

Contém os dados da empresa ou pessoa cadastrada.

Campos:

tipo_pessoa ('pf' ou 'pj'): Define se o cadastro é de pessoa física ou jurídica.
\n
numero_cnpj: CPF (11 dígitos) ou CNPJ (14 dígitos), apenas números.
\n
nome_comerciante: Nome do comerciante (obrigatório).
\n
nome_social: Nome social ou razão social (obrigatório).
\n
data_nascimento: Data no formato YYYY-MM-DD. Para PF é a data de nascimento, para PJ é a data de fundação.
\n
inscricao_estadual: Opcional; aceita null.
\n
inscricao_municipal: Opcional; aceita null ou string vazia.
\n
email: Endereço de e-mail válido.
\n

Subobjeto: `financeiro`

chave_pix: Chave PIX obrigatória.
\n
celular_financeiro: Celular no formato numérico com 11 dígitos (DDD + número).
\n
email_financeiro: E-mail de contato financeiro.
\n

Subobjeto: `endereco`

cep: CEP com 8 dígitos (formato 00000000).
\n
estado: Sigla do estado com 2 letras maiúsculas (ex: SP).
\n
cidade: Nome da cidade.
\n
endereco: Rua, avenida etc.
\n
numero: Número do local.
\n
bairro: Nome do bairro.
\n
complemento: Opcional; pode ser nulo ou vazio.
\n

Responsavel

Dados da pessoa responsável legal pelo cadastro (obrigatório para ambos os tipos de pessoa).

Campos:

nome: Nome completo do responsável.
\n
cpf: CPF com 11 dígitos numéricos.
\n
rg: Registro Geral (identidade).
\n
nacionalidade: Nacionalidade do responsável.
\n
celular: Número no formato internacional brasileiro (+55 11 91234-5678).
\n
email: E-mail válido.
\n
data_nascimento: Data no formato YYYY-MM-DD.
\n

Subobjeto: `endereco`

Mesma estrutura do campo geral.endereco, com validações específicas para cada subcampo.

Campos adicionais

id_externo: Identificador externo único da entidade cadastrada. Deve ser uma string.
\n
tipo_conta: Define o tipo de conta, pode ser apenas \"liquidacao\" ou \"pagamento\".
\n

Configuracao

Configurações adicionais, especialmente para controle de segurança por IP:

validar_ip: Booleano. Define se a validação por IP está ativada.
\n
ip: Lista de IPs (IPv4 válidos) obrigatória somente se validar_ip for true.
\n

Mensagens de Erro

Cada campo tem mensagens personalizadas que ajudam o usuário ou desenvolvedor a entender o motivo de falhas na validação — por exemplo:

'any.required': Campo obrigatório.
\n
'string.pattern.base': Formato inválido (por regex).
\n
'string.email': E-mail inválido.
\n
'date.format': Data fora do formato YYYY-MM-DD.
\n

\n","urlObject":{"path":["ac","comerciante"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"c24e7bec-1289-44c2-9717-7f474ced28fc","name":"Cadastrar Comerciante","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{ \r\n \"geral\" :{\r\n \"tipo_pessoa\": \"pj\", // pf - Pessoa Física, pj - Pessoa Jurídica \r\n \"numero_cnpj\": \"12345678000228\",\r\n \"nome_comerciante\": \"Empresa Exemplo Ltda\", // Em caso de PJ Razão Social e em caso de PF nome da pessoa\r\n \"nome_social\": \"Exemplo Comércio1\", // Em caso de PJ Nome Fantasia e em caso de PF, nome Social \r\n \"data_nascimento\": \"1990-05-15\", // No caso de PJ, fundação da empresa \r\n \"inscricao_estadual\": null,\r\n \"inscricao_municipal\": \"94829334\", \r\n \"email\": \"contato@exemplo.com.br\", // email1 \r\n \"financeiro\": {\r\n \"chave_pix\": \"123e4567-e89b-12d3-a456-426614174000\",\r\n \"celular_financeiro\": \"11912345678\", \r\n \"email_financeiro\": \"financeiro@exemplo.com.br\" \r\n },\r\n \"endereco\": { \r\n \"cep\": \"01234567\",\r\n \"estado\": \"SP\",\r\n \"cidade\": \"São Paulo\",\r\n \"endereco\": \"Rua das Américas\",\r\n \"numero\": \"1000\",\r\n \"bairro\": \"Centro\",\r\n \"complemento\": \"Sala 202\"\r\n }\r\n }, \r\n \"responsavel\": {\r\n \"nome\": \"João da Silva\",\r\n \"cpf\": \"12345678900\",\r\n \"rg\": \"12.345.678-9\",\r\n \"nacionalidade\": \"Brasileiro\",\r\n \"celular\": \"+55 11 99876-5432\",\r\n \"email\": \"joao.silva@email.com\", // email2\r\n \"data_nascimento\": \"1990-05-15\", \r\n \"endereco\": {\r\n \"cep\": \"01234567\",\r\n \"estado\": \"SP\",\r\n \"cidade\": \"São Paulo\",\r\n \"endereco\": \"Av. Brasil\",\r\n \"numero\": \"500\",\r\n \"bairro\": \"Jardins\",\r\n \"complemento\": \"Apto 303\"\r\n } \r\n },\r\n \"id_externo\": \"12345\", \r\n \"tipo_conta\": \"liquidacao\", \r\n \"configuracao\": {\r\n \"validar_ip\": true,\r\n \"ip\": [\"192.168.0.1\", \"192.168.0.2\"]\r\n }\r\n \r\n}","options":{"raw":{"language":"json"}}},"url":"/ac/comerciante"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 27 May 2025 18:49:24 GMT"},{"key":"Server","value":"Apache/2.4.58 (Ubuntu)"},{"key":"vary","value":"origin,accept-encoding"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"cache-control","value":"no-cache"},{"key":"content-encoding","value":"gzip"},{"key":"Keep-Alive","value":"timeout=5, max=99"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"mensagem\": \"Cadastro da conta realizado com sucesso.\",\n \"data\": {\n \"tipo_pessoa\": \"PJ\",\n \"nome_fantasia\": \"EMPRESA EXEMPLO LTDA\",\n \"razao_social\": \"EXEMPLO COMÉRCIO1\",\n \"numero_cnpj\": \"12345678000228\"\n }\n}"}],"_postman_id":"ed2c2c05-0d48-4da0-a0bf-ab3986908520"}],"id":"3ed4343c-9cab-4e31-9e2b-3b22fd818875","_postman_id":"3ed4343c-9cab-4e31-9e2b-3b22fd818875","description":""},{"name":"Relatorios Financeiros","item":[{"name":"Consulta Cliente Split","id":"c01277ed-4533-4e26-858e-d0372f0236cd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"data_inicial\":\"2025-01-01\",\r\n \"data_final\": \"2025-02-01\"\r\n}","options":{"raw":{"language":"json"}}},"url":"/ac/parceiro_cliente_split","urlObject":{"path":["ac","parceiro_cliente_split"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"c01277ed-4533-4e26-858e-d0372f0236cd"},{"name":"Consulta Cliente Split Serviço","id":"0b0747b1-ed95-495e-8641-b554a70dfedd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"data_inicial\":\"2024-05-01\",\r\n \"data_final\": \"2024-05-01\"\r\n}","options":{"raw":{"language":"json"}}},"url":"/ac/parceiro_cliente_split_servico","urlObject":{"path":["ac","parceiro_cliente_split_servico"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"0b0747b1-ed95-495e-8641-b554a70dfedd"},{"name":"Consulta Split Serviço","id":"3f3f1293-d350-4e30-921f-7012e69076bf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"data_inicial\":\"2024-05-01\",\r\n \"data_final\": \"2024-05-01\"\r\n}","options":{"raw":{"language":"json"}}},"url":"/ac/parceiro_split_servico","urlObject":{"path":["ac","parceiro_split_servico"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"3f3f1293-d350-4e30-921f-7012e69076bf"},{"name":"Consulta Situação Serviço","id":"8a86200e-93bb-4548-86de-add8cc1681f7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"data_inicial\":\"2024-05-01\",\r\n \"data_final\": \"2024-05-01\"\r\n}","options":{"raw":{"language":"json"}}},"url":"/ac/parceiro_situacao_servico","urlObject":{"path":["ac","parceiro_situacao_servico"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"8a86200e-93bb-4548-86de-add8cc1681f7"},{"name":"Consulta Situação","id":"821c4587-c703-45d8-b7a0-77445bedea40","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"data_inicial\":\"2024-05-01\",\r\n \"data_final\": \"2024-05-01\"\r\n}","options":{"raw":{"language":"json"}}},"url":"/ac/parceiro_situacao","urlObject":{"path":["ac","parceiro_situacao"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"821c4587-c703-45d8-b7a0-77445bedea40"},{"name":"Consulta Split Por Dia","id":"815c5214-6ffc-4b13-8a18-6e46bbd6811f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"data_inicial\":\"2024-05-01\",\r\n \"data_final\": \"2024-10-31\"\r\n}","options":{"raw":{"language":"json"}}},"url":"/ac/parceiro_split_por_dia","urlObject":{"path":["ac","parceiro_split_por_dia"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"815c5214-6ffc-4b13-8a18-6e46bbd6811f"}],"id":"5650c005-f3a2-4592-b410-1a9f4587c853","_postman_id":"5650c005-f3a2-4592-b410-1a9f4587c853","description":""},{"name":"Credenciais","item":[{"name":"credenciais","id":"2b7f7b54-5ab4-43cb-b2ef-bbfe700312d0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"/ac/credenciais","urlObject":{"path":["ac","credenciais"],"host":[""],"query":[{"disabled":true,"key":"numero_cnpj","value":"2222222222222"},{"disabled":true,"key":"client_id","value":"111111"},{"disabled":true,"key":"conta","value":"22222"}],"variable":[]}},"response":[],"_postman_id":"2b7f7b54-5ab4-43cb-b2ef-bbfe700312d0"}],"id":"446c9680-96a3-482f-838a-c27c8d45c66b","_postman_id":"446c9680-96a3-482f-838a-c27c8d45c66b","description":""},{"name":"Ip","item":[{"name":"ip","id":"aa7fa1d8-3abe-42b6-8666-a196c1e72e44","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"/ac/ip","urlObject":{"path":["ac","ip"],"host":[""],"query":[{"disabled":true,"key":"numero_cnpj","value":"2222222222222"},{"disabled":true,"key":"ip","value":"192.168.0.1"},{"disabled":true,"key":"conta","value":"22222"}],"variable":[]}},"response":[],"_postman_id":"aa7fa1d8-3abe-42b6-8666-a196c1e72e44"},{"name":"Cadastro de IP","id":"63bc62fe-ecd1-49c0-8fb2-4b459daa5477","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"documento\": \"12345678000198\",\r\n \"validar_ip\": true,\r\n \"ip\": [\"192.168.5.1\", \"192.168.5.2\"]\r\n}\r\n \r\n","options":{"raw":{"language":"json"}}},"url":"/ac/ip","urlObject":{"path":["ac","ip"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"63bc62fe-ecd1-49c0-8fb2-4b459daa5477"}],"id":"e21377c6-7691-4ac1-a9fd-328a3ff8caf5","_postman_id":"e21377c6-7691-4ac1-a9fd-328a3ff8caf5","description":""},{"name":"Tarifa","item":[{"name":"tarifa","id":"e3b8f5f2-aa4b-44b5-ba13-235d89f1770d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/ac/tarifa","urlObject":{"path":["ac","tarifa"],"host":[""],"query":[{"disabled":true,"key":"nome_fantasia","value":"EMPRESA 1"},{"disabled":true,"key":"conta","value":"81e39286-0f32-4b81-9363-d06a0cbcf785"},{"disabled":true,"key":"numero_cnpj","value":""}],"variable":[]}},"response":[],"_postman_id":"e3b8f5f2-aa4b-44b5-ba13-235d89f1770d"},{"name":"tarifa","id":"9f051473-d3c8-4888-98e7-c123edb535d1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"numero_cnpj\": \"111111111111\", \r\n \"servico\": [\r\n {\r\n \"chave\": \"pixCashin\",\r\n \"tipo\": \"percentual\",\r\n \"valor\": \"0.70\"\r\n },\r\n {\r\n \"chave\": \"pixCashin\",\r\n \"tipo\": \"valor\",\r\n \"valor\": \"0.40\"\r\n },\r\n {\r\n \"chave\": \"pixStaticCashin\",\r\n \"tipo\": \"valor\",\r\n \"valor\": \"0.40\"\r\n },\r\n {\r\n \"chave\": \"boletoCashin\",\r\n \"tipo\": \"valor\",\r\n \"valor\": \"4.00\"\r\n },\r\n {\r\n \"chave\": \"pixCashout\",\r\n \"tipo\": \"percentual\",\r\n \"valor\": \"0.70\"\r\n },\r\n {\r\n \"chave\": \"pixCashinSemStatus\",\r\n \"tipo\": \"percentual\",\r\n \"valor\": \"0.70\"\r\n }\r\n ] \r\n}","options":{"raw":{"language":"json"}}},"url":"/ac/tarifa","urlObject":{"path":["ac","tarifa"],"host":[""],"query":[{"disabled":true,"key":"numero_cnpj","value":"36170570000177"},{"disabled":true,"key":"client_id","value":"111111"},{"disabled":true,"key":"conta","value":"22222"}],"variable":[]}},"response":[],"_postman_id":"9f051473-d3c8-4888-98e7-c123edb535d1"}],"id":"40ed0dc3-2113-4a1f-828e-5b6b6d9ca10a","_postman_id":"40ed0dc3-2113-4a1f-828e-5b6b6d9ca10a","description":""},{"name":"WebHook","item":[{"name":"webhook","id":"34ae6ef7-25be-479d-bc58-716eacf61ce0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/ac/webhook","urlObject":{"path":["ac","webhook"],"host":[""],"query":[{"disabled":true,"key":"nome_fantasia","value":"EMPRESA 1"},{"disabled":true,"key":"conta","value":"81e39286-0f32-4b81-9363-d06a0cbcf785"},{"disabled":true,"key":"numero_cnpj","value":""}],"variable":[]}},"response":[],"_postman_id":"34ae6ef7-25be-479d-bc58-716eacf61ce0"},{"name":"webhook","id":"bbc4cdbc-ab0c-4366-b35b-2773f2a8cd72","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"tipo_hierarquia\": \"global\", // individual, global\r\n \"numero_cnpj\": \"111111111111\", \r\n \"tipo_transacao\": \"pixCashin\", //pixCashin, pixStaticCashin, boletoCashin, pixCashout, cartao\r\n \"url\": \"https://teste123.com\",\r\n \"type\": \"json\" // urlencoded (application/x-www-form-urlencoded) | json (application/json) | form_data (multipart/form-data), caso não enviado o padrão será x-www-form-urlencoded\r\n}","options":{"raw":{"language":"json"}}},"url":"/ac/webhook","urlObject":{"path":["ac","webhook"],"host":[""],"query":[{"disabled":true,"key":"numero_cnpj","value":"36170570000177"},{"disabled":true,"key":"client_id","value":"111111"},{"disabled":true,"key":"conta","value":"22222"}],"variable":[]}},"response":[],"_postman_id":"bbc4cdbc-ab0c-4366-b35b-2773f2a8cd72"}],"id":"18558f0e-e606-43ce-be76-108425224d87","_postman_id":"18558f0e-e606-43ce-be76-108425224d87","description":""}],"id":"de61f2f4-5e0a-4a73-9bce-57eed6c54848","_postman_id":"de61f2f4-5e0a-4a73-9bce-57eed6c54848","description":""},{"name":"WebHook","item":[{"name":"Configurar Webhook","id":"e4c5c636-ef65-413f-ba38-3992730da110","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{}},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"tipo_transacao\": \"pixCashin\", //pixCashin, pixStaticCashin, boletoCashin, pixCashout, cartao\r\n \"url\": \"https://tender-architect-47.webhook.cool\",\r\n \"type\": \"json\" // urlencoded (application/x-www-form-urlencoded) | json (application/json) | form_data (multipart/form-data), caso não enviado o padrão será x-www-form-urlencoded\r\n}","options":{"raw":{"language":"json"}}},"url":"/bt/configurar_webhook","description":"

tipo_transacao: Campo para definir o tipo de webhook a ser configurado

pixCashin: Para configurar webhook de PIX
\n
boletoCashin: Para configurar webhook de Boleto
\n

url: Url a ser configurada para o envio de informações

\n","urlObject":{"path":["bt","configurar_webhook"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"e4c5c636-ef65-413f-ba38-3992730da110"},{"name":"Consultar Webhook","event":[{"listen":"test","script":{"id":"1f18453b-ef80-4bdd-827a-b84d19490d5c","exec":["\r","pm.test(\"Response status code is 200\", function () {\r"," pm.response.to.have.status(200);\r","});\r","\r","\r","pm.test(\"Response has the required fields - code, mensagem, and data\", function () {\r"," const responseData = pm.response.json();\r","\r"," pm.expect(responseData).to.be.an('object');\r"," pm.expect(responseData).to.have.property('code');\r"," pm.expect(responseData).to.have.property('mensagem');\r"," pm.expect(responseData).to.have.property('data');\r","});\r","\r","\r","pm.test(\"Data URL is in a valid URL format\", function () {\r"," const responseData = pm.response.json();\r"," \r"," pm.expect(responseData).to.be.an('object');\r"," pm.expect(responseData.data.url).to.match(/^http(s)?:\\/\\/[^ \"]+$/);\r","});\r","\r","\r","pm.test(\"Response time is less than 200ms\", function () {\r"," pm.expect(pm.response.responseTime).to.be.below(200);\r","});\r","\r",""],"type":"text/javascript","packages":{}}}],"id":"ce42bba5-b0ae-4038-8207-6a17b79407da","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{}},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"\r\n{\r\n \"tipo_transacao\": \"pixCashin\"\r\n}","options":{"raw":{"language":"json"}}},"url":"/bt/consultar_webhook","description":"

tipo_transacao: Campo para definir o tipo de webhook a ser consultado

pixCashin
\n
boletoCashin
\n
pixCashout
\n
cartao
\n

\n","urlObject":{"path":["bt","consultar_webhook"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"ce42bba5-b0ae-4038-8207-6a17b79407da"}],"id":"a812259a-147a-4daf-b1ff-ce690c11d27c","_postman_id":"a812259a-147a-4daf-b1ff-ce690c11d27c","description":""},{"name":"Desenvolvedor","item":[{"name":"Simular Baixa","id":"7096b815-e1c3-472a-9f4c-0cc419281902","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"id\": 56375, // id_invoice_pix, id_boleto, id_invoice_pix_documento\r\n \"tipo_transacao\": \"pixCashin\", // pixCashin, pixStaticCashin, boletoCashin\r\n // \"pix\": { // ENVIAR SE FOR TESTAR PIX\r\n // \"pagamento\": {\r\n // \"valor\": \"2.00\", // SIMULAÇÃO DE PIX ESTÁTICO\r\n // \"pagador\": {\r\n // \"id\": \"\", // CPF ou CNPJ\r\n // \"nome\": \"\"\r\n // }\r\n // }\r\n // } \r\n // \"boleto\": { // ENVIAR SE FOR TESTAR BOLETO\r\n // \"pagamento\": {\r\n // \"valor\": \"1.40\",\r\n // \"data\": \"2025-03-28T18:45:00\",\r\n // \"pix\": { // SE PAGO POR PIX\r\n // \"E2EId\": \"E3333333333333333333\" \r\n // } \r\n // }\r\n \r\n // }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/bt/desenvolvedor/simular_baixa","urlObject":{"path":["bt","desenvolvedor","simular_baixa"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"7096b815-e1c3-472a-9f4c-0cc419281902"}],"id":"82cda58f-3fc0-459e-8e19-d136aceba9b8","_postman_id":"82cda58f-3fc0-459e-8e19-d136aceba9b8","description":""},{"name":"Pix (Obsoleto)","item":[{"name":"Criar cobrança PIX","id":"77325a0d-ed33-4379-a9db-e3cc1685fa8f","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{}},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"valor\": 100, \r\n \"vencimento\": \"2024-06-21T16:45:00\", // (Opicional) Data de vencimento da cobrança, não informando, o tempo limite do vencimento é de 1 hora\r\n \"descricao\": \"Cobrança de teste\", // Breve descrição da cobrança\r\n \"tipo_transacao\": \"invoice\", // invoice: Quando deseja receber status da transação em webhook, invoiceFrenteCaixa: Quando não deseja receber status da transação em webhook\r\n \"texto_instrucao\": \"Instruções\", // Texto em até 1000 caractere\r\n \"identificador_externo\": \"23268130\", // Identificador único do parceiro, podendo usar uuid\r\n \"identificador_movimento\": \"23258129\", // Identificador auxiliar do parceiro, podendo usar uuid\r\n \"cliente\": { // (Opicional) Identificador do devedor\r\n \"nome\": \"Maria Eduarda\",\r\n \"tipo_documento\": \"cpf\",\r\n \"numero_documento\": \"744.674.080-96\",\r\n \"e-mail\": \"eduarda@gmail.com\"\r\n \r\n } \r\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox-gateway.service-canvi.com.br:8080/bt/invoice_pix","description":"

valor: Valor da cobrança sendo enviado sem pontuação em vez de vírgula (Exemplo: R$ 100,00 deve ser enviado 10000) (Obrigatório)

vencimento: Data de vencimento da cobrança, não informando, o tempo limite do vencimento é de 1 hora

descrição: Uma breve descrição para rastreamento rápido (Obrigatório)

identificador_externo: Código único de transação, não podendo ser reaproveitado posteriormente (Obrigatório)

tipo_transação: Cave de configuração do tipo de cobrança a ser usada. (Obrigatório)

invoice: As resposta serão enviadas para um webhook previamente configurado pelo parceiro
\n
invoiceFrenteCaixa: O sistema do parceiro deve consultar as informações usando o método de consulta
\n

texto_instrução: Texto com o resumo da cobrança de até 500 caractéres (Obrigatório)

identificador_movimento: Código secundário único, onde o parceiro poderá passar alguma chave de verificação futura (Obrigatório)

cliente: Identificador do devedor

nome: Nome do devedor
\n
tipo_documento: Tipo de documento do devedor. Opções { CPF ou CNPJ }
\n
numero_documento: Numero do documento do devedor
\n
e-mail: email de cobrança do devedor
\n

\n","urlObject":{"protocol":"https","port":"8080","path":["bt","invoice_pix"],"host":["sandbox-gateway","service-canvi","com","br"],"query":[],"variable":[]}},"response":[],"_postman_id":"77325a0d-ed33-4379-a9db-e3cc1685fa8f"},{"name":"Consultar cobrança PIX","id":"7a579493-e3da-49c2-8d27-41b1ef4c20ab","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"id_invoice_pix\": \"52264\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox-gateway.service-canvi.com.br:8080/bt/consulta_invoice_pix","description":"

id_invoice_pix: identificação única gerada pela criação da cobrança PIX (Obrigatório)

\n","urlObject":{"protocol":"https","port":"8080","path":["bt","consulta_invoice_pix"],"host":["sandbox-gateway","service-canvi","com","br"],"query":[],"variable":[]}},"response":[],"_postman_id":"7a579493-e3da-49c2-8d27-41b1ef4c20ab"},{"name":"Criar Devolução Pix","id":"5f3efbfe-dff7-463d-a8ad-1decf3b40b0c","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{}},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"\r\n{\r\n \"id_invoice_pix\":\"169327\",\r\n \"identificador_externo\": 35,\r\n \"descricao\": \"Devolução de teste\",\r\n \"texto_instrucao\": \"Instrução...\" \r\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox-gateway.service-canvi.com.br:8080/bt/devolucao_pix","urlObject":{"protocol":"https","port":"8080","path":["bt","devolucao_pix"],"host":["sandbox-gateway","service-canvi","com","br"],"query":[],"variable":[]}},"response":[],"_postman_id":"5f3efbfe-dff7-463d-a8ad-1decf3b40b0c"}],"id":"41b63c15-9c17-4e2f-90c1-e2b12d631474","_postman_id":"41b63c15-9c17-4e2f-90c1-e2b12d631474","description":""}],"id":"423454c4-ec0f-4f9b-ba7b-5b5b7917cb81","_postman_id":"423454c4-ec0f-4f9b-ba7b-5b5b7917cb81","description":""},{"name":"Cartão","item":[{"name":"Iniciar Pagamento","id":"ca73f7c9-71d7-4e3a-8c8f-63cd4dfa5b6d","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{}},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"valor\": \"350.00\",\r\n \"descricao\": \"Cobrança de teste...\",\r\n \"tipo_transacao\": \"cartao\",\r\n \"metodo\": \"online\",\r\n \"texto_instrucao\": \"Detalhes adicionais da cobrança...\",\r\n \"identificador_externo\": \"40b6f93a-66b1-4842-8335-a0fa3cc6644e\",\r\n \"identificador_movimento\": \"40960113-c118-48db-bce5-414614697dff\",\r\n \"bandeira\": 1,\r\n \"tipo_cartao\": \"credit\",\r\n \"confirmar_pagamento\": false,\r\n \"tag\": [\r\n \"unidade-3\",\r\n \"promocao-tty\"\r\n ],\r\n \"cliente\": {\r\n \"nome\": \"Edmundo Gama\",\r\n \"tipo_documento\": \"cpf\",\r\n \"numero_documento\": \"433.527.020-80\",\r\n \"e-mail\": \"edmundo@gmail.com\"\r\n },\r\n \"produtos\": [\r\n {\r\n \"nome\": \"Camiseta M Gatinho\",\r\n \"imagem\": \"https://images.unsplash.com/photo-1576566588028-4147f3842f27?q=80&w=764&auto=format&fit=crop&ixlib=rb-4.1.0&ixid=M3wxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8fA%3D%3D\",\r\n \"descricao\": \"Camiseta Gatinho M - Bege - KiiKii\",\r\n \"id\": \"2349758934\",\r\n \"valor\": \"74.99\",\r\n \"quantidade\": 2,\r\n \"tag\": [\r\n \"camiseta\",\r\n \"kiikii\"\r\n ]\r\n },\r\n {\r\n \"nome\": \"Tênis Nike Air Force 3\",\r\n \"imagem\": \"https://images.unsplash.com/photo-1600269452121-4f2416e55c28?q=80&w=765&auto=format&fit=crop&ixlib=rb-4.1.0&ixid=M3wxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8fA%3D%3D\",\r\n \"descricao\": \"Tênis Nike Air Force 3 - Branco - 38\",\r\n \"id\": \"34587645760\",\r\n \"valor\": \"200.00\",\r\n \"quantidade\": 1,\r\n \"tag\": [\r\n \"tenis\",\r\n \"nike\",\r\n \"airforce3\"\r\n ]\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"/tef/iniciar_pagamento","description":"

Descrição

Esta rota é utilizada para iniciar um processo de pagamento com cartão, gerando um código de transação e um link para o nosso Checkout Canvi, onde o cliente poderá concluir o pagamento.

Você pode configurar os detalhes da cobrança através dos campos disponíveis no corpo da requisição.

⚠️ Os campos obrigatórios estão sinalizados com ( * )

Corpo da Requisiçã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\n\n\n\n\n\n\n\n\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
valor*	string / number	Valor total da cobrança
descricao*	string	Breve descrição da cobrança
tipo_transacao*	string	Deve ser preenchido com o valor: `cartao`
metodo*	string	Define o meio de pagamento: `online` e `presential`
texto_instrucao*	string	Detalhes da cobrança que será exibido no Checkout. Max - 1000 caracteres
identificador_externo*	string	Identificador único da cobrança no seu sistema
identificador_movimento*	string	identificador auxiliar para controle interno
bandeira	string / number	ID da bandeira do cartão (consulte a lista de bandeiras disponíveis)
tipo_cartao	string	Define o tipo de cartão: `credit`, `debit` ou `voucher`
confirmar_pagamento*	boolean	Se for `true`, a confirmação do pagamento será efetuada automaticamente após sua realização. Se for `false`, vai aguardar a confirmação manual do pagamento
tag	string[ ]	Lista de etiquetas para categorização ou filtragem da cobrança. Cada item deve conter no máximo 100 caracteres

Cliente

Identifica o devedor da cobrança.
Embora este campo seja opcional, caso seja informado, todos os seus subcampos tornam-se obrigatórios.

\n\n\n\n\n\n\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
nome*	string	Nome completo do devedor
tipo_documento*	string	Define o tipo de documento a ser informado: `cpf` ou `cnpj`
documento*	string	Numero de documento do cliente. Deve seguir o seguinte modelo: • CPF: `XXX.XXX.XXX-XX` • CNPJ: `XX.XXX.XXX/XXXX-XX`
e-mail*	string	E-mail válido do cliente

Produtos

Lista de produtos associadas à cobrança. É opcional, mas caso seja informado, todos os campos internos são obrigatórios.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\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
nome*	string	Nome do produto
imagem*	string	URL da imagem do produto
descricao*	string	Descrição do produto
id*	string	Identificador único do produto
valor*	string / number	Valor unitário do produto
quantidade*	number	Quantidade de unidades
tag	string[ ]	Lista de etiquetas associadas ao produto

","urlObject":{"path":["tef","iniciar_pagamento"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"4da4af25-e83d-4f50-9784-397fcdafc4ad","name":"Sucesso","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"valor\": \"349.99\",\r\n \"descricao\": \"Cobrança de teste...\",\r\n \"tipo_transacao\": \"cartao\",\r\n \"metodo\": \"online\",\r\n \"texto_instrucao\": \"Detalhes adicionais da cobrança...\",\r\n \"identificador_externo\": \"c16bc9ee-50cf-4098-9af5-533175f3f440\",\r\n \"identificador_movimento\": \"5af73fc5-72d2-4634-86ae-21b546010609\",\r\n \"bandeira\": 2,\r\n \"tipo_cartao\": \"credit\", \r\n \"confirmar_pagamento\": false,\r\n \"tag\": [\r\n \"unidade 3\",\r\n \"promocao-tty\"\r\n ],\r\n \"cliente\": { \r\n \"nome\": \"Edmundo Gama\",\r\n \"tipo_documento\": \"cpf\",\r\n \"numero_documento\": \"433.527.020-80\",\r\n \"e-mail\": \"edmundo@gmail.com\"\r\n },\r\n \"produtos\": [\r\n {\r\n \"nome\": \"Camiseta M Gatinho\",\r\n \"imagem\": \"https://images.unsplash.com/photo-1576566588028-4147f3842f27?q=80&w=764&auto=format&fit=crop&ixlib=rb-4.1.0&ixid=M3wxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8fA%3D%3D\",\r\n \"descricao\": \"Camiseta Gatinho M - Bege - KiiKii\",\r\n \"id\": \"2349758934\",\r\n \"valor\": \"74.99\",\r\n \"quantidade\": 2,\r\n \"tag\": [\r\n \"camiseta\",\r\n \"kiikii\"\r\n ]\r\n },\r\n {\r\n \"nome\": \"Tênis Nike Air Force 3\",\r\n \"imagem\": \"https://images.unsplash.com/photo-1600269452121-4f2416e55c28?q=80&w=765&auto=format&fit=crop&ixlib=rb-4.1.0&ixid=M3wxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8fA%3D%3D\",\r\n \"descricao\": \"Tênis Nike Air Force 3 - Branco - 38\",\r\n \"id\": \"34587645760\",\r\n \"valor\": \"200.00\",\r\n \"quantidade\": 1,\r\n \"tag\": [\r\n \"tenis\",\r\n \"nike\",\r\n \"airforce3\"\r\n ]\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"/tef/iniciar_pagamento"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 14 Aug 2025 21:19:25 GMT"},{"key":"Server","value":"Apache/2.4.58 (Ubuntu)"},{"key":"vary","value":"origin,accept-encoding"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"cache-control","value":"no-cache"},{"key":"content-encoding","value":"gzip"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"mensagem\": \"Transação Iniciada!\",\n \"data\": {\n \"id_cartao\": 1900,\n \"valor\": \"349.99\",\n \"codigo_transacao\": \"98a2787d-7f2e-448a-agb0-764abc311742\",\n \"url\": \"https://checkout-homol.service-canvi.com.br/payment/98a2787d-7f2e-448a-agb0-764abc311742\"\n }\n}"}],"_postman_id":"ca73f7c9-71d7-4e3a-8c8f-63cd4dfa5b6d"},{"name":"Realizar Pagamento","id":"75f57fcf-1544-4b72-8c51-19964d93fb03","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{}},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"codigo_transacao\": \"98a2787d-7f2e-448a-agb0-764abc311742\",\r\n \"tipo_cartao\": \"credit\",\r\n \"numero_parcela\": \"1\",\r\n \"cartao\": {\r\n \"numero\": \"5192693196923105\",\r\n \"mes_ano\": \"07/2026\",\r\n \"codigo_seguranca\": \"115\",\r\n \"bandeira\": 2,\r\n \"titular\": {\r\n \"nome\": \"Carta teste\",\r\n \"cpf\": \"99010275272\",\r\n \"data_nascimento\": \"1990/05/15\",\r\n \"telefone\": \"92981065150\",\r\n \"email\": \"titular@gmail.com\"\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"/tef/pagamento","description":"

Descrição

Após gerar a cobrança, utilize esta rota para efetuar seu pagamento, informando os dados do cartão e do titular.

⚠️ Os campos obrigatórios estão sinalizados com ( * )

Corpo da Requisiçã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

Campo	Tipo	Descrição
codigo_transacao*	string	Código UUID único que identifica a transação iniciada anteriormente
tipo_cartao	string	Tipo do cartão: `debit`, `credit` ou `voucher`. Caso já tenha sido informado na criação da cobrança, não é necessário enviar novamente
numero_parcela*	string	Quantidade de parcelas em que a cobrança será dividida
cartao*	object	Objeto contendo os dados do cartão e do titular.

`cartao`

\n\n\n\n\n\n\n\n\n\n\n\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
numero*	string	Número completo do cartão
mes_ano*	string	Mês e ano de validade no formato `MM/AAAA`
codigo_seguranca*	string	Código de segurança do cartão (CVV), composto por 3 dígitos
bandeira	string / number	ID da bandeira do cartão (consulte a lista disponível). Caso já tenha sido informado na criação da cobrança, não é necessário enviar novamente
titular*	object	Objeto contendo as informações do titular do cartão

`cartao.titular`

\n\n\n\n\n\n\n\n\n\n\n\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
nome*	string	Nome comleto do titular
cpf*	string	CPF do titular (somente números)
data_nascimento*	date	Data de nascimento no formato YYYY/MM/DD
telefone*	string	Número de telefone do titular
email*	string	Endereço de e-mail válido do titular.

","urlObject":{"path":["tef","pagamento"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"f4e12d27-1eaf-436f-ade2-468957567cce","name":"Pré-Confirmado","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"codigo_transacao\": \"f3d97d0c-b085-4f4d-aeae-b7e87da961fa\", \r\n //\"tipo_cartao\": \"credit\", // credit, debit, voucher (Opicional) \r\n \"numero_parcela\": \"1\", // 1, 2, 3, 4, 5, 6, 7, 8, 9, 10\r\n \"cartao\": {\r\n \"numero\": \"5176600066163050\", \r\n \"mes_ano\": \"11/2030\",\r\n \"codigo_seguranca\": \"123\",\r\n //\"bandeira\": 1,//1,// 1, 2, 3, 4, 5, 6, 7, 8,9 (Opicional) \r\n \"titular\": {\r\n \"nome\": \"Carta teste\",\r\n \"cpf\": \"99010275272\",\r\n \"data_nascimento\": \"1990/05/15\",\r\n \"telefone\": \"92981065150\",\r\n \"email\": \"titular@gmail.com\" \r\n }\r\n } \r\n}","options":{"raw":{"language":"json"}}},"url":"/tef/pagamento"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 14 Aug 2025 22:33:18 GMT"},{"key":"Server","value":"Apache/2.4.58 (Ubuntu)"},{"key":"vary","value":"origin,accept-encoding"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"cache-control","value":"no-cache"},{"key":"content-encoding","value":"gzip"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"mensagem\": \"Transação Confirmada\",\n \"data\": {\n \"id_cartao\": 1912,\n \"identificador_externo\": \"e29e2653-8d88-48ca-af14-79f85596aa42\",\n \"valor\": 350,\n \"cartao\": \"5176600066163050\",\n \"bandeira\": \"VISA\",\n \"status\": \"paid\",\n \"criacao\": \"2025-08-14 18:33:05\",\n \"nsu\": \"032416400102\"\n }\n}"},{"id":"e6586fdd-046e-4318-aba9-70fa031194f2","name":"Aguarda Confirmação","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"codigo_transacao\": \"e9869c24-658b-4667-b430-3723431820da\", \r\n //\"tipo_cartao\": \"credit\", // credit, debit, voucher (Opicional) \r\n \"numero_parcela\": \"1\", // 1, 2, 3, 4, 5, 6, 7, 8, 9, 10\r\n \"cartao\": {\r\n \"numero\": \"5176600066163050\", \r\n \"mes_ano\": \"11/2030\",\r\n \"codigo_seguranca\": \"123\",\r\n //\"bandeira\": 1,//1,// 1, 2, 3, 4, 5, 6, 7, 8,9 (Opicional) \r\n \"titular\": {\r\n \"nome\": \"Carta teste\",\r\n \"cpf\": \"99010275272\",\r\n \"data_nascimento\": \"1990/05/15\",\r\n \"telefone\": \"92981065150\",\r\n \"email\": \"titular@gmail.com\" \r\n }\r\n } \r\n}","options":{"raw":{"language":"json"}}},"url":"/tef/pagamento"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 14 Aug 2025 22:15:19 GMT"},{"key":"Server","value":"Apache/2.4.58 (Ubuntu)"},{"key":"vary","value":"origin,accept-encoding"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"cache-control","value":"no-cache"},{"key":"content-encoding","value":"gzip"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"code\": 200,\n \"mensagem\": \"Transação Pré-Autorizada\",\n \"data\": {\n \"id_cartao\": 1911,\n \"identificador_externo\": \"287cf3fd-66d4-4505-8534-1891a22a5798\",\n \"valor\": 350,\n \"cartao\": \"5176600066163050\",\n \"tipo_transacao\": \"CREDIT_CARD\",\n \"bandeira\": \"VISA\",\n \"status\": \"authorized\",\n \"criacao\": \"2025-08-14 18:15:02\",\n \"nsu\": \"032416400102\"\n }\n}"}],"_postman_id":"75f57fcf-1544-4b72-8c51-19964d93fb03"},{"name":"Confirmar Pagamento","id":"19afd721-2fb6-46f0-bdc8-6c918a836865","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{}},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"codigo_transacao\": \"3a112e45-a84d-4448-b397-faf2b3c4a62b\" \r\n}","options":{"raw":{"language":"json"}}},"url":"/tef/confirmar_pagamento","description":"

Descrição

Este endpoint é utilizado para confirmar uma transação previamente iniciada e cujo pagamento já foi autorizado pelo banco emissor.

Um exemplo comum de uso é no varejo físico ou online, onde é necessário validar o estoque dos produtos antes de confirmar o pedido do cliente.

⚠️ Caso identifique que a transação não deve ser concluída, basta utilizar o endpoint de cancelamento de pagamento, sem impacto para o cliente ou para o processo financeiro.

Corpo da Requisição

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

Campo	Tipo	Descrição
codigo_transacao*	string	Código UUID único que identifica a transação a ser confirmada.

","urlObject":{"path":["tef","confirmar_pagamento"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"ec0f056c-6466-45ed-9730-2dc8d4324f6d","name":"Sucesso","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"codigo_transacao\": \"e9869c24-658b-4667-b430-3723431820da\" \r\n}","options":{"raw":{"language":"json"}}},"url":"/tef/confirmar_pagamento"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 14 Aug 2025 22:23:41 GMT"},{"key":"Server","value":"Apache/2.4.58 (Ubuntu)"},{"key":"vary","value":"origin,accept-encoding"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"cache-control","value":"no-cache"},{"key":"content-encoding","value":"gzip"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"mensagem\": \"Transação Confirmada\",\n \"data\": {\n \"id_cartao\": 1911,\n \"identificador_externo\": \"287cf3fd-66d4-4505-8534-1891a22a5798\",\n \"valor\": 350,\n \"nsu\": \"31022400001\",\n \"status\": \"paid\"\n }\n}"},{"id":"8d3e86d2-90fb-4012-bcbf-800377dffc3b","name":"Não autorizado","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"codigo_transacao\": \"3a112e45-a84d-4448-b397-faf2b3c4a62b\" \r\n}","options":{"raw":{"language":"json"}}},"url":"/tef/confirmar_pagamento"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 14 Aug 2025 19:00:37 GMT"},{"key":"Server","value":"Apache/2.4.58 (Ubuntu)"},{"key":"vary","value":"origin,accept-encoding"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"cache-control","value":"no-cache"},{"key":"content-encoding","value":"gzip"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 400,\n \"mensagem\": \"Transação não está autorizada e não pode ser concluída!\"\n}"},{"id":"432c67cd-7c04-47e7-a474-5e9936ea8625","name":"Já Concluído","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"codigo_transacao\": \"3d3d144b-bc3a-4008-8ff5-7b96e6d4d2a2\" \r\n}","options":{"raw":{"language":"json"}}},"url":"/tef/confirmar_pagamento"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Fri, 15 Aug 2025 17:30:24 GMT"},{"key":"Server","value":"Apache/2.4.58 (Ubuntu)"},{"key":"vary","value":"origin,accept-encoding"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"cache-control","value":"no-cache"},{"key":"content-encoding","value":"gzip"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 400,\n \"mensagem\": \"A transação já foi concluída!\"\n}"},{"id":"c61c9f5e-3455-4bfc-95ad-ec46f583ff1b","name":"Cancelado Anteriormente","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"codigo_transacao\": \"c84775f0-d783-4828-a4f5-b83d04f49f70\" \r\n}","options":{"raw":{"language":"json"}}},"url":"/tef/confirmar_pagamento"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 15 Aug 2025 17:33:16 GMT"},{"key":"Server","value":"Apache/2.4.58 (Ubuntu)"},{"key":"vary","value":"origin,accept-encoding"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"cache-control","value":"no-cache"},{"key":"content-encoding","value":"gzip"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 400,\n \"mensagem\": \"A operação não pode ser realizada\"\n}"}],"_postman_id":"19afd721-2fb6-46f0-bdc8-6c918a836865"},{"name":"Cancelar Pagamento","id":"7bc6bc86-13b6-41b2-897c-5e18ff8ea05b","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{}},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"codigo_transacao\": \"3a112e45-a84d-4448-b397-faf2b3c4a62b\" \r\n}","options":{"raw":{"language":"json"}}},"url":"/tef/cancelar_pagamento","description":"

Descrição

Este endpoint permite cancelar uma transação cujo pagamento foi previamente autorizado, solicitando ao banco emissor a devolução do valor retido ao cliente.

O cancelamento não gera impacto financeiro para sua empresa nem para o cliente, sendo ideal para situações em que a cobrança não deve prosseguir por qualquer motivo.

Corpo da Requisição

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

Campo	Tipo	Descrição
codigo_transacao*	string	Código UUID único que identifica a transação a ser cancelada.

","urlObject":{"path":["tef","cancelar_pagamento"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"fe2d7a78-fc21-43a8-8d56-563917e6d071","name":"Sucesso","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"codigo_transacao\": \"c84775f0-d783-4828-a4f5-b83d04f49f70\" \r\n}","options":{"raw":{"language":"json"}}},"url":"/tef/cancelar_pagamento"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 15 Aug 2025 17:32:52 GMT"},{"key":"Server","value":"Apache/2.4.58 (Ubuntu)"},{"key":"vary","value":"origin,accept-encoding"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"cache-control","value":"no-cache"},{"key":"content-encoding","value":"gzip"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"mensagem\": \"Transação Cancelada\",\n \"data\": {\n \"id_cartao\": 1976,\n \"identificador_externo\": \"170fbc0f-8a09-4a9c-9380-14fb53afdf5a\",\n \"status\": \"canceled\"\n }\n}"}],"_postman_id":"7bc6bc86-13b6-41b2-897c-5e18ff8ea05b"},{"name":"Consultar Pagamento","id":"1f66c7e4-fefc-4477-8e82-4b8f7c875185","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{}},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"codigo_transacao\": \"3a112e45-a84d-4448-b397-faf2b3c4a62b\" \r\n}","options":{"raw":{"language":"json"}}},"url":"/tef/consultar_pagamento","urlObject":{"path":["tef","consultar_pagamento"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"d1aa4191-5e33-493a-8ad6-414550980de4","name":"Sucesso","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"codigo_transacao\": \"102d426f-f066-445c-be5b-7c5df52c92b5\" \r\n}","options":{"raw":{"language":"json"}}},"url":"/tef/consultar_pagamento"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 15 Aug 2025 17:40:51 GMT"},{"key":"Server","value":"Apache/2.4.58 (Ubuntu)"},{"key":"vary","value":"origin,accept-encoding"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"cache-control","value":"no-cache"},{"key":"content-encoding","value":"gzip"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"mensagem\": \"Status da transação\",\n \"data\": {\n \"id_cartao\": 1978,\n \"identificador_externo\": \"8d893fee-24e2-4e51-b45b-f4e9c712af15\",\n \"status\": \"created\",\n \"valor\": \"350.00\",\n \"texto_instrucao\": \"Detalhes adicionais da cobrança...\",\n \"produtos\": [\n {\n \"id\": \"2349758934\",\n \"nome\": \"Camiseta M Gatinho\",\n \"imagem\": \"https://images.unsplash.com/photo-1576566588028-4147f3842f27?q=80&w=764&auto=format&fit=crop&ixlib=rb-4.1.0&ixid=M3wxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8fA%3D%3D\",\n \"descricao\": \"Camiseta Gatinho M - Bege - KiiKii\",\n \"valor\": \"74.99\"\n },\n {\n \"id\": \"34587645760\",\n \"nome\": \"Tênis Nike Air Force 3\",\n \"imagem\": \"https://images.unsplash.com/photo-1600269452121-4f2416e55c28?q=80&w=765&auto=format&fit=crop&ixlib=rb-4.1.0&ixid=M3wxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8fA%3D%3D\",\n \"descricao\": \"Tênis Nike Air Force 3 - Branco - 38\",\n \"valor\": \"200.00\"\n }\n ],\n \"historico\": [\n {\n \"type\": \"created\",\n \"data\": \"2025-08-15 13:40:18\"\n }\n ]\n }\n}"},{"id":"d9a16f6f-894b-4348-aea5-d7b8c0fb03af","name":"Não encontrado","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"codigo_transacao\": \"102d426f-f066-445c-be5b-7c5df52c94b5\" \r\n}","options":{"raw":{"language":"json"}}},"url":"/tef/consultar_pagamento"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 15 Aug 2025 17:41:31 GMT"},{"key":"Server","value":"Apache/2.4.58 (Ubuntu)"},{"key":"vary","value":"origin,accept-encoding"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"cache-control","value":"no-cache"},{"key":"content-encoding","value":"gzip"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 400,\n \"mensagem\": \"Código de transação não encontrado!\"\n}"}],"_postman_id":"1f66c7e4-fefc-4477-8e82-4b8f7c875185"},{"name":"Listar Bandeiras Disponíveis","id":"4906ba62-bda2-4d46-ab6c-0f61de01cb59","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{}},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"/tef/bandeiras","description":"

Descrição

Este endpoint retorna a lista de bandeiras de cartão habilitadas para a sua conta.

Com base nessa lista, você poderá aceitar pagamentos de clientes que possuam cartões vinculados a essas bandeiras.

Cada objeto retornado contém:

ID da bandeira, que pode ser utilizado para informar a bandeira no momento de realizar um pagamento ou para pré-configurar uma cobrança com uma bandeira específica.
\n
Número máximo de parcelas aceito por aquela bandeira, permitindo configurar adequadamente as condições de parcelamento oferecidas ao cliente.
\n

\n","urlObject":{"path":["tef","bandeiras"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"079e5aab-5b04-4128-bda9-b4e974bbd497","name":"Sucesso","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text","disabled":true},{"key":"token","value":"dfasdasdadasdasdaasd.dasdasdadasdasdasdasd.adsdasdasdadas","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"/tef/bandeiras"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 15 Aug 2025 17:42:19 GMT"},{"key":"Server","value":"Apache/2.4.58 (Ubuntu)"},{"key":"vary","value":"origin,accept-encoding"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"cache-control","value":"no-cache"},{"key":"content-encoding","value":"gzip"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"code\": 200,\n \"mensagem\": \"Bandeiras Disponíveis\",\n \"data\": [\n {\n \"id\": 1,\n \"sigla\": \"VISA\",\n \"numero_parcela_maximo\": 1\n },\n {\n \"id\": 2,\n \"sigla\": \"MASTER\",\n \"numero_parcela_maximo\": 4\n },\n {\n \"id\": 3,\n \"sigla\": \"AMEX\",\n \"numero_parcela_maximo\": 4\n },\n {\n \"id\": 6,\n \"sigla\": \"DINERS\",\n \"numero_parcela_maximo\": 2\n },\n {\n \"id\": 7,\n \"sigla\": \"ELO\",\n \"numero_parcela_maximo\": 5\n }\n ]\n}"}],"_postman_id":"4906ba62-bda2-4d46-ab6c-0f61de01cb59"},{"name":"Configurar Redirecionamento","id":"ad72be2e-9b25-4d58-b640-f24226895209","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{}},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"\r\n{\r\n \"tipo_redirecionamento\": \"sucesso\", \r\n \"url\": \"https://google.com\" \r\n \r\n}","options":{"raw":{"language":"json"}}},"url":"/tef/configurar_redirecionamento","description":"

Descrição

Este endpoint permite configurar as URLs de redirecionamento para seus clientes, de acordo com o status final de uma cobrança.

Você pode definir endereços distintos para cada um dos seguintes status:

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

Status	Descrição
`sucesso`	Quando a cobrança é concluída com pagamento confirmado.
`cancelamento`	Quando o pagamento é cancelado pelo cliente ou pelo comerciante.
`expirado`	Quando a cobrança não é paga dentro do prazo definido.
`autorizado`	Quando o pagamento é autorizado pelo emissor, mas ainda não capturado.
`voltar`	Quando o cliente opta por retornar ao site sem concluir a cobrança.

","urlObject":{"path":["tef","configurar_redirecionamento"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"2e448eb7-814f-4595-b412-9e8396b068c6","name":"Sucesso","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text","disabled":true}],"body":{"mode":"raw","raw":"\r\n{\r\n \"tipo_redirecionamento\": \"sucesso\", \r\n \"url\": \"https://google.com\" \r\n \r\n}","options":{"raw":{"language":"json"}}},"url":"/tef/configurar_redirecionamento"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 15 Aug 2025 17:43:41 GMT"},{"key":"Server","value":"Apache/2.4.58 (Ubuntu)"},{"key":"vary","value":"origin,accept-encoding"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"cache-control","value":"no-cache"},{"key":"content-encoding","value":"gzip"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"mensagem\": \"Redirecionamento configurado com sucesso!\"\n}"}],"_postman_id":"ad72be2e-9b25-4d58-b640-f24226895209"}],"id":"cbebe85c-a3d8-485c-b698-db2071696799","description":"

Os cartões são um dos meios de pagamento mais utilizados no mundo, especialmente no comércio eletrônico. Eles oferecem uma série de vantagens tanto para quem paga quanto para quem recebe, como parcelamento, pagamentos recorrentes, processamento instantâneo e diversas camadas de segurança.

Além disso, a ampla adesão da população ao uso de cartões de crédito e débito torna esse método uma escolha estratégica para empresas que desejam ampliar sua base de clientes e facilitar a conversão de vendas.

Esta seção da documentação apresenta os recursos disponíveis para pagamentos com cartão via API Canvi, permitindo que você integre transações com eficiência, segurança e total controle sobre o fluxo de cobrança.

Sistemas TEF

Dentro do contexto de pagamentos com cartões, onde a Canvi atua, existe um ecossistema composto por diversas entidades interligadas, cada uma com características e responsabilidades específicas. Essas entidades trabalham em conjunto para garantir a segurança, confiabilidade e eficiência das transações eletrônicas, conhecidas como TEF (Transações Eletrônicas de Fundos).

Entre os principais participantes desse ecossistema, destacam-se:

Emissores (ou bancos emissores):
Representam os clientes nas transações. São responsáveis por emitir os cartões, vinculados a uma bandeira, para os usuários finais, e por verificar se há saldo disponível no momento da cobrança, autorizando ou recusando a transação conforme o caso.
\n
Bandeiras de cartão:
Atuam como intermediadoras entre adquirentes e emissores. São responsáveis por prover a infraestrutura de comunicação entre os participantes e garantir que as transações sejam roteadas corretamente.
\n
Adquirentes:
Representam o seu negócio nas transações com cartão. São responsáveis por capturar os pagamentos dos clientes e assegurar que os valores sejam devidamente repassados para a conta da sua empresa. Além disso, fornecem os meios técnicos para processar as cobranças e um identificador exclusivo que permite a comunicação com as bandeiras de cartão.
\n
Processadoras de Pagamentos:
É neste ponto do processo que a Canvi atua diretamente, como intermediadora entre empresas e clientes nas transações com cartões. A processadora de pagamentos é responsável por gerenciar o fluxo de transações, encaminhando as solicitações de autorização para as instituições financeiras envolvidas e assegurando que todo o processo ocorra de forma segura, rápida e eficiente.
\n

Esse conjunto de interações garante que as operações com cartão ocorram de forma transparente, segura e eficiente para todas as partes envolvidas.

Fluxo de Pagamentos

Agora que você conhece as principais entidades envolvidas no mundo dos cartões, confira o processo do pagamento de uma cobrança e como cada uma dessas entidades se relaciona entre si para garantir que sua operação seja segura e eficiente

O diagrama abaixo ilustra o pagamento de uma cobrança e todas as etapas necessárias até que o valor correto seja repassado do cliente ao comerciante:

\n $\"Relacionamento%20entre%20entidades%20TEF\"$ \n\n

Descrição de cada etapa:

O cliente inicia um pagamento inserindo ou aproximando o cartão em um terminal de ponto de venda (POS) ou preenchendo os dados de um Checkout.
\n
O processador de pagamentos envia os dados da transação para o adquirente, que envia às bandeiras de cartão.
\n
As bandeiras de cartão processam a solicitação e perguntam ao emissor se os fundos estão disponíveis, e o emissor aprova ou recusa após examinar as contas do titular do cartão.
\n
Esses dados são enviados para a bandeira do cartão, que envia a notificação de aprovação ou recusa ao adquirente, que informa a empresa sobre o status da transação.
\n
Se aprovado, o dinheiro passa do emissor para o adquirente e é depositado na conta bancária do comerciante (normalmente em D+1).
\n

Canvi & Adquirentes

A Canvi atua exclusivamente como Processadora de Pagamentos.

Para viabilizar transações com cartão, é necessário que nossos clientes estejam integrados a uma adquirente parceira. Atualmente, contamos com integração às duas principais adquirentes do mercado: Cielo e PagBank. Em breve, ampliaremos nosso portfólio, oferecendo ainda mais opções e flexibilidade para o seu negócio.

Para iniciar a integração, entre em contato pelos canais de comunicação informados na sua integração com a Canvi. Nossa equipe dará todo o suporte necessário para conectar sua operação à adquirente escolhida, de forma ágil e simplificada.

Status da Cobrança

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

Status	Descrição
`CREATED`	A cobrança foi iniciada e está aguardando o pagamento
`PAID`	A transação foi autorizada e o valor foi transferido da conta do emissor para a adquirente
`CANCELED`	A cobrança foi cancelada pelo comerciante ou recusada pelo banco emissor
`AUTHORIZED`	O pagamento foi aprovado pelo emissor, mas ainda não liquidado
`PREAUTHORIZED`	O emissor confirmou a validade do cartão e a disponibilidade de fundos, realizando uma retenção temporária do valor sem efetuar a transferência para a adquirente

Observações Importantes

Os valores transacionados por meio de pagamentos via cartão, não ficam retidos na plataforma da Canvi, isso fica na responsabilidade da Adquirente, inclusive repassar os valores recebidos para sua conta bancária.

\n","_postman_id":"cbebe85c-a3d8-485c-b698-db2071696799"},{"name":"Conciliador (Novidade)","item":[{"name":"Relatórios","item":[{"name":"Vendas","id":"5d8e564f-6a78-4f3c-bd32-6b10cd1aebeb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"/conciliador/consulta/vendas?data_inicial=2021-05-01&data_final=2025-10-31&limite=50&pagina=1","description":"

Descrição

Esta rota permite consultar o saldo atual da sua conta Canvi, juntamente com a data da última atualização e o código identificador da conta.

\n","urlObject":{"path":["conciliador","consulta","vendas"],"host":[""],"query":[{"key":"data_inicial","value":"2021-05-01"},{"key":"data_final","value":"2025-10-31"},{"key":"limite","value":"50"},{"key":"pagina","value":"1"},{"disabled":true,"key":"id_adquirente","value":""},{"disabled":true,"key":"id_meio_pagamento","value":""},{"disabled":true,"key":"id_produto","value":""}],"variable":[]}},"response":[{"id":"7b4f879a-8f93-4f1d-8e24-9f9c5cde89c4","name":"Sucesso","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"/bt/saldo"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 04 Aug 2025 21:10:58 GMT"},{"key":"Server","value":"Apache/2.4.58 (Ubuntu)"},{"key":"vary","value":"origin,accept-encoding"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"cache-control","value":"no-cache"},{"key":"content-encoding","value":"gzip"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"code\": 200,\n \"mensagem\": \"Saldo da Empresa\",\n \"data\": {\n \"soma_saldo\": \"1276.62\",\n \"data_atualizacao\": \"2025-08-04 16:46:35\",\n \"conta\": \"91cak4f9-4u72-17f0-a36f-42810b400012\"\n }\n}"}],"_postman_id":"5d8e564f-6a78-4f3c-bd32-6b10cd1aebeb"},{"name":"Repasses","id":"6f322d0b-3a9b-434f-a034-fb5fd7078000","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"/conciliador/consulta/repasses?data_inicial=2021-05-01&data_final=2025-10-31&limite=50&pagina=1","description":"

Descrição

Esta rota permite consultar o saldo atual da sua conta Canvi, juntamente com a data da última atualização e o código identificador da conta.

\n","urlObject":{"path":["conciliador","consulta","repasses"],"host":[""],"query":[{"key":"data_inicial","value":"2021-05-01"},{"key":"data_final","value":"2025-10-31"},{"key":"limite","value":"50"},{"key":"pagina","value":"1"},{"disabled":true,"key":"id_adquirente","value":""},{"disabled":true,"key":"id_meio_pagamento","value":""},{"disabled":true,"key":"id_produto","value":""}],"variable":[]}},"response":[{"id":"fda14df5-38ce-44e7-9b5f-23daf4b0e105","name":"Sucesso","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"/bt/saldo"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 04 Aug 2025 21:10:58 GMT"},{"key":"Server","value":"Apache/2.4.58 (Ubuntu)"},{"key":"vary","value":"origin,accept-encoding"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"cache-control","value":"no-cache"},{"key":"content-encoding","value":"gzip"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"code\": 200,\n \"mensagem\": \"Saldo da Empresa\",\n \"data\": {\n \"soma_saldo\": \"1276.62\",\n \"data_atualizacao\": \"2025-08-04 16:46:35\",\n \"conta\": \"91cak4f9-4u72-17f0-a36f-42810b400012\"\n }\n}"}],"_postman_id":"6f322d0b-3a9b-434f-a034-fb5fd7078000"},{"name":"Ajustes","id":"e502dba5-bc7b-4458-a5fc-52757a075cba","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"/conciliador/consulta/ajustes?data_inicial=2021-05-01&data_final=2025-10-31&limite=50&pagina=1","description":"

Descrição

Esta rota permite consultar o saldo atual da sua conta Canvi, juntamente com a data da última atualização e o código identificador da conta.

\n","urlObject":{"path":["conciliador","consulta","ajustes"],"host":[""],"query":[{"key":"data_inicial","value":"2021-05-01"},{"key":"data_final","value":"2025-10-31"},{"key":"limite","value":"50"},{"key":"pagina","value":"1"},{"disabled":true,"key":"id_adquirente","value":""},{"disabled":true,"key":"id_meio_pagamento","value":""},{"disabled":true,"key":"id_produto","value":""}],"variable":[]}},"response":[{"id":"de1932ec-d39e-4fb7-9568-c6f01f97a1e6","name":"Sucesso","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"/bt/saldo"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 04 Aug 2025 21:10:58 GMT"},{"key":"Server","value":"Apache/2.4.58 (Ubuntu)"},{"key":"vary","value":"origin,accept-encoding"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"cache-control","value":"no-cache"},{"key":"content-encoding","value":"gzip"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"code\": 200,\n \"mensagem\": \"Saldo da Empresa\",\n \"data\": {\n \"soma_saldo\": \"1276.62\",\n \"data_atualizacao\": \"2025-08-04 16:46:35\",\n \"conta\": \"91cak4f9-4u72-17f0-a36f-42810b400012\"\n }\n}"}],"_postman_id":"e502dba5-bc7b-4458-a5fc-52757a075cba"}],"id":"064ac514-10f0-44ed-825b-50fdde9afee8","_postman_id":"064ac514-10f0-44ed-825b-50fdde9afee8","description":""},{"name":"Comum","item":[{"name":"Bandeiras","id":"1022472e-8922-405d-a8e9-6886374ef4b1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"{{url}}/conciliador/comum/bandeiras","urlObject":{"path":["conciliador","comum","bandeiras"],"host":["{{url}}"],"query":[{"disabled":true,"key":"id_bandeira","value":"1"}],"variable":[]}},"response":[],"_postman_id":"1022472e-8922-405d-a8e9-6886374ef4b1"},{"name":"Adquirentes","id":"1a933170-51bf-4861-aa50-409ac3d4e10e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"{{url}}/conciliador/comum/adquirentes","urlObject":{"path":["conciliador","comum","adquirentes"],"host":["{{url}}"],"query":[{"disabled":true,"description":{"content":"

Opcional

\n","type":"text/plain"},"key":"id_adquirente","value":"1"}],"variable":[]}},"response":[],"_postman_id":"1a933170-51bf-4861-aa50-409ac3d4e10e"},{"name":"Meio Pagamento","id":"de7a9b14-737c-4613-adca-3502e750fd69","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"{{url}}/conciliador/comum/meio_pagamento","urlObject":{"path":["conciliador","comum","meio_pagamento"],"host":["{{url}}"],"query":[{"disabled":true,"description":{"content":"

Opcional

\n","type":"text/plain"},"key":"id_adquirente","value":""}],"variable":[]}},"response":[],"_postman_id":"de7a9b14-737c-4613-adca-3502e750fd69"},{"name":"Planos","id":"1c541def-40cb-4d30-a2fb-202da3a09882","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"{{url}}/conciliador/comum/planos?id_adquirente=1","urlObject":{"path":["conciliador","comum","planos"],"host":["{{url}}"],"query":[{"key":"id_adquirente","value":"1"}],"variable":[]}},"response":[],"_postman_id":"1c541def-40cb-4d30-a2fb-202da3a09882"},{"name":"Produtos","id":"325508ac-9766-45d3-b4b2-03293efb1861","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"{{url}}/conciliador/comum/produtos?id_adquirente=1","urlObject":{"path":["conciliador","comum","produtos"],"host":["{{url}}"],"query":[{"key":"id_adquirente","value":"1"}],"variable":[]}},"response":[],"_postman_id":"325508ac-9766-45d3-b4b2-03293efb1861"}],"id":"8ad7e01f-0579-4604-9267-48847eec467c","_postman_id":"8ad7e01f-0579-4604-9267-48847eec467c","description":""},{"name":"Adquirentes","item":[{"name":"Adquirentes","id":"e506a889-8607-46d7-a79f-9e17093dad66","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"id_adquirente\": 1 \r\n //\"codigo_estabelecimento\": \"ABCE1234\",\r\n //\"codigo_ponto_venda\": \"dasasda\",\r\n //\"chave_api\": \"ADETA\",\r\n //\"versao_api\": \"V5\",\r\n //\"identificador_chave_api\": \"F5041104E37FC031101AB0107BFEFCC67FCE68106095F50411\"\r\n //\"email\": \"email@email.com.br\"\r\n \r\n \r\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/conciliador/adquirente","urlObject":{"path":["conciliador","adquirente"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"e506a889-8607-46d7-a79f-9e17093dad66"},{"name":"Adquirentes","id":"2cabe477-d70d-4959-9c32-cddf6a1d97c3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"{{url}}/conciliador/adquirente?id_adquirente=1","urlObject":{"path":["conciliador","adquirente"],"host":["{{url}}"],"query":[{"key":"id_adquirente","value":"1"}],"variable":[]}},"response":[],"_postman_id":"2cabe477-d70d-4959-9c32-cddf6a1d97c3"}],"id":"b250f350-4ab1-4b60-9d0a-93c024ed42ba","_postman_id":"b250f350-4ab1-4b60-9d0a-93c024ed42ba","description":""},{"name":"Taxas Acordadas","item":[{"name":"Taxas","id":"b6354116-65da-45b0-98b3-500aac8490d7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"id_adquirente\": 1, \r\n \"id_produto\": 60,\r\n \"id_plano\": 41,\r\n \"taxa\": 1,\r\n \"data_inicial\": \"2025-01-01\",\r\n \"data_final\": \"2025-10-01\"\r\n \r\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/conciliador/adquirente/taxa","urlObject":{"path":["conciliador","adquirente","taxa"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"b6354116-65da-45b0-98b3-500aac8490d7"},{"name":"Taxas","id":"77dc5841-2cfd-41ea-a9c6-5b71d92fe120","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"{{url}}/conciliador/adquirente/taxa","urlObject":{"path":["conciliador","adquirente","taxa"],"host":["{{url}}"],"query":[{"disabled":true,"description":{"content":"

Opcional

\n","type":"text/plain"},"key":"id_adquirente","value":""}],"variable":[]}},"response":[],"_postman_id":"77dc5841-2cfd-41ea-a9c6-5b71d92fe120"}],"id":"c8611b63-59f6-4571-ab9e-ae9af768fdd5","_postman_id":"c8611b63-59f6-4571-ab9e-ae9af768fdd5","description":""},{"name":"Consultas","item":[{"name":"Geral","id":"c551fa39-8504-4cbf-9237-86260e561830","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"/conciliador/consulta/geral?data_inicial=2021-05-01&data_final=2025-10-31","description":"

Descrição

Esta rota permite consultar o saldo atual da sua conta Canvi, juntamente com a data da última atualização e o código identificador da conta.

\n","urlObject":{"path":["conciliador","consulta","geral"],"host":[""],"query":[{"key":"data_inicial","value":"2021-05-01"},{"key":"data_final","value":"2025-10-31"},{"disabled":true,"key":"id_adquirente","value":"2"},{"disabled":true,"key":"id_meio_pagamento","value":""},{"disabled":true,"key":"id_produto","value":""}],"variable":[]}},"response":[],"_postman_id":"c551fa39-8504-4cbf-9237-86260e561830"},{"name":"Venda por Dia","id":"3cb38cdd-e9f8-46ed-82b0-a8fdf16d42f7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"/conciliador/consulta/venda/dia?data_inicial=2021-05-01&data_final=2025-10-31","description":"

Descrição

Esta rota permite consultar o saldo atual da sua conta Canvi, juntamente com a data da última atualização e o código identificador da conta.

\n","urlObject":{"path":["conciliador","consulta","venda","dia"],"host":[""],"query":[{"key":"data_inicial","value":"2021-05-01"},{"key":"data_final","value":"2025-10-31"},{"disabled":true,"key":"id_adquirente","value":"2"},{"disabled":true,"key":"id_meio_pagamento","value":""},{"disabled":true,"key":"id_produto","value":""}],"variable":[]}},"response":[],"_postman_id":"3cb38cdd-e9f8-46ed-82b0-a8fdf16d42f7"},{"name":"Venda por Meio Pagamento","id":"cbf730a9-8edb-4a31-9bab-6a5af3e2887e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"/conciliador/consulta/venda/meio_pagamento","description":"

Descrição

Esta rota permite consultar o saldo atual da sua conta Canvi, juntamente com a data da última atualização e o código identificador da conta.

\n","urlObject":{"path":["conciliador","consulta","venda","meio_pagamento"],"host":[""],"query":[{"disabled":true,"key":"data_inicial","value":"2021-05-01"},{"disabled":true,"key":"data_final","value":"2025-10-31"},{"disabled":true,"key":"id_adquirente","value":"2"},{"disabled":true,"key":"id_meio_pagamento","value":""},{"disabled":true,"key":"id_produto","value":""}],"variable":[]}},"response":[],"_postman_id":"cbf730a9-8edb-4a31-9bab-6a5af3e2887e"},{"name":"Venda por Plano","id":"eca6cb24-7818-4c3b-8b0e-fddbffca75af","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"/conciliador/consulta/venda/plano","description":"

Descrição

Esta rota permite consultar o saldo atual da sua conta Canvi, juntamente com a data da última atualização e o código identificador da conta.

\n","urlObject":{"path":["conciliador","consulta","venda","plano"],"host":[""],"query":[{"disabled":true,"key":"data_inicial","value":"2021-05-01"},{"disabled":true,"key":"data_final","value":"2025-10-31"},{"disabled":true,"key":"id_adquirente","value":"2"},{"disabled":true,"key":"id_meio_pagamento","value":""},{"disabled":true,"key":"id_produto","value":""}],"variable":[]}},"response":[],"_postman_id":"eca6cb24-7818-4c3b-8b0e-fddbffca75af"},{"name":"Venda por Bandeira","id":"dd3340ce-90c5-4f68-bfe8-ee9f42fd9d7e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"/conciliador/consulta/venda/bandeira","description":"

Descrição

Esta rota permite consultar o saldo atual da sua conta Canvi, juntamente com a data da última atualização e o código identificador da conta.

\n","urlObject":{"path":["conciliador","consulta","venda","bandeira"],"host":[""],"query":[{"disabled":true,"key":"data_inicial","value":"2021-05-01"},{"disabled":true,"key":"data_final","value":"2025-10-31"},{"disabled":true,"key":"id_adquirente","value":"2"},{"disabled":true,"key":"id_meio_pagamento","value":""},{"disabled":true,"key":"id_produto","value":""}],"variable":[]}},"response":[],"_postman_id":"dd3340ce-90c5-4f68-bfe8-ee9f42fd9d7e"},{"name":"Venda por Produto","id":"9d74c468-eeec-428c-a4ba-40bf8878393d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"/conciliador/consulta/venda/produto","description":"

Descrição

Esta rota permite consultar o saldo atual da sua conta Canvi, juntamente com a data da última atualização e o código identificador da conta.

\n","urlObject":{"path":["conciliador","consulta","venda","produto"],"host":[""],"query":[{"disabled":true,"key":"data_inicial","value":"2021-05-01"},{"disabled":true,"key":"data_final","value":"2025-10-31"},{"disabled":true,"key":"id_adquirente","value":"2"},{"disabled":true,"key":"id_meio_pagamento","value":""},{"disabled":true,"key":"id_produto","value":""}],"variable":[]}},"response":[],"_postman_id":"9d74c468-eeec-428c-a4ba-40bf8878393d"},{"name":"Venda por Adquirente","id":"2b2a6b36-1751-4449-9d26-ff451c360f1a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"/conciliador/consulta/venda/adquirente","description":"

Descrição

Esta rota permite consultar o saldo atual da sua conta Canvi, juntamente com a data da última atualização e o código identificador da conta.

\n","urlObject":{"path":["conciliador","consulta","venda","adquirente"],"host":[""],"query":[{"disabled":true,"key":"data_inicial","value":"2021-05-01"},{"disabled":true,"key":"data_final","value":"2025-10-31"},{"disabled":true,"key":"id_adquirente","value":"2"},{"disabled":true,"key":"id_meio_pagamento","value":""},{"disabled":true,"key":"id_produto","value":""}],"variable":[]}},"response":[],"_postman_id":"2b2a6b36-1751-4449-9d26-ff451c360f1a"},{"name":"Repasse por Dia","id":"4f4a66d6-a6c9-423d-a0e0-b34b52942246","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"/conciliador/consulta/repasse/dia","description":"

Descrição

Esta rota permite consultar o saldo atual da sua conta Canvi, juntamente com a data da última atualização e o código identificador da conta.

\n","urlObject":{"path":["conciliador","consulta","repasse","dia"],"host":[""],"query":[{"disabled":true,"key":"data_inicial","value":"2021-05-01"},{"disabled":true,"key":"data_final","value":"2025-10-31"},{"disabled":true,"key":"id_adquirente","value":"2"},{"disabled":true,"key":"id_meio_pagamento","value":""},{"disabled":true,"key":"id_produto","value":""}],"variable":[]}},"response":[],"_postman_id":"4f4a66d6-a6c9-423d-a0e0-b34b52942246"},{"name":"Repasse por Dia Detalhado","id":"3a6990ef-c3d7-4e9f-b2a1-f280ded0fa1b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"/conciliador/consulta/repasse/dia_detalhado","description":"

Descrição

Esta rota permite consultar o saldo atual da sua conta Canvi, juntamente com a data da última atualização e o código identificador da conta.

\n","urlObject":{"path":["conciliador","consulta","repasse","dia_detalhado"],"host":[""],"query":[{"disabled":true,"key":"data_inicial","value":"2021-05-01"},{"disabled":true,"key":"data_final","value":"2025-10-31"},{"disabled":true,"key":"id_adquirente","value":"2"},{"disabled":true,"key":"id_meio_pagamento","value":""},{"disabled":true,"key":"id_produto","value":""}],"variable":[]}},"response":[],"_postman_id":"3a6990ef-c3d7-4e9f-b2a1-f280ded0fa1b"}],"id":"ba727fee-b2a9-4a7e-80c4-ffd3af47f1c0","_postman_id":"ba727fee-b2a9-4a7e-80c4-ffd3af47f1c0","description":""}],"id":"3fa2a9dc-a7b4-49f3-9f3d-82f510191485","_postman_id":"3fa2a9dc-a7b4-49f3-9f3d-82f510191485","description":""}],"variable":[{"key":"urlBase","value":"","type":"default"}]}

Introdução

Visão Geral

Estrutura da Resposta

Data e Hora

URLs Base

Primeiros Passos

Descrição

Corpo da Requisição

Respostas

Detalhes importantes:

Boas Práticas

✅ Armazene e reutilize seu token

⚠️ Gerar um novo token a cada requisição é uma prática não recomendada, pois:

⏳ Validade do Token

🔒 Segurança

Descrição

Corpo da Requisição

Cliente

Split

Informações relevantes

📌 Como informar corretamente valores monetários

✨ Diferença entre pixStaticCashin e pixStaticCashinSemStatus

ℹ️ Sobre os campos identificador_externo e identificador_movimento

Descrição

Corpo da Requisição

Descrição

Corpo da Requisição

Descrição

Corpo da Requisição

Descrição

Corpo da Requisição

Pagamento

Recomendações de uso:

Fluxo de Cobranças Estáticas

Descrição

Corpo da Requisição

Cliente

Split

Informações relevantes

📌 Como informar corretamente valores monetários

✨ Diferença entre pixCashin e pixCashinSemStatus

ℹ️ Sobre os campos identificador_externo e identificador_movimento

Descrição

Descrição

Descrição

Corpo da Requisição

Descrição

Corpo da Requisição

Pagamento

Descrição

Características principais:

Recomendações de uso:

Vantagens:

Status das Cobranças

Descrição

Corpo da Requisição

Multa

Juros

Desconto

Pagador*

Cliente

Split

Descrição

Corpo da Requisição

Descrição

Descrição

Corpo da Requisição

Descrição

Corpo da Requisição

Pagamento

Descrição

Características principais

Suporta:

Recomendações de uso

Vantagens

Fluxo de Cobrança com Boleto

Geração

Liquidação

Status da Cobrança

Observações Importantes

✨ Diferença entre `pixStaticCashin` e `pixStaticCashinSemStatus`

ℹ️ Sobre os campos `identificador_externo` e `identificador_movimento`

✨ Diferença entre `pixCashin` e `pixCashinSemStatus`

ℹ️ Sobre os campos `identificador_externo` e `identificador_movimento`

Subobjeto: `financeiro`

Subobjeto: `endereco`

Subobjeto: `endereco`

`cartao`

`cartao.titular`