{"info":{"_postman_id":"7e771758-5a77-4373-9a20-bf3ca4056d0a","name":"Bankizi - BaaS - Versão Português","description":"

Introdução ao Bankizi BaaS

A Bankizi BaaS é uma plataforma completa de Banking as a Service, que oferece toda a infraestrutura tecnológica e financeira para que empresas possam criar e operar seus próprios produtos bancários digitais de forma ágil, segura e escalável.

Com uma arquitetura moderna e modular, a Bankizi permite integrar contas digitais, PIX, boletos, cartões, liquidação bancária, motor de taxas, controle de saldos e relatórios em uma única API.

Nosso objetivo é simplificar o acesso ao sistema financeiro, oferecendo soluções flexíveis que se adaptam ao modelo de negócio de cada parceiro.

\n
Bankizi BaaS — infraestrutura financeira para empresas que constroem o futuro dos serviços digitais.
\n

Bem-vindo à API Bankizi BaaS

Olá, desenvolvedor!

Bem-vindo à sua jornada de integração com a API Bankizi BaaS.

A Bankizi é uma plataforma de Banking as a Service (BaaS) que fornece uma camada completa de serviços financeiros via API — incluindo abertura de conta, gestão de subcontas, transferências, PIX, boletos, cartões, controle de saldos, extratos e motor de taxas.

Nosso ecossistema foi construído sobre uma arquitetura de microserviços distribuídos, garantindo alta disponibilidade, elasticidade, segurança e conformidade com padrões regulatórios e de prevenção a fraudes.

Com a API Bankizi BaaS, sua empresa pode:

Criar e gerenciar contas digitais para pessoas físicas e jurídicas.
\n
Processar transações financeiras em tempo real (PIX, TED, boleto).
\n
Controlar saldos e liquidações com total precisão contábil.
\n
Personalizar taxas, limites e regras de negócio por conta ou provedor.
\n
Integrar-se com múltiplas instituições financeiras através de um único ponto de conexão.
\n

Principais benefícios

Infraestrutura modular e escalável.
\n
APIs REST padronizadas e documentadas.
\n
Painel administrativo e relatórios detalhados.
\n
Integração com provedores bancários múltiplos.
\n
Suporte técnico dedicado e ágil.
\n

Precisa de ajuda?

A equipe da Bankizi está pronta para garantir o sucesso da sua integração.

📩 contato@izipaynow.com

🟡 Ambiente de homologação

O ambiente de homologação permanece desligado diariamente das 20h às 8h (horário de Brasília).
Durante os fins de semana, é pausado às 20h de sexta-feira e reativado às 8h de segunda-feira.

Caso precise de acesso fora desse período, entre em contato com o suporte.

Headers Importantes

x-target-account-id

Caso você esteja utilizando uma única credencial para realizar ações em todas as contas que você administra, é necessário enviar o seguinte header na requisição: x-target-account-id

Neste header você vai informar qual é a conta que será executado a ação. É nesse header que você indica em qual conta será criado o qr code, feito um saque e até para buscar transação.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"41941457","collectionId":"7e771758-5a77-4373-9a20-bf3ca4056d0a","publishedId":"2sB3WwqHLd","public":true,"customColor":{"top-bar":"731118","right-sidebar":"303030","highlight":"BF2D38"},"publishDate":"2025-11-24T14:34:52.000Z"},"item":[{"name":"Autenticação","item":[{"name":"Autenticação","event":[{"listen":"test","script":{"id":"ad1742af-5b7f-4365-a3e9-c72922315c73","exec":["pm.environment.set(\"AUTH_TOKEN\", pm.response.json().access_token);"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"a8841f48-346f-4671-aa5c-729ab938f36c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"client_credentials","type":"text","uuid":"528e7197-5a97-4530-b011-c2090a43d8aa"},{"key":"client_id","value":"{{APP_CLIENT}}","type":"text","uuid":"26be2183-c817-4e25-944a-211a4fb12b56"},{"key":"client_secret","value":"{{CLIENT_SECRET}}","type":"text","uuid":"1ea46bed-4748-456b-bcaa-6d46003c4661"}]},"url":"{{URL_BASE}}/auth/oauth/token","description":"

📌 O que cada campo significa (x-www-form-urlencoded):

grant_type: tipo do fluxo de autenticação. Para este caso, use sempre client_credentials.
\n
client_id: identificador único da aplicação, fornecido pela plataforma.
\n
client_secret: chave secreta da aplicação, também fornecida pela plataforma.
\n

🔁 Resposta da API

📌 O que está incluso:

access_token: token de acesso gerado, que deve ser usado nas requisições subsequentes.
\n
token_type: tipo do token, geralmente Bearer.
\n
expires_in: tempo de expiração do token, em segundos.
\n

\n","urlObject":{"path":["auth","oauth","token"],"host":["{{URL_BASE}}"],"query":[],"variable":[]}},"response":[{"id":"85948045-7a5a-450d-b8f0-d6a60f66e643","name":"Autenticação","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"client_credentials","type":"text","uuid":"528e7197-5a97-4530-b011-c2090a43d8aa"},{"key":"client_id","value":"{{APP_CLIENT}}","type":"text","uuid":"26be2183-c817-4e25-944a-211a4fb12b56"},{"key":"client_secret","value":"{{CLIENT_SECRET}}","type":"text","uuid":"1ea46bed-4748-456b-bcaa-6d46003c4661"}]},"url":"{{URL_BASE}}/auth/oauth/token"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"access_token\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjbGllbnRJZCI6IjV2azRqcDJtbjRoNGRuNjJ1MDZmcXBoMHEiLCJjbGllbnROYW1lIjoiYWNjb3VudCB0ZXN0ZSIsImFwcENsaWVudElkIjoiMSIsImlhdCI6MTc0NDY0MzMyNiwiZXhwIjoxNzQ0NjQ2OTI2fQ.BBaVa_dpNP3IajA2S8diNmKMVi1umUfe44uRSNCLRM4\",\n \"token_type\": \"Bearer\",\n \"expires_in\": 3600\n}"}],"_postman_id":"a8841f48-346f-4671-aa5c-729ab938f36c"}],"id":"1ce2e7ff-d4ed-4535-a921-d83f91289652","description":"

🔑 O que é a Autenticação via Client Credentials?

Esse endpoint permite que sua aplicação obtenha um token de acesso usando as credenciais do cliente (client ID e client secret). Esse fluxo é ideal para comunicações machine-to-machine, como sistemas backend que precisam consumir APIs de forma segura e sem intervenção do usuário.

\n","_postman_id":"1ce2e7ff-d4ed-4535-a921-d83f91289652"},{"name":"Abertura de Contas","item":[{"name":"Gerar URL para Upload de Documentos","id":"3c750769-62dd-4e21-a2b5-489f92dfe2b4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"documents\": [\r\n {\r\n \"documentType\": \"PERSON_PROOF_OF_ADDRESS\",\r\n \"key\": \"person/71850645035/20251117102553_COMPROVANTE_RESIDENCIA_PF_1. comprovante-endereco-pf.pdf\",\r\n \"mimeType\": \"application/pdf\"\r\n },\r\n {\r\n \"documentType\": \"IDENTITY_DOCUMENT\",\r\n \"key\": \"person/71850645035/20251117102553_DOCUMENTO_IDENTIDADE_6.Identificacao PF.pdf\",\r\n \"mimeType\": \"application/pdf\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{URL_BASE}}/accounts/open/generate-upload-url","description":"

Gerar URL para Upload de Documentos

Este endpoint é responsável por fornecer URL para realizar upload do documento em nossa base de dados. A resposta fornece uma URL, a qual o usuário utiliza para realizar o upload do documento via requisição POST.

📌 O que cada campo significa:

documents: Array de objetos dos dados do documento.
\n
- documentType: identificador do tipo de documento de acordo com as opções
  \n
  - IDENTITY_DOCUMENT
    \n
  - PERSON_PROOF_OF_ADDRESS
    \n
  - SELFIE_WITH_IDENTITY_DOCUMENT
    \n
  - COMPANY_CONSTITUTION
    \n
  - CNPJ_CARD
    \n
  - ENTERPRISE_PROOF_OF_ADDRESS
    \n
  - REVENUE_STATEMENT
    \n
  \n
- key: chave que identifica o caminho único do documento. IMPORTANTE: Essa chave deverá estar no seguinte formato: tipo-conta/documento-conta/timestamp_tipo-documento_nome-arquivo.formato
  \n
  - Exemplo (Documento de Comprovante de Endereço para Pessoa Física):
    \n
    - person/12345678910/20251117162301_PERSON_PROOF_OF_ADDRESS_comprovante-endereco-pf.pdf
    \n
  - Exemplo (Documento de Comprovante de Endereço para Pessoa Jurídica):
    \n
    - enterprise/12345678910112/20251117162301_ENTERPRISE_PROOF_OF_ADDRESS_comprovante-endereco-pj.pdf
    \n
  \n
- mimeType: descrição do tipo do arquivo. Exemplo: application/pdf
  \n
\n

\n","urlObject":{"path":["accounts","open","generate-upload-url"],"host":["{{URL_BASE}}"],"query":[],"variable":[]}},"response":[{"id":"5a2a5729-cdf2-4174-aca9-240e9ee3b873","name":"Gerar URL para Upload de Documentos","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"documents\": [\r\n {\r\n \"documentType\": \"PERSON_PROOF_OF_ADDRESS\",\r\n \"key\": \"person/71850645035/20251117102553_COMPROVANTE_RESIDENCIA_PF_1. comprovante-endereco-pf.pdf\",\r\n \"mimeType\": \"application/pdf\"\r\n },\r\n {\r\n \"documentType\": \"IDENTITY_DOCUMENT\",\r\n \"key\": \"person/71850645035/20251117102553_DOCUMENTO_IDENTIDADE_6.Identificacao PF.pdf\",\r\n \"mimeType\": \"application/pdf\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{URL_BASE}}/accounts/open/generate-upload-url"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"3c750769-62dd-4e21-a2b5-489f92dfe2b4"},{"name":"Abertura de Conta PF - Pessoa Física","id":"45f6f4cc-5035-4d0c-8f30-fa13fdf09cb4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"origin\": \"client-name\",\r\n \"fullName\": \"John Doe\",\r\n \"document\": \"123.456.789-10\",\r\n \"email\": \"email@email.com.br\",\r\n \"phone\": \"(12) 34567-8910\",\r\n \"birthDate\": \"1990-01-01T03:00:00.000Z\",\r\n \"nationality\": \"BRAZILIAN\",\r\n \"maritalStatus\": \"SINGLE\",\r\n \"bankData\": {\r\n \"bankCode\": \"001\",\r\n \"bankName\": \"BANCO DO BRASIL S.A.\",\r\n \"bankAgency\": \"1234-5\",\r\n \"accountNumber\": \"12345-6\",\r\n \"accountType\": \"CHECKING\"\r\n },\r\n \"preferencesServices\": {\r\n \"paymentPix\": true,\r\n \"paymentBill\": true,\r\n \"transactCard\": true,\r\n \"apiIntegration\": true,\r\n \"tradeCryptoassets\": false\r\n },\r\n \"documents\": [\r\n {\r\n \"documentType\": \"PERSON_PROOF_OF_ADDRESS\",\r\n \"key\": \"person/12345678910/20251117104253_COMPROVANTE_RESIDENCIA_PF_person-proof-of-adress-file.pdf\",\r\n \"name\": \"person-proof-of-adress-file.pdf\"\r\n },\r\n {\r\n \"documentType\": \"IDENTITY_DOCUMENT\",\r\n \"key\": \"person/12345678910/20251117104253_DOCUMENTO_IDENTIDADE_identify-document-file.pdf\",\r\n \"name\": \"identify-document-file.pdf\"\r\n },\r\n {\r\n \"documentType\": \"SELFIE_WITH_IDENTITY_DOCUMENT\",\r\n \"key\": \"person/12345678910/20251117102053_SELFIE_COM_DOCUMENTO_IDENTIDADE_selfie-with-document.png\",\r\n \"name\": \"selfie-with-document.png\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{URL_BASE}}/accounts/open/pf","description":"

Solicitação de Abertura de Conta - Pessoa Física

Este endpoint é responsável por enviar os dados para solicitação de abertura de conta do tipo Pessoa Física no sistema Bankizi.

📌 O que cada campo significa:

origin: campo para identificar a origem da solicitação. ATENÇÃO: Entrar em contato com a Bankizi e solicitar o valor correto para esta identificação
\n
observation: observações gerais (opcional - maximo 100 caracteres)
\n
fullName: nome completo da pessoa (minimo 3 caracteres - maximo 100 caracteres)
\n
document: CPF da pessoa (cpf válido - 11 caracteres, ignorando pontuações)
\n
email: E-mail da pessoa (email válido).
\n
phone: Telefone da pessoa (DDD + telefone - 11 caracteres).
\n
birthDate: Data de nascimento da pessoa (timezone BR = \"1990-01-01T03:00:00.000Z\")
\n
nationality: Nacionalidade da pessoa (BRAZILIAN ou NON_BRAZILIAN)
\n
maritalStatus: Estado Civil da pessoa (SINGLE, MARRIED, DIVORCED, WIDOWED, LEGALLY_SEPARATED ou COMMON_LAW_MARRIAGE)
\n
bankData: Dados bancários da pessoa, objeto composto por:
\n
- bankCode: Código do banco (minimo 3 caracteres - maximo 10 caracteres)
  \n
- bankName: Nome do banco (minimo 3 caracteres - maximo 50 caracteres)
  \n
- bankAgency: Agência do banco (minimo 3 caracteres - maximo 10 caracteres)
  \n
- accountNumber: Número da conta (minimo 3 caracteres - maximo 30 caracteres)
  \n
- accountType: Tipo de conta (CHECKING, SAVINGS ou PAYMENT)
  \n
\n
preferencesService: Produtos Bankizi de interesse da pessoa, objeto composto por:
\n
- paymentPix: Transações via Pix (boolean)
  \n
- transactCard: Transações via Cartão (boolean)
  \n
- paymentBill: Boletos (boolean)
  \n
- apiIntegration: Integração via API (boolean)
  \n
- tradeCryptoassets: Negociar Criptoativos (boolean)
  \n
\n
documents: Array de objetos dos documentos do pessoa. Obrigatório o envio dos 3 tipos (IDENTITY_DOCUMENT, PERSON_PROOF_OF_ADDRESS e SELFIE_WITH_IDENTITY_DOCUMENT)
\n
- documentType: identificador do tipo de documento (IDENTITY_DOCUMENT, PERSON_PROOF_OF_ADDRESS e SELFIE_WITH_IDENTITY_DOCUMENT)
  \n
- key: chave que identifica o upload do documento (chave relacionada ao upload realizado anteriormente)
  \n
- name: nome/identificação do arquivo
  \n
\n

\n","urlObject":{"path":["accounts","open","pf"],"host":["{{URL_BASE}}"],"query":[],"variable":[]}},"response":[{"id":"e2386c3b-44ba-48db-86d5-4bf6ba32f68c","name":"Open Account PF","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"origin\": \"client-name\",\r\n \"fullName\": \"John Doe\",\r\n \"document\": \"123.456.789-10\",\r\n \"email\": \"email@email.com.br\",\r\n \"phone\": \"(12) 34567-8910\",\r\n \"birthDate\": \"1990-01-01T03:00:00.000Z\",\r\n \"nationality\": \"BRAZILIAN\",\r\n \"maritalStatus\": \"SINGLE\",\r\n \"bankData\": {\r\n \"bankCode\": \"001\",\r\n \"bankName\": \"BANCO DO BRASIL S.A.\",\r\n \"bankAgency\": \"1234-5\",\r\n \"accountNumber\": \"12345-6\",\r\n \"accountType\": \"CHECKING\"\r\n },\r\n \"preferencesServices\": {\r\n \"paymentPix\": true,\r\n \"paymentBill\": true,\r\n \"transactCard\": true,\r\n \"apiIntegration\": true,\r\n \"tradeCryptoassets\": false\r\n },\r\n \"documents\": [\r\n {\r\n \"documentType\": \"PERSON_PROOF_OF_ADDRESS\",\r\n \"key\": \"person/12345678910/20251117104253_COMPROVANTE_RESIDENCIA_PF_person-proof-of-adress-file.pdf\",\r\n \"name\": \"person-proof-of-adress-file.pdf\"\r\n },\r\n {\r\n \"documentType\": \"IDENTITY_DOCUMENT\",\r\n \"key\": \"person/12345678910/20251117104253_DOCUMENTO_IDENTIDADE_identify-document-file.pdf\",\r\n \"name\": \"identify-document-file.pdf\"\r\n },\r\n {\r\n \"documentType\": \"SELFIE_WITH_IDENTITY_DOCUMENT\",\r\n \"key\": \"person/12345678910/20251117102053_SELFIE_COM_DOCUMENTO_IDENTIDADE_selfie-with-document.png\",\r\n \"name\": \"selfie-with-document.png\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{URL_BASE}}/accounts/open/pf"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"code\": 201,\n \"success\": true,\n \"message\": {\n \"account_id\": \"123456789\"\n }\n}"}],"_postman_id":"45f6f4cc-5035-4d0c-8f30-fa13fdf09cb4"},{"name":"Abertura de Conta PJ - Pessoa Jurídica","id":"cef33e11-2266-4725-9eea-220f09ab46a7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"origin\": \"client-name\",\r\n \"companyData\": {\r\n \"companyName\": \"Empresa Top Ltda\",\r\n \"tradeName\": \"Top\",\r\n \"documentCnpj\": \"1234567891011\",\r\n \"email\": \"email@email.com\",\r\n \"phone\": \"12345678901\",\r\n \"submittedBy\": \"John Doe\",\r\n \"website\": \"www.site.com\",\r\n \"activitiesDescription\": \"Qualquer informação aqui sobre a atividade da empresa que represente as atividades que a empresa possui\",\r\n \"documents\": [\r\n {\r\n \"documentType\": \"ENTERPRISE_PROOF_OF_ADDRESS\",\r\n \"key\": \"enterprise/1234567891011/20251117110309_COMPROVANTE_RESIDENCIA_PJ_1. comprovante-endereco-pj.pdf\",\r\n \"name\": \"1. comprovante-endereco-pj.pdf\"\r\n },\r\n {\r\n \"documentType\": \"CNPJ_CARD\",\r\n \"key\": \"enterprise/1234567891011/20251117110309_CARTAO_CNPJ_2.Cartao CNPJ.pdf\",\r\n \"name\": \"2.Cartao CNPJ.pdf\"\r\n },\r\n {\r\n \"documentType\": \"COMPANY_CONSTITUTION\",\r\n \"key\": \"enterprise/1234567891011/20251117110309_CONSTITUICAO_EMPRESA_3.Contrato Social.pdf\",\r\n \"name\": \"3.Contrato Social.pdf\"\r\n },\r\n {\r\n \"documentType\": \"REVENUE_STATEMENT\",\r\n \"key\": \"enterprise/1234567891011/20251117110309_DECLARACAO_RECEITA_4.Declaração de Faturamento.pdf\",\r\n \"name\": \"4.Declaração de Faturamento.pdf\"\r\n }\r\n ]\r\n },\r\n \"bankData\": {\r\n \"bankCode\": \"001\",\r\n \"bankName\": \"BANCO DO BRASIL S.A.\",\r\n \"bankAgency\": \"1234\",\r\n \"accountNumber\": \"56789-0\",\r\n \"accountType\": \"CHECKING\"\r\n },\r\n \"preferencesServices\": {\r\n \"paymentPix\": true,\r\n \"paymentBill\": false,\r\n \"transactCard\": true,\r\n \"apiIntegration\": true,\r\n \"tradeCryptoassets\": false\r\n },\r\n \"partnerInfo\": {\r\n \"partnersQuantity\": 1,\r\n \"fullName\": \"John Doe\",\r\n \"cpf\": \"12345678910\",\r\n \"email\": \"john@email.com\",\r\n \"phone\": \"12345678910\",\r\n \"birthDate\": \"1995-01-01T03:00:00.000Z\",\r\n \"maritalStatus\": \"MARRIED\",\r\n \"nationality\": \"BRAZILIAN\",\r\n \"documents\": [\r\n {\r\n \"documentType\": \"PERSON_PROOF_OF_ADDRESS\",\r\n \"key\": \"enterprise/1234567891011/20251117110309_COMPROVANTE_RESIDENCIA_PF_1. comprovante-endereco-pf.pdf\",\r\n \"name\": \"1. comprovante-endereco-pf.pdf\"\r\n },\r\n {\r\n \"documentType\": \"IDENTITY_DOCUMENT\",\r\n \"key\": \"enterprise/1234567891011/20251117110309_DOCUMENTO_IDENTIDADE_6.Identificacao PF.pdf\",\r\n \"name\": \"6.Identificacao PF.pdf\"\r\n },\r\n {\r\n \"documentType\": \"SELFIE_WITH_IDENTITY_DOCUMENT\",\r\n \"key\": \"enterprise/1234567891011/20251117110309_SELFIE_COM_DOCUMENTO_IDENTIDADE_prova de vida.png\",\r\n \"name\": \"prova de vida.png\"\r\n }\r\n ]\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{URL_BASE}}/accounts/open/pj","description":"

Solicitação de Abertura de Conta - Pessoa Jurídica

Este endpoint é responsável por enviar os dados para solicitação de abertura de conta do tipo Pessoa Jurídica no sistema Bankizi.

📌 O que cada campo significa:

origin: campo para identificar a origem da solicitação. ATENÇÃO: Entrar em contato com a Bankizi e solicitar o valor correto para esta identificação
\n
observation: observações gerais (opcional - maximo 100 caracteres)
\n
companyData: objeto com as informações principais da empresa
\n
- companyName: nome completo da empresa conforme Cartão CNPJ (minimo 3 caracteres - maximo 100 caracteres)
  \n
- tradeName: nome fantasia da empresa (minimo 3 caracteres - maximo 100 caracteres)
  \n
- documentCnpj: CNPJ da empresa (cnpj válido - 14 caracteres, ignorando pontuações)
  \n
- email: E-mail da empresa (email válido).
  \n
- phone: Telefone da empresa (DDD + telefone - 11 caracteres).
  \n
- submittedBy: nome do responsável pelo preenchimento dos dados
  \n
- website: opcional - site da empresa
  \n
- activitiesDescription: descrição das atividades da empresa (minimo 100 caracteres - maximo 1000 caracteres)
  \n
- documents: Array de objetos dos documentos da empresa. Obrigatório o envio dos 4 tipos (COMPANY_CONSTITUTION, CNPJ_CARD, ENTERPRISE_PROOF_OF_ADDRESS e REVENUE_STATEMENT)
  \n
  - documentType: identificador do tipo de documento entre as opções COMPANY_CONSTITUTION, CNPJ_CARD, ENTERPRISE_PROOF_OF_ADDRESS e REVENUE_STATEMENT
    \n
  - key: chave que identifica o upload do documento (chave relacionada ao upload realizado anteriormente)
    \n
  - name: nome/identificação do arquivo
    \n
  \n
\n
bankData: Dados bancários da empresa, objeto composto por:
\n
- bankCode: Código do banco (minimo 3 caracteres - maximo 10 caracteres)
  \n
- bankName: Nome do banco (minimo 3 caracteres - maximo 50 caracteres)
  \n
- bankAgency: Agência do banco (minimo 3 caracteres - maximo 10 caracteres)
  \n
- accountNumber: Número da conta (minimo 3 caracteres - maximo 30 caracteres)
  \n
- accountType: Tipo de conta (CHECKING, SAVINGS ou PAYMENT)
  \n
\n
preferencesService: Produtos Bankizi de interesse da pessoa, objeto composto por:
\n
- paymentPix: Transações via Pix (boolean)
  \n
- transactCard: Transações via Cartão (boolean)
  \n
- paymentBill: Boletos (boolean)
  \n
- apiIntegration: Integração via API (boolean)
  \n
- tradeCryptoassets: Negociar Criptoativos (boolean)
  \n
\n
partnerInfo: Dados do principal sócio/acionista da empresa
\n
- partnersQuantity: número de sócios/acionistas da empresa (number - mínimo 1)
  \n
- fullName: nome completo do sócio/acionista (minimo 3 caracteres - maximo 100 caracteres)
  \n
- cpf: CPF do sócio/acionista (cpf válido - 11 caracteres, ignorando pontuações)
  \n
- email: E-mail do sócio/acionista (email válido).
  \n
- phone: Telefone do sócio/acionista (DDD + telefone - 11 caracteres).
  \n
- birthDate: Data de nascimento do sócio/acionista (timezone BR = \"1990-01-01T03:00:00.000Z\")
  \n
- nationality: Nacionalidade do sócio/acionista (BRAZILIAN ou NON_BRAZILIAN)
  \n
- maritalStatus: Estado Civil do sócio/acionista (SINGLE, MARRIED, DIVORCED, WIDOWED, LEGALLY_SEPARATED ou COMMON_LAW_MARRIAGE)
  \n
- documents: Array de objetos dos documentos do sócio/acionista. Obrigatório o envio dos 3 tipos (IDENTITY_DOCUMENT, PERSON_PROOF_OF_ADDRESS e SELFIE_WITH_IDENTITY_DOCUMENT)
  \n
  - documentType: identificador do tipo de documento entre as opções IDENTITY_DOCUMENT, PERSON_PROOF_OF_ADDRESS e SELFIE_WITH_IDENTITY_DOCUMENT
    \n
  - key: chave que identifica o upload do documento (chave relacionada ao upload realizado anteriormente)
    \n
  - name: nome/identificação do arquivo
    \n
  \n
\n

\n","urlObject":{"path":["accounts","open","pj"],"host":["{{URL_BASE}}"],"query":[],"variable":[]}},"response":[{"id":"ea66d80e-e1b5-4363-8de7-1000ca3c77ee","name":"Abertura de Conta PJ - Pessoa Jurídica","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"origin\": \"client-name\",\r\n \"companyData\": {\r\n \"companyName\": \"Empresa Top Ltda\",\r\n \"tradeName\": \"Top\",\r\n \"documentCnpj\": \"1234567891011\",\r\n \"email\": \"email@email.com\",\r\n \"phone\": \"12345678901\",\r\n \"submittedBy\": \"John Doe\",\r\n \"website\": \"www.site.com\",\r\n \"activitiesDescription\": \"Qualquer informação aqui sobre a atividade da empresa que represente as atividades que a empresa possui\",\r\n \"documents\": [\r\n {\r\n \"documentType\": \"ENTERPRISE_PROOF_OF_ADDRESS\",\r\n \"key\": \"enterprise/1234567891011/20251117110309_COMPROVANTE_RESIDENCIA_PJ_1. comprovante-endereco-pj.pdf\",\r\n \"name\": \"1. comprovante-endereco-pj.pdf\"\r\n },\r\n {\r\n \"documentType\": \"CNPJ_CARD\",\r\n \"key\": \"enterprise/1234567891011/20251117110309_CARTAO_CNPJ_2.Cartao CNPJ.pdf\",\r\n \"name\": \"2.Cartao CNPJ.pdf\"\r\n },\r\n {\r\n \"documentType\": \"COMPANY_CONSTITUTION\",\r\n \"key\": \"enterprise/1234567891011/20251117110309_CONSTITUICAO_EMPRESA_3.Contrato Social.pdf\",\r\n \"name\": \"3.Contrato Social.pdf\"\r\n },\r\n {\r\n \"documentType\": \"REVENUE_STATEMENT\",\r\n \"key\": \"enterprise/1234567891011/20251117110309_DECLARACAO_RECEITA_4.Declaração de Faturamento.pdf\",\r\n \"name\": \"4.Declaração de Faturamento.pdf\"\r\n }\r\n ]\r\n },\r\n \"bankData\": {\r\n \"bankCode\": \"001\",\r\n \"bankName\": \"BANCO DO BRASIL S.A.\",\r\n \"bankAgency\": \"1234\",\r\n \"accountNumber\": \"56789-0\",\r\n \"accountType\": \"CHECKING\"\r\n },\r\n \"preferencesServices\": {\r\n \"paymentPix\": true,\r\n \"paymentBill\": false,\r\n \"transactCard\": true,\r\n \"apiIntegration\": true,\r\n \"tradeCryptoassets\": false\r\n },\r\n \"partnerInfo\": {\r\n \"partnersQuantity\": 1,\r\n \"fullName\": \"John Doe\",\r\n \"cpf\": \"12345678910\",\r\n \"email\": \"john@email.com\",\r\n \"phone\": \"12345678910\",\r\n \"birthDate\": \"1995-01-01T03:00:00.000Z\",\r\n \"maritalStatus\": \"MARRIED\",\r\n \"nationality\": \"BRAZILIAN\",\r\n \"documents\": [\r\n {\r\n \"documentType\": \"PERSON_PROOF_OF_ADDRESS\",\r\n \"key\": \"enterprise/1234567891011/20251117110309_COMPROVANTE_RESIDENCIA_PF_1. comprovante-endereco-pf.pdf\",\r\n \"name\": \"1. comprovante-endereco-pf.pdf\"\r\n },\r\n {\r\n \"documentType\": \"IDENTITY_DOCUMENT\",\r\n \"key\": \"enterprise/1234567891011/20251117110309_DOCUMENTO_IDENTIDADE_6.Identificacao PF.pdf\",\r\n \"name\": \"6.Identificacao PF.pdf\"\r\n },\r\n {\r\n \"documentType\": \"SELFIE_WITH_IDENTITY_DOCUMENT\",\r\n \"key\": \"enterprise/1234567891011/20251117110309_SELFIE_COM_DOCUMENTO_IDENTIDADE_prova de vida.png\",\r\n \"name\": \"prova de vida.png\"\r\n }\r\n ]\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{URL_BASE}}/accounts/open/pj"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"code\": 201,\n \"success\": true,\n \"message\": {\n \"account_id\": \"123456789\"\n }\n}"}],"_postman_id":"cef33e11-2266-4725-9eea-220f09ab46a7"}],"id":"8ee8630c-8604-41fa-8e50-73207fb93496","description":"

Nossa plataforma disponibiliza endpoints específicos para a abertura de contas digitais para Pessoa Física e Pessoa Jurídica.

IMPORTANTE: Para habilitar o uso desses endpoints, é necessário entrar em contato com o suporte da Bankizi informando os domínios que realizarão as requisições. Somente após essa liberação configuraremos o acesso.

Antes de enviar a solicitação de abertura de conta, todos os documentos obrigatórios devem ser previamente enviados.

Para isso:

Utilize o endpoint generate-upload-url para obter a URL de upload.
\n
Realize o upload dos documentos diretamente na URL fornecida.
\n
Após o envio bem-sucedido, prossiga com a requisição de abertura de conta.
\n

\n","_postman_id":"8ee8630c-8604-41fa-8e50-73207fb93496"},{"name":"Dict","item":[{"name":"Listar Chaves Pix","id":"3467029f-732c-40c8-8691-9a8c9a5f51e5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{AUTH_TOKEN}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{URL_BASE}}/dict/key","description":"

Este endpoint retorna todas as chaves PIX cadastradas e vinculadas à conta do usuário.

Response:

{\n  \"dicts\": [\n    {\n      \"keyType\": \"EMAIL\",\n      \"keyValue\": \"usuario@email.com\",\n      \"status\": \"ACTIVE\",\n      \"createdAt\": \"2024-01-01T00:00:00Z\",\n      \"updatedAt\": \"2024-01-01T00:00:00Z\"\n    }\n  ]\n}\n\n

📌 O que cada campo significa:

dicts: Array contendo todas as chaves PIX da conta
\n
keyType: Tipo da chave (EMAIL, PHONE, CPF, CNPJ ou EVP)
\n
keyValue: Valor da chave cadastrada
\n
status: Status atual da chave (ACTIVE, PROCESSING, FAILED)
\n
createdAt: Data/hora de criação da chave
\n
updatedAt: Data/hora da última atualização (pode ser null)
\n

\n","urlObject":{"path":["dict","key"],"host":["{{URL_BASE}}"],"query":[],"variable":[]}},"response":[{"id":"68b5fedd-9f35-4ea2-baf2-d03a38173e8c","name":"Listar Chaves Pix","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{AUTH_TOKEN}}","type":"text"}],"url":"{{URL_BASE}}/dict/key"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"dicts\":\n [\n {\n \"keyType\": \"EMAIL\",\n \"keyValue\": \"email@example.com\",\n \"status\": \"ACTIVE\",\n \"createdAt\": \"2025-01-01T00:00:00Z\",\n \"updatedAt\": \"2025-01-01T00:00:00Z\"\n },\n {\n \"keyType\": \"PHONE\",\n \"keyValue\": \"+555199999999\",\n \"status\": \"PROCESSING\",\n \"createdAt\": \"2025-01-01T00:00:00Z\",\n \"updatedAt\": \"2025-01-01T00:00:00Z\"\n }\n ]\n}"}],"_postman_id":"3467029f-732c-40c8-8691-9a8c9a5f51e5"},{"name":"Criar Chave Pix","id":"0f42d5a6-5541-4dea-9c07-42b1ec1d1c23","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"keyType\": \"PHONE\",\r\n \"keyValue\": \"+5551999999999\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{URL_BASE}}/dict/key","description":"

Este endpoint é responsável por criar uma nova chave PIX vinculada à conta. O fluxo varia de acordo com o tipo de chave escolhido.

Body:

{\n  \"keyType\": \"EMAIL | PHONE | CPF | CNPJ | EVP\",\n  \"keyValue\": \"valor-da-chave\"\n}\n\n

Response:

{\n  \"keyType\": \"EMAIL\",\n  \"keyValue\": \"usuario@email.com\",\n  \"status\": \"PENDING_VALIDATION\"\n}\n\n

EndFragment

📌 O que cada campo significa:

keyType: Tipo da chave a ser criada. Opções: EMAIL, PHONE, CPF, CNPJ ou EVP
\n
keyValue: Valor da chave (email, telefone, CPF, cnpj ou deixar vazio para EVP)
\n
status: Status retornado após criação
\n

Fluxo de Validação:

🔹 Chaves EMAIL e PHONE:

Chave criada com status EPROCESSING
\n
Será enviado automatimanete um codigo para o telefone ou email cadastrado
\n
Validar código via POST /key/otp/validate
\n
Após validação, status muda para ACTIVE
\n

🔹 Chaves CPF e RANDOM:

Chave criada com status ACTIVE imediatamente em caso de sucesso
\n
Não requer validação OTP
\n
Pronta para uso após criação
\n

\n","urlObject":{"path":["dict","key"],"host":["{{URL_BASE}}"],"query":[],"variable":[]}},"response":[{"id":"b82d35b5-844d-46d5-ac3f-428671453953","name":"Criar Chave Pix","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{AUTH_TOKEN}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"keyType\": \"EMAIL\",\n \"keyValue\": \"example@email.com\"\n}","options":{"raw":{"language":"json"}}},"url":"{{URL_BASE}}/dict/key"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"keyType\": \"EMAIL\",\n \"keyValue\": \"example@email.com\",\n \"status\": \"ACTIVE\"\n}"}],"_postman_id":"0f42d5a6-5541-4dea-9c07-42b1ec1d1c23"},{"name":"Remover Chave Pix","id":"67376c63-271f-4d88-a127-cd0de9ef9708","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{AUTH_TOKEN}}"}]},"isInherited":false},"method":"DELETE","header":[],"body":{"mode":"raw","raw":"{\r\n \"keyType\": \"EMAIL\",\r\n \"keyValue\": \"example@email.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{URL_BASE}}/dict/key","description":"

Este endpoint remove uma chave PIX cadastrada, desvinculando-a da conta.

Body:

{\n  \"keyType\": \"EMAIL\",\n  \"keyValue\": \"usuario@email.com\"\n}\n\n

Response: 204 No Content

📌 O que cada campo significa:

keyType: Tipo da chave a ser excluída (EMAIL, PHONE, CPF, CNPJ ou EVP)
\n
keyValue: Valor exato da chave cadastrada
\n

Detalhes do Fluxo:

Chave é removida do DICT do Banco Central
\n
Exclusão é definitiva e imediata
\n
Chave pode ser recadastrada posteriormente seguindo o fluxo normal
\n
Funciona para chaves em qualquer status (ACTIVE ou PROCESSING)
\n
Após exclusão, a chave não pode mais receber transferências PIX
\n

\n","urlObject":{"path":["dict","key"],"host":["{{URL_BASE}}"],"query":[],"variable":[]}},"response":[{"id":"491d8d4c-fcd2-4583-98d3-83e9ea4cbe4e","name":"Remover Chave Pix","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{AUTH_TOKEN}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"keyType\": \"EMAIL\",\n \"keyValue\": \"example@email.com\"\n}","options":{"raw":{"language":"json"}}},"url":"{{URL_BASE}}/dict/key"},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{}"}],"_postman_id":"67376c63-271f-4d88-a127-cd0de9ef9708"},{"name":"Validar Codigo OTP Chave Pix","id":"1f8b279b-3e4f-4256-a3e8-abbf84be70cc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{AUTH_TOKEN}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"keyValue\": \"+5551999999999\",\r\n \"code\": \"000000\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{URL_BASE}}/dict/key/otp/validate","description":"

Este endpoint valida o código OTP (One-Time Password) recebido e ativa a chave PIX, finalizando o processo de cadastro.

Body:

{\n  \"keyValue\": \"usuario@email.com\",\n  \"code\": \"123456\"\n}\n\n

Response:

{\n  \"keyType\": \"EMAIL\",\n  \"keyValue\": \"usuario@email.com\",\n  \"status\": \"ACTIVE\"\n}\n\n

📌 O que cada campo significa:

keyValue: Email ou telefone que está sendo validado
\n
code: Código de 6 dígitos recebido via email/SMS
\n
status: Status após validação (ACTIVE se sucesso)
\n

Detalhes do Fluxo:

Validação bem-sucedida: status muda de PROCESSING para ACTIVE
\n
Chave fica disponível para receber transferências PIX
\n
Código inválido: retorna erro e chave permanece PROCESSING
\n
Código expirado: necessário solicitar novo OTP via POST /key/otp
\n
Após ativação, a chave é registrada no DICT do Banco Central
\n

\n","urlObject":{"path":["dict","key","otp","validate"],"host":["{{URL_BASE}}"],"query":[],"variable":[]}},"response":[{"id":"75fb53a6-d66b-4258-abaa-1fa412ee17e1","name":"Validar Codigo OTP Chave Pix","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{AUTH_TOKEN}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"keyValue\": \"+5551999999999\",\n \"code\": \"000000\"\n}","options":{"raw":{"language":"json"}}},"url":"{{URL_BASE}}/dict/key/otp/validate"},"code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"keyType\": \"PHONE\",\n \"keyValue\": \"+5551999999999\",\n \"status\": \"ACTIVE\"\n}"}],"_postman_id":"1f8b279b-3e4f-4256-a3e8-abbf84be70cc"},{"name":"Gerar Codigo OTP Chave Pix","id":"87f02294-d428-499e-b796-dc0788347754","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{AUTH_TOKEN}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"keyValue\": \"+5551999999999\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{URL_BASE}}/dict/key/otp","description":"

Este endpoint gera e envia um código OTP (One-Time Password) para validação de chaves do tipo EMAIL ou PHONE.

Body:

{\n  \"keyValue\": \"usuario@email.com\"\n}\n\n

Response: 204 No Content

📌 O que cada campo significa:

keyValue: Email ou telefone que receberá o código OTP

Detalhes do Fluxo:

Código numérico de 6 dígitos é gerado
\n
Para EMAIL: código enviado para o endereço informado
\n
Para PHONE: código enviado via SMS para o número informado
\n
Código válido por tempo limitado 5 minutos
\n
Pode ser solicitado novamente caso expire
\n
Limite diario de 5 tentativas por chave pix
\n
Apenas para chaves com status PROCESSING
\n

\n","urlObject":{"path":["dict","key","otp"],"host":["{{URL_BASE}}"],"query":[],"variable":[]}},"response":[{"id":"530cf8fe-dfb1-4909-8ff0-ab6c90bd3460","name":"Gerar Codigo OTP Chave Pix","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{AUTH_TOKEN}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"keyValue\": \"+5551999999999\"\n}","options":{"raw":{"language":"json"}}},"url":"{{URL_BASE}}/dict/key/otp"},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{}"}],"_postman_id":"87f02294-d428-499e-b796-dc0788347754"}],"id":"911f1045-29e1-49d5-a403-f93046ada9d0","description":"

Módulo responsável pelo gerenciamento de chaves PIX (DICT - Diretório de Identificadores de Contas Transacionais). Permite criar, listar, validar e excluir chaves PIX vinculadas a uma conta.

📌 Tipos de Chave (keyType)

EMAIL: Endereço de e-mail (requer OTP)
\n
PHONE: Número de telefone (requer OTP)
\n
CPF: CPF do titular (validação automática)
\n
CNPJ: CNPJ do titular (validação automática)
\n
EVP: Chave aleatória gerada pelo sistema (validação automática)
\n

📌 Status Possíveis

PROCESSING: Aguardando validação OTP
\n
ACTIVE: Chave ativa e funcional
\n
FAILED: Falha na criação
\n

\n","_postman_id":"911f1045-29e1-49d5-a403-f93046ada9d0"},{"name":"Pix","item":[{"name":"Criar QR Code Dinâmico","id":"54b875a3-a6ff-411b-8897-1f4178ce5007","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{AUTH_TOKEN}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"amount\": 10,\n \"expiration\": 3600,\n \"payerInfo\": {\n \"document\": \"04333513065\",\n \"name\": \"Payer Name\"\n },\n \"txId\": \"BDOUG086DGSH4534RWRGE66D212\"\n}","options":{"raw":{"language":"json"}}},"url":"{{URL_BASE}}/pix/qrcode/dynamic","description":"

🔄 O que é o QR Code Dinâmico?

O QR Code Dinâmico no contexto do PIX é um código gerado com informações específicas e únicas para cada transação. Diferente do QR Estático (que pode ser reutilizado), o QR Dinâmico:

Possui um txId (transaction ID) exclusivo.
\n
Pode conter dados completos do pagador, como nome e CPF/CNPJ.
\n
É ideal para cobranças individualizadas, automatizadas e rastreáveis.
\n
Tem um tempo de expiração, após o qual ele se torna inválido.
\n

📌 O que cada campo significa:

amount: valor da cobrança em centavos.
Exemplo: 1000 = R$ 10,00
\n
expiration: tempo de validade do QR Code em segundos (neste caso, 3600 segundos = 1 hora).
\n
payerInfo.document: CPF ou CNPJ do pagador.
\n
payerInfo.name: nome do pagador.
\n
txId: identificador único da transação, que será vinculado à cobrança e ajuda no rastreamento do pagamento.
\n

🔁 Resposta da API

📌 O que está incluso:

qrCode: é a string que representa o conteúdo do código PIX — essa string pode ser transformada em uma imagem (QR Code) para o usuário escanear.
\n
amount: valor confirmado da cobrança.
\n
transactionId: identificador interno da transação (Usado pelo sistema da bankizi).
\n
txId: o mesmo código que você enviou — útil para fazer conciliações e verificar o status posteriormente.
\n

📌 Cenários de teste em ambiente de Homologação:

Depósitos de R$ 7,00 retornará status GENERATED (não segue para processamento)
\n
Depósitos de qualquer outro valor retornará status PAID (segue com processamento normal)
\n

\n","urlObject":{"path":["pix","qrcode","dynamic"],"host":["{{URL_BASE}}"],"query":[],"variable":[]}},"response":[{"id":"0e6b3616-7ea7-461f-9bdc-6d4b65731285","name":"Criar QR Code Dinâmico","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{AUTH_TOKEN}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"amount\": 10,\n \"expiration\": 3600,\n \"payerInfo\": {\n \"document\": \"00000000000\",\n \"name\": \"payer name\"\n },\n \"txId\": \"ADOUG086DGSH4534RWRGE66D212\"\n}","options":{"raw":{"language":"json"}}},"url":"{{URL_BASE}}/pix/qrcode/dynamic"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n\"qrCode\": \"00020126580014br.gov.bcb.pix013654f68fe2-bab3-4abb-abcf-2b6943ed3db65204000053039865406150.005802BR5922Bruna Cardoso da Silva6009Sao Paulo6226052228Uum08VxYqz50ronJ1x6v63047B5C\",\n \" amount\": 10,\n \"transactionId\": \"f81d4fae-7dec-11d0-a765-00a0c91e6bf6\",\n \" txId\": \"ADOUG086DGSH4534RWRGE66D212\"\n}"}],"_postman_id":"54b875a3-a6ff-411b-8897-1f4178ce5007"},{"name":"Criar QR Code Estático","id":"1e2b1120-9c55-42c0-8145-5526d4f2634f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{AUTH_TOKEN}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"isOpenAmount\": false,\r\n \"amount\": 100,\r\n \"externalId\": \"ADOUG086DGSH4534RWRGE66DA14\",\r\n \"pixKey\": \"email@example.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{URL_BASE}}/pix/qrcode/static","description":"

🔐 Criar QR Code Estático PIX

🔄 O que é a Criação de QR Code Estático?

Cria um QR Code estático PIX que pode ser utilizado para receber pagamentos. O QR Code pode ser de valor fixo ou aberto (permitindo que o pagador defina o valor).

📌 Corpo da Requisição

{\n  \"externalId\": \"qrcode-ext-001\",\n  \"isOpenAmount\": false,\n  \"amount\": 50000,\n  \"pixKey\": \"email@exemplo.com\"\n}\n\n

📌 O que cada campo significa:

externalId: identificador único externo do QR Code (obrigatório)
\n
isOpenAmount: define se o QR Code aceita valores variáveis (true) ou valor fixo (false)
\n
amount: valor do QR Code em centavos. Mínimo: 100 centavos. Exemplo: 100 = R$ 1,00. Obrigatório quando isOpenAmount é false
\n
pixKey: chave PIX associada ao QR Code (opcional)
\n

🔁 Resposta da API

{\n  \"id\": \"SS0007A1SBHJ4LZTKIRWYGXADaF5Ys\",\n  \"qrCodeValue\": \"00020126580014br.gov.bcb.pix0136xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx520400005303986540510.005802BR5913NOME EMPRESA6009SAO PAULO62410503***63041D3D\",\n  \"externalId\": \"qrcode-ext-001\"\n}\n\n

📌 O que está incluso:

id: identificador interno do QR Code gerado
\n
qrCodeValue: valor do QR Code em formato EMV (pronto para ser renderizado)
\n
externalId: identificador externo fornecido na requisição
\n

📌 Validações:

Se isOpenAmount for false, amount é obrigatório
\n
amount mínimo: 100 centavos (R$ 1,00)
\n

📌 Exemplos de Uso:

Exemplo 1: QR Code com Valor Fixo

{\n  \"externalId\": \"qrcode-loja-001\",\n  \"isOpenAmount\": false,\n  \"amount\": 100000,\n  \"pixKey\": \"loja@exemplo.com\"\n}\n\n

Exemplo 2: QR Code com Valor Aberto

{\n  \"externalId\": \"qrcode-doacao-001\",\n  \"isOpenAmount\": true,\n  \"pixKey\": \"ong@exemplo.com\"\n}\n\n

","urlObject":{"path":["pix","qrcode","static"],"host":["{{URL_BASE}}"],"query":[],"variable":[]}},"response":[{"id":"531bd3eb-0e15-403c-881a-7beab4314db9","name":"Valor aberto","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"isOpenAmount\": true,\n \"externalId\": \"ADOUG086DGSH4534RWRGE66DA14\"\n}","options":{"raw":{"language":"json"}}},"url":"{{URL_BASE}}/pix/qrcode/static"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"qrCodeValue\": \"00020126580014br.gov.bcb.pix013654f68fe2-bab3-4abb-abcf-2b6943ed3db65204000053039865406150.005802BR5922Bruna Cardoso da Silva6009Sao Paulo6226052228Uum08VxYqz50ronJ1x6v63047B5C\",\n \"externalId\": \"TX3Y9NCKAI0AFSPY0MA5RD4CA04DX1\",\n \"id\": \"SS0007A1SBHJ4LZTKIRWYGXADaF5Ys\"\n}"},{"id":"93f00943-8ef7-432b-ac39-fbba911a1d63","name":"Valor definido","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"isOpenAmount\": false,\n \"amount\": 100,\n \"externalId\": \"ADOUG086DGSH4534RWRGE66DA14\",\n \"pixKey\": \"email@example.com\"\n}","options":{"raw":{"language":"json"}}},"url":"{{URL_BASE}}/pix/qrcode/static"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"qrCodeValue\": \"00020126580014br.gov.bcb.pix013654f68fe2-bab3-4abb-abcf-2b6943ed3db65204000053039865406150.005802BR5922Bruna Cardoso da Silva6009Sao Paulo6226052228Uum08VxYqz50ronJ1x6v63047B5C\",\n \"externalId\": \"TX3Y9NCKAI0AFSPY0MA5RD4CA04DX1\",\n \"id\": \"SS0007A1SBHJ4LZTKIRWYGXADaF5Ys\"\n}"}],"_postman_id":"1e2b1120-9c55-42c0-8145-5526d4f2634f"},{"name":"Iniciar Saque Para Chave Pix","id":"862f7847-f0e6-47f1-bce1-7c655eb49587","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{AUTH_TOKEN}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"amount\": 100,\n \"txId\": \"BDOUG086DGSH4534RWRGE66D212\",\n \"pixKey\": \"email@example.com\"\n}","options":{"raw":{"language":"json"}}},"url":"{{URL_BASE}}/pix/withdraw/initiate/key","description":"

🔐 Iniciar Saque com Chave PIX (Fluxo em 2 Etapas)

🔄 O que é a Iniciação de Saque?

Inicia um processo de saque em duas etapas. Primeiro, valida a chave PIX e retorna os dados do destinatário para confirmação do usuário. Depois, o saque deve ser confirmado através do endpoint de confirmação.

📌 Corpo da Requisição

{\n  \"amount\": 15000,\n  \"txId\": \"init123abc456def789ghi012jkl345m\",\n  \"pixKey\": \"email@exemplo.com\"\n}\n\n

📌 O que cada campo significa:

amount: valor do saque em centavos. Mínimo: 100 centavos. Exemplo: 100 = R$ 1,00
\n
txId: identificador único da transação
\n
pixKey: chave PIX do destinatário para validação
\n

🔁 Resposta da API

{\n  \"transactionId\": \"65f8a9b2c3d4e5f6a7b8c9d4\",\n  \"endToEndId\": \"E12345678202401011200ABC123456789\",\n  \"amount\": 100,\n  \"creditParty\": {\n    \"name\": \"Maria Santos\",\n    \"document\": \"98765432100\",\n    \"pixKey\": \"email@exemplo.com\",\n    \"bankCode\": \"341\",\n    \"bankName\": \"Itaú Unibanco\",\n    \"ispb\": \"60701190\"\n  }\n}\n\n

📌 O que está incluso:

transactionId: identificador interno da transação
\n
endToEndId: identificador end-to-end do PIX (rastreamento completo)
\n
amount: valor confirmado do saque
\n
creditParty: dados completos do destinatário para confirmação
\n
- name: nome do titular da chave PIX
  \n
- document: CPF/CNPJ do titular
  \n
- pixKey: chave PIX validada
  \n
- bankCode: código do banco do destinatário
  \n
- bankName: nome do banco do destinatário
  \n
- ispb: código ISPB da instituição financeira
  \n
\n

\n","urlObject":{"path":["pix","withdraw","initiate","key"],"host":["{{URL_BASE}}"],"query":[],"variable":[]}},"response":[{"id":"8aa2f23b-bdba-4a2b-a951-50e408166197","name":"Iniciar Saque Para Chave Pix","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{AUTH_TOKEN}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"amount\": 100,\n \"txId\": \"BDOUG086DGSH4534RWRGE66D212\",\n \"pixKey\": \"email@example.com\"\n}","options":{"raw":{"language":"json"}}},"url":"{{URL_BASE}}/pix/withdraw/initiate/key"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"amount\": 100,\n \"transactionId\": \"S2DUV6F07KEJF42Y2V0PDZ7F2CO3E8\",\n \"endToEndId\": \"E31680151202511211829CGCT9U20R49\",\n \"creditParty\": {\n \"name\": \"Name Example\",\n \"document\": \"***.000.000-**\",\n \"pixKey\": \"email@example.com\",\n \"ispb\": \"18236120\",\n \"bankName\": \"NU PAGAMENTOS - IP\",\n \"bankCode\": \"260\"\n }\n}"}],"_postman_id":"862f7847-f0e6-47f1-bce1-7c655eb49587"},{"name":"Confirmar Saque Para Chave Pix","id":"6aaeb23a-747b-44b8-8db4-fa29b5dd8d82","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{AUTH_TOKEN}}"}]},"isInherited":false},"method":"PUT","header":[],"url":"{{URL_BASE}}/pix/withdraw/confirm/key/:txid","description":"

✅ Confirmar Saque com Chave PIX

🔄 O que é a Confirmação de Saque?

Segunda etapa do fluxo de saque com chave PIX. Após o usuário validar os dados do destinatário retornados na iniciação, este endpoint confirma e processa efetivamente o saque.

📋 Parâmetros da URL

txid: identificador único da transação (mesmo txId usado na iniciação)

📌 Exemplo de Requisição

PUT /pix/withdraw/confirm/key/init123abc456def789ghi012jkl345m\n\n

🔁 Resposta da API

Status: 200 OK\n(sem corpo de resposta)\n\n

📌 O que acontece:

A transação iniciada anteriormente é proessada para efetivação
\n
O saque é enviado para processamento assíncrono
\n
O status final será enviado via webhook
\n

\n","urlObject":{"path":["pix","withdraw","confirm","key",":txid"],"host":["{{URL_BASE}}"],"query":[],"variable":[{"type":"any","value":"","key":"txid"}]}},"response":[{"id":"8c958283-6622-4130-8dfd-d7c52fce3f79","name":"Confirmar Saque Para Chave Pix","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{AUTH_TOKEN}}","type":"text"}],"url":{"raw":"{{URL_BASE}}/pix/withdraw/confirm/key/:txid","host":["{{URL_BASE}}"],"path":["pix","withdraw","confirm","key",":txid"],"variable":[{"key":"txid","value":""}]}},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{}"}],"_postman_id":"6aaeb23a-747b-44b8-8db4-fa29b5dd8d82"},{"name":"Iniciar Saque Para QR Code","id":"0e5c36e9-7eb0-4700-a9ef-ca28e75b1b80","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{AUTH_TOKEN}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"txId\": \"BDOUG086DGSH4534RWRGE66D212\",\n \"qrcode\": \"00020126580014br.gov.bcb.pix013654f68fe2-bab3-4abb-abcf-2b6943ed3db65204000053039865406150.005802BR5922Bruna Cardoso da Silva6009Sao Paulo6226052228Uum08VxYqz50ronJ1x6v63047B5C\"\n}","options":{"raw":{"language":"json"}}},"url":"{{URL_BASE}}/pix/withdraw/initiate/qrcode","description":"

📱 Iniciar Saque com QR Code (Fluxo em 2 Etapas)

🔄 O que é a Iniciação com QR Code?

Inicia um processo de saque através da leitura de um QR Code PIX. Decodifica o QR Code, valida as informações e retorna os dados do destinatário e valor (se houver) para confirmação do usuário.

📌 Corpo da Requisição

{\n  \"txId\": \"qr123abc456def789ghi012jkl345mno\",\n  \"qrCode\": \"00020126580014br.gov.bcb.pix...\"\n}\n\n

📌 O que cada campo significa:

txId: identificador único da transação
\n
qrCode: string completa do QR Code PIX (formato EMV)
\n

🔁 Resposta da API

{\n  \"transactionId\": \"65f8a9b2c3d4e5f6a7b8c9d5\",\n  \"endToEndId\": \"E12345678202401011200DEF987654321\",\n  \"txId\": \"qr123abc456def789ghi012jkl345mno\",\n  \"amount\": 20000,\n  \"amountChange\": false,\n  \"qrCodeType\": \"DYNAMIC\",\n  \"creditParty\": {\n    \"name\": \"Loja Exemplo LTDA\",\n    \"document\": \"12345678000190\",\n    \"bankCode\": \"237\",\n    \"bankName\": \"Bradesco\",\n    \"ispb\": \"60746948\"\n  }\n}\n\n

📌 O que está incluso:

transactionId: identificador interno da transação
\n
endToEndId: identificador end-to-end do PIX
\n
txId: o mesmo identificador enviado na requisição
\n
amount: valor do QR Code em centavos (se for QR Code dinâmico com valor fixo)
\n
amountChange: indica se o valor pode ser alterado pelo pagador (true = QR Code estático ou dinâmico editável)
\n
qrCodeType: tipo do QR Code (STATIC = estático, DYNAMIC = dinâmico)
\n
creditParty: dados do destinatário/recebedor
\n
- name: nome do recebedor
  \n
- document: CPF/CNPJ do recebedor
  \n
- bankCode: código do banco
  \n
- bankName: nome do banco
  \n
- ispb: código ISPB da instituição
  \n
\n

\n","urlObject":{"path":["pix","withdraw","initiate","qrcode"],"host":["{{URL_BASE}}"],"query":[],"variable":[]}},"response":[{"id":"8404f8cb-100a-4d2e-9ea3-18ea80d82431","name":"Iniciar Saque Para QR Code","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{AUTH_TOKEN}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"txId\": \"BDOUG086DGSH4534RWRGE66D212\",\n \"qrcode\": \"00020126580014br.gov.bcb.pix013654f68fe2-bab3-4abb-abcf-2b6943ed3db65204000053039865406150.005802BR5922Bruna Cardoso da Silva6009Sao Paulo6226052228Uum08VxYqz50ronJ1x6v63047B5C\"\n}","options":{"raw":{"language":"json"}}},"url":"{{URL_BASE}}/pix/withdraw/initiate/qrcode"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"amount\": 100,\n \"transactionId\": \"S2DUV6F07KEJF42Y2V0PDZ7F2CO3E8\",\n \"endToEndId\": \"E31680151202511211829CGCT9U20R49\",\n \"creditParty\": {\n \"name\": \"Name Example\",\n \"document\": \"***.000.000-**\",\n \"pixKey\": \"email@example.com\",\n \"ispb\": \"18236120\",\n \"bankName\": \"NU PAGAMENTOS - IP\",\n \"bankCode\": \"260\"\n },\n \"amountChange\": true,\n \"qrCodeType\": \"static\"\n}\n"}],"_postman_id":"0e5c36e9-7eb0-4700-a9ef-ca28e75b1b80"},{"name":"Confirmar Saque Para QR Code","id":"d72d6bd3-7761-44fe-9c52-be0f9cb13962","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{AUTH_TOKEN}}"}]},"isInherited":false},"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"amount\": 100\r\n}","options":{"raw":{"language":"json"}}},"url":"{{URL_BASE}}/pix/withdraw/confirm/qrcode/:txid","description":"

✅ Confirmar Saque com QR Code

🔄 O que é a Confirmação com QR Code?

Segunda etapa do fluxo de saque com QR Code. Confirma e processa o pagamento do QR Code. Permite alterar o valor se o QR Code permitir (amountChange = true).

📋 Parâmetros da URL

txid: identificador único da transação (mesmo txId usado na iniciação)

📌 Corpo da Requisição

{\n  \"amount\": 25000\n}\n\n

📌 O que cada campo significa:

amount (opcional): valor do pagamento em centavos. Só pode ser enviado se amountChange = true na resposta da iniciação. Mínimo: 100 centavos

📌 Exemplo de Requisição

PUT /pix/withdraw/confirm/qrcode/qr123abc456def789ghi012jkl345mno\nBody:\n{\n  \"amount\": 25000\n}\n\n

🔁 Resposta da API

Status: 200 OK\n(sem corpo de resposta)\n\n

📌 O que acontece:

A transação iniciada anteriormente é proessada para efetivação
\n
Se um valor foi informado (e permitido), ele substitui o valor original
\n
O pagamento é enviado para processamento assíncrono
\n
O status final será enviado via webhook
\n

\n","urlObject":{"path":["pix","withdraw","confirm","qrcode",":txid"],"host":["{{URL_BASE}}"],"query":[],"variable":[{"type":"any","value":"","key":"txid"}]}},"response":[{"id":"01bfedc6-f78d-4e6f-ab97-e87ff65e818d","name":"Confirmar Saque Para QR Code","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{AUTH_TOKEN}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"amount\": 100\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{URL_BASE}}/pix/withdraw/confirm/qrcode/:txid","host":["{{URL_BASE}}"],"path":["pix","withdraw","confirm","qrcode",":txid"],"variable":[{"key":"txid","value":""}]}},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{}"}],"_postman_id":"d72d6bd3-7761-44fe-9c52-be0f9cb13962"},{"name":"Saque Para Dados Bancarios","id":"14a05e37-7aa8-4cca-acbe-a9075136ee82","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{AUTH_TOKEN}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"amount\": 100,\r\n \"txId\": \"BDOUG086DGSH4534RWRGE66D212\",\r\n \"bankAccount\": {\r\n \"bankCode\": \"18236120\",\r\n \"agency\": \"0000\",\r\n \"account\": \"0000000000\",\r\n \"accountType\": \"checking\",\r\n \"name\": \"Name Example\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{URL_BASE}}/pix/withdraw/bank-account","description":"

🏦 Saque via Dados Bancários

🔄 O que é o Saque via Dados Bancários?

Permite realizar uma transferência PIX informando diretamente os dados bancários completos do destinatário (banco, agência, conta). Ideal quando o destinatário não possui chave PIX cadastrada.

📌 Corpo da Requisição

{\n  \"amount\": 50000,\n  \"txId\": \"xyz789abc123def456ghi789jkl012mn\",\n  \"bankAccount\": {\n    \"bankCode\": \"001\",\n    \"agency\": \"1234\",\n    \"accountType\": \"CHECKING\",\n    \"account\": \"12345678\",\n    \"name\": \"João da Silva\",\n    \"document\": \"12345678900\"\n  }\n}\n\n

📌 O que cada campo significa:

amount: valor do saque em centavos. Exemplo: 50000 = R$ 500,00
\n
txId: identificador único da transação
\n
bankAccount.bankCode: código do banco (3 dígitos). Exemplo: \"001\" = Banco do Brasil
\n
bankAccount.agency: número da agência (sem dígito verificador)
\n
bankAccount.accountType: tipo da conta (CHECKING = Conta Corrente, SAVINGS = Poupança)
\n
bankAccount.account: número da conta com dígito verificador
\n
bankAccount.name: nome completo do titular da conta (2-100 caracteres, apenas letras e espaços)
\n
bankAccount.document: CPF ou CNPJ do titular
\n

🔁 Resposta da API

{\n  \"status\": \"GENERATED\",\n  \"txId\": \"xyz789abc123def456ghi789jkl012mn\",\n  \"transactionId\": \"65f8a9b2c3d4e5f6a7b8c9d1\",\n  \"amount\": 50000\n}\n\n

📌 O que está incluso:

status: status atual da transação
\n
txId: o mesmo identificador enviado na requisição
\n
transactionId: identificador interno da transação
\n
amount: valor confirmado do saque em centavos
\n

📌 O que acontece:

O pagamento é enviado para processamento assíncrono
\n
O status final será enviado via webhook
\n

\n","urlObject":{"path":["pix","withdraw","bank-account"],"host":["{{URL_BASE}}"],"query":[],"variable":[]}},"response":[{"id":"fdba44ba-ce98-4991-b8b7-255d054210c8","name":"Saque Para Dados Bancarios","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{AUTH_TOKEN}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"amount\": 100,\r\n \"txId\": \"BDOUG086DGSH4534RWRGE66D212\",\r\n \"bankAccount\": {\r\n \"bankCode\": \"18236120\",\r\n \"agency\": \"0000\",\r\n \"account\": \"0000000000\",\r\n \"accountType\": \"checking\",\r\n \"name\": \"Name Example\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{URL_BASE}}/pix/withdraw/bank-account"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"status\": \"GENERATED\",\r\n \"txId\": \"BDOUG086DGSH4534RWRGE66D212\",\r\n \"transactionId\": \"S2DUV6F07KEJF42Y2V0PDZ7F2CO3E8\",\r\n \"amount\": 100\r\n}"}],"_postman_id":"14a05e37-7aa8-4cca-acbe-a9075136ee82"},{"name":"Refund","id":"94a58bee-f279-4d8d-a03c-f4ccdc312a33","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{AUTH_TOKEN}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"identifierTransaction\": \"E00360305202511292219fd07ba5c695\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{URL_BASE}}/pix/qrcode/refund","description":"

🏦 Saque via Dados Bancários

🔄 O que é o Saque via Dados Bancários?

Permite realizar uma transferência PIX informando diretamente os dados bancários completos do destinatário (banco, agência, conta). Ideal quando o destinatário não possui chave PIX cadastrada.

📌 Corpo da Requisição

{\n  \"amount\": 50000,\n  \"txId\": \"xyz789abc123def456ghi789jkl012mn\",\n  \"bankAccount\": {\n    \"bankCode\": \"001\",\n    \"agency\": \"1234\",\n    \"accountType\": \"CHECKING\",\n    \"account\": \"12345678\",\n    \"name\": \"João da Silva\",\n    \"document\": \"12345678900\"\n  }\n}\n\n

📌 O que cada campo significa:

amount: valor do saque em centavos. Exemplo: 50000 = R$ 500,00
\n
txId: identificador único da transação
\n
bankAccount.bankCode: código do banco (3 dígitos). Exemplo: \"001\" = Banco do Brasil
\n
bankAccount.agency: número da agência (sem dígito verificador)
\n
bankAccount.accountType: tipo da conta (CHECKING = Conta Corrente, SAVINGS = Poupança)
\n
bankAccount.account: número da conta com dígito verificador
\n
bankAccount.name: nome completo do titular da conta (2-100 caracteres, apenas letras e espaços)
\n
bankAccount.document: CPF ou CNPJ do titular
\n

🔁 Resposta da API

{\n  \"status\": \"GENERATED\",\n  \"txId\": \"xyz789abc123def456ghi789jkl012mn\",\n  \"transactionId\": \"65f8a9b2c3d4e5f6a7b8c9d1\",\n  \"amount\": 50000\n}\n\n

📌 O que está incluso:

status: status atual da transação
\n
txId: o mesmo identificador enviado na requisição
\n
transactionId: identificador interno da transação
\n
amount: valor confirmado do saque em centavos
\n

📌 O que acontece:

O pagamento é enviado para processamento assíncrono
\n
O status final será enviado via webhook
\n

\n","urlObject":{"path":["pix","qrcode","refund"],"host":["{{URL_BASE}}"],"query":[],"variable":[]}},"response":[{"id":"5cc5df65-9a80-4608-9190-813200725525","name":"Refund","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{AUTH_TOKEN}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"identifierTransaction\": \"E00360305202511292219fd07ba5c695\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{URL_BASE}}/pix/qrcode/refund"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"endToEndId\": \"E60701190202601120023DY56COK\",\r\n \"txId\": \"TX1RXFEADM3KRFNLDQLNAEX1QD\",\r\n \"transactionId\": \"D4GD6L8FJ9T5OHL6BW0QB7LAGI\",\r\n \"amount\": 100,\r\n \"status\": \"REQUESTED_REFUND\",\r\n \"refundAmount\": 100\r\n }"}],"_postman_id":"94a58bee-f279-4d8d-a03c-f4ccdc312a33"},{"name":"Consultar Transação de Cashin","id":"fe590b1d-6068-44ed-a957-f024a73a32b0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{AUTH_TOKEN}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{URL_BASE}}/pix/cashin/transactions/{identifier}","description":"

🔑 O que é consultar transação de cashin?

É o nosso recurso para que você consiga consultar os dados de um transação realizada na API. Ex: Preciso saber o status de uma transação, consultar quem recebeu o depósito.

🔁 Resposta da API

📌 O que está incluso:

status: Status atual da transação.
\n
Exemplo: PAID
\n
transactionType: Maneira que a transação foi realizada na plataforma.
\n
Exemplo: DYNAMIC
\n
amount: Valor total da transação.
\n
Exemplo: 150000 = R$ 1.500,00
\n
lastUpdated: Ultima vez em que a transação sofreu alteração de status.
\n
Exemplo: 2025-04-17T20:05:24.257+00:00
\n
createdAt: O momento em que a transação foi requisitada na API.
\n
Exemplo: 2025-04-17T20:05:24.257+00:00
\n
endToEndId: Identificador específico gerado pelo bacen.
\n
Exemplo: E151119752025041720055d357e00000
\n
txId: Identificador de controle do cliente.
\n
Exemplo: 83RBGLBLM5EP35QYGBYQARWXK00000
\n
transactionId: Identificador gerado pela api da Bankizi.
\n
Exemplo: S4CXV3AMXHLGB99XN9JYJ1QTAFDVEB
\n
qrCodeValue: Código do qrcode para realizar o depósito.
\n
payerPaidInfo: Informações de qual conta realizou o depósito.
\n
- name: Nome registrado na conta bancária.
  \n
- document: Documento registrado na conta bancária.
  \n
\n

🔑 What is Cash-in Transaction Lookup?

This feature allows you to retrieve the details of a transaction processed through the API.

Example: You need to check the status of a transaction or see who made the deposit.

🔁 API Response

📌 Included Fields:

status: Current status of the transaction.
Example: PAID
\n
transactionType: How the transaction was performed on the platform.
Example: DYNAMIC
\n
amount: Total value of the transaction.
Example: 150000 = R$ 1,500.00
\n
lastUpdated: Last time the transaction status was updated.
Example: 2025-04-17T20:05:24.257+00:00
\n
createdAt: The time the transaction was initially requested via the API.
Example: 2025-04-17T20:05:24.257+00:00
\n
endToEndId: Unique identifier generated by Bacen.
Example: E151119752025041720055d357e00000
\n
txId: Client-side control identifier.
Example: 83RBGLBLM5EP35QYGBYQARWXK00000
\n
transactionId: Identifier generated by the Bankizi API.
Example: S4CXV3AMXHLGB99XN9JYJ1QTAFDVEB
\n
qrCodeValue: The QR code string used to make the deposit.
\n
payerPaidInfo: Information about the account that made the deposit.
\n
- name: Name registered on the bank account.
  \n
- document: Document associated with the bank account.
  \n
\n

\n","urlObject":{"path":["pix","cashin","transactions","{identifier}"],"host":["{{URL_BASE}}"],"query":[],"variable":[]}},"response":[{"id":"353d1b84-e228-4027-aa97-abd661380355","name":"Consultar Transação de Cashin","originalRequest":{"method":"GET","header":[],"url":"{{URL_BASE}}/pix/cashin/transactions/E60701190202505022140DY5DH1K8FL1"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 06 May 2025 16:21:01 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"607"},{"key":"Connection","value":"keep-alive"},{"key":"apigw-requestid","value":"KJ2FJhe8oAMEMHQ="},{"key":"X-Powered-By","value":"Express"},{"key":"access-control-allow-origin","value":"*"},{"key":"x-correlation-id","value":"c77336c6-2f63-4767-b5c3-881655702c6f"},{"key":"etag","value":"W/\"25f-Nia6ZD8ye/uGfagd3K8ri4JSlb8\""}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"success\": true,\n \"message\": \"Ok\",\n \"data\": {\n \"status\": \"PAID\",\n \"type\": \"DYNAMIC\",\n \"amount\": 120,\n \"lastUpdate\": \"2025-05-02T21:41:07.099Z\",\n \"createdAt\": \"2025-05-02T21:40:02.370Z\",\n \"endToEndId\": \"E60701190202505022140DY5DH1K8FL1\",\n \"txId\": \"\",\n \"transactionId\": \"\",\n \"qrCodeValue\": \"\",\n \"payerPaidInfo\": {\n \"name\": \"\",\n \"document\": \"\"\n }\n }\n}"}],"_postman_id":"fe590b1d-6068-44ed-a957-f024a73a32b0"},{"name":"Consultar Transação de Cashout","id":"97c0ada1-f8af-431a-b99c-02416b3abc40","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{AUTH_TOKEN}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{URL_BASE}}/pix/cashout/transactions/{identifier}","description":"

🔑 O que é consultar transação de cashout?

É o nosso recurso para que você consiga consultar os dados de um transação realizada na API. Ex: Preciso saber o status de uma transação, consultar quem recebeu o saque.

🔁 Resposta da API

📌 O que está incluso:

status: Status atual da transação.
\n
Exemplo: Done
\n
transactionType: Maneira que a transação foi realizada na plataforma.
\n
Exemplo: PIX_KEY
\n
amount: Valor total da transação.
\n
Exemplo: 150000 = R$ 1.500,00
\n
lastUpdated: Ultima vez em que a transação sofreu alteração de status.
\n
Exemplo: 2025-04-17T20:05:24.257+00:00
\n
createdAt: O momento em que a transação foi requisitada na API.
\n
Exemplo: 2025-04-17T20:05:24.257+00:00
\n
endToEndId: Identificador específico gerado pelo bacen.
\n
Exemplo: E151119752025041720055d357e00000
\n
txId: Identificador de controle do cliente.
\n
Exemplo: 83RBGLBLM5EP35QYGBYQARWXK00000
\n
transactionId: Identificador gerado pela api da Bankizi.
\n
Exemplo: S4CXV3AMXHLGB99XN9JYJ1QTAFDVEB
\n
receiverInformation: Informações de qual conta recebeu o saque.
\n
- name: Nome registrado na conta bancária.
  \n
- document: Documento registrado na conta bancária.
  \n
- bankInfo: Informações bancárias da conta que recebeu o saque.
  \n
  - bankCode: Código ISPB do banco.
    \n
  - branchCode: Agência da conta que recebeu o saque.
    \n
  - accountNumber: Numéro da conta que recebeu o saque.
    \n
  - accountType: Tipo da conta que recebeu o saque.
    \n
  \n
\n

🔑 What is \"cashout transaction lookup\"?

This endpoint allows you to retrieve information about a cashout transaction performed through the API.

Example: check the transaction status or get details of the account that received the payout.

🔁 API Response

📌 Included fields:

status: Current status of the transaction.
\n
Example: Done
\n
transactionType: Method used to perform the transaction on the platform.
\n
Example: PIX_KEY
\n
amount: Total transaction amount (in cents).
\n
Example: 150000 = R$ 1,500.00
\n
lastUpdated: Timestamp of the last status update.
\n
Example: 2025-04-17T20:05:24.257+00:00
\n
createdAt: Timestamp when the transaction was created.
\n
Example: 2025-04-17T20:05:24.257+00:00
\n
endToEndId: Unique transaction identifier generated by Bacen.
\n
Example: E151119752025041720055d357e00000
\n
txId: Customer-defined control identifier.
\n
Example: 83RBGLBLM5EP35QYGBYQARWXK00000
\n
transactionId: Identifier generated by the Bankizi API.
\n
Example: S4CXV3AMXHLGB99XN9JYJ1QTAFDVEB
\n
receiverInformation: Information about the account that received the payout:
\n
- name: Account holder's registered name.
  \n
- document: CPF or CNPJ of the account holder.
  \n
- bankInfo: Bank account details:
  \n
  - bankCode: ISPB code of the bank.
    \n
  - branchCode: Branch code.
    \n
  - accountNumber: Account number.
    \n
  - accountType: Type of account.
    \n
  \n
\n

\n","urlObject":{"path":["pix","cashout","transactions","{identifier}"],"host":["{{URL_BASE}}"],"query":[],"variable":[]}},"response":[{"id":"7e969a34-1d2f-409f-8617-3f3e4015ff58","name":"Consultar Transação de Cashout","originalRequest":{"method":"GET","header":[],"url":"{{URL_BASE}}/pix/cashout/transactions/S4CXV3AMXHLGB99XN9JYJ1QTAFDVEB"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 06 May 2025 16:23:09 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"515"},{"key":"Connection","value":"keep-alive"},{"key":"apigw-requestid","value":"KJ2ZCjHPoAMEVuw="},{"key":"X-Powered-By","value":"Express"},{"key":"access-control-allow-origin","value":"*"},{"key":"x-correlation-id","value":"f0e7554b-1370-4d6b-af27-97d928004e3f"},{"key":"etag","value":"W/\"203-7sRiRg8xJPwplvG1te4RDWzOlJU\""}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"success\": true,\n \"message\": \"Ok\",\n \"data\": {\n \"status\": \"DONE\",\n \"transactionType\": \"PIX_KEY\",\n \"amount\": 100,\n \"lastUpdated\": \"2025-04-17T20:05:24.257Z\",\n \"createdAt\": \"2025-04-17T20:05:18.366Z\",\n \"endToEndId\": \"\",\n \"txId\": \"\",\n \"transactionId\": \"S4CXV3AMXHLGB99XN9JYJ1QTAFDVEB\",\n \"receiverInformation\": {\n \"name\": \"\",\n \"document\": \"\",\n \"bankInfo\": {\n \"bankCode\": \"\",\n \"branchCode\": \"\",\n \"accountNumber\": \"\",\n \"accountType\": \"\"\n }\n }\n }\n}"}],"_postman_id":"97c0ada1-f8af-431a-b99c-02416b3abc40"}],"id":"52642be0-8001-4c09-9d7f-b18364921174","description":"

⚙️ Aplicações do PIX na sua plataforma

Sua aplicação amplia o potencial do PIX com funcionalidades versáteis e completas:

QR Code Estático com valor aberto: permite que o usuário gere um QR code sem valor definido, ideal para cobranças flexíveis. O valor será sempre em centavos.
\n
QR Code Estático com valor fechado: define previamente o valor da cobrança.
\n
QR Code Dinâmico: gera um código com informações detalhadas da transação, como nome e e número documento, identificador único e valor. Sendo utilizado em cobranças automatizadas e integração com sistemas de gestão.
\n
Saque por chave PIX: permite que o usuário solicite um saque diretamente usando uma chave PIX, de forma simples e rápida.
\n
Saque por QR Code: permite que o usuário solicite um saque diretamente usando uma um QR Code estatico ou dinamico.
\n
Saque por Dados Bancarios: permite realizar uma transferência PIX informando diretamente os dados bancários completos do destinatário (banco, agência, conta)
\n

⚙️ Status de Cash In e Cash Out na Plataforma

Dentro do nosso ecossistema as transações Pix de Cash In e Cash Out possuem status diferentes:

Cash In

GENERATED: Toda transação é iniciada com o status Generated. A aprtir desse status pode ir para: PAID
\n
PAID: Indica que o pagamento foi concluído com sucesso. A partir desse status pode ir para: REFUNDED, PARTIALLY_REFUNDED e REQUESTED_REFUND
\n
REQUESTED_REFUND: Indica que foi solicitado o reembolso do valor da transação. A partir desse status pode ir para: REFUNDED ou PARTIALLY_REFUNDED
\n
REFUNDED: O valor total da transação foi reembolsado.
\n
PARTIALLY_REFUNDED: Uma parte do valor da transação foi reembolsada.
\n

Cash Out

GENERATED: Toda transação é iniciada com o status Generated.
\n
DONE: O saque foi concluído com sucesso.
\n
FAILED: A transação falhou por algum motivo técnico.
\n
REJECT: O saque não foi finalizado por falta de saldo, dados incorretos ou outras inconsistências.
\n
REFUNDED: O valor total da transação foi reembolsado.
\n
PARTIALLY_REFUNDED: Uma parte do valor da transação foi reembolsada.
\n

⚙️ Webhook de Atualização de Transações

Sempre que o status de uma transação muda, um webhook é automaticamente enviado à sua aplicação, garantindo que o cliente esteja sempre atualizado em tempo real.

▶️ Cash Out

Evento: PIX_OUT
Payload enviado quando ocorre uma atualização em uma transação de saque:

{\n  \"event\": \"PIX_OUT\",\n  \"data\": {\n    \"txId\": string,\n    \"transactionId\": string,\n    \"endToEndId\": string,\n    \"status\": string,\n    \"amount\": number, // enviado em centavos\n    \"amountRefunded\": number, // enviado em centavos e em caso de reembolso\n    \"endToEndIdRefunded\": string, // enviado em caso de reembolso\n    \"rejectReason\": string // enviado quando a transação é rejeitada\n    \"receiverInfo\":{\n       name: string,\n       document: string\n    } // enviado quando a transação é confirmada\n    \"accountId\": string\n  }\n}\n\n

▶️ Cash In

Evento: PIX_IN
Payload enviado quando ocorre uma atualização em uma transação de entrada:

{\n  \"event\": \"PIX_IN\"\n  \"type\": \"PIN_IN\",\n  \"data\": {\n    \"txId\":string,\n    \"transactionId\": string,\n    \"endToEndId\": string,\n    \"status\": string,\n    \"amount\": number, // enviado em centavos\n    \"endToEndIdRefunded\": string, // enviado em caso de reembolso\n    \"amountRefunded\": number // enviado em centavos e em caso de reembolso\n    \"payerInfo\":{\n       name: string,\n       document: string\n    } // enviado quando a transação é confirmada\n    \"accountId\": string\n  }\n}\n\n

\n","_postman_id":"52642be0-8001-4c09-9d7f-b18364921174"},{"name":"Saldo","item":[{"name":"Consulta saldo disponível para movimentação","id":"02c147de-cf64-4b75-8619-505fdbc9a0eb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{AUTH_TOKEN}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{URL_BASE}}/balances/consolidated","description":"

🔑 O que é consultar o saldo disponível para movimentação?

É o nosso recurso para que você consiga visualizar o saldo disponível para movimentação de forma consolidada de todos os provedores que possui integração. É o recurso ideal para descobrir o saldo de forma rápida e prática.

🔁 Resposta da API

📌 O que está incluso:

consolidatedBalance: Saldo consolidado disponível na conta somado de todos os provedores, em centavos.
\n
Exemplo: 150000 = R$ 1.500,00
\n

\n","urlObject":{"path":["balances","consolidated"],"host":["{{URL_BASE}}"],"query":[],"variable":[]}},"response":[{"id":"d374b303-580f-4e75-ac17-081d046a34e7","name":"Consulta saldo dos provedores bancários","originalRequest":{"method":"POST","header":[],"url":"{{URL_BASE}}/balances"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"success\": true,\n \"message\": \"Ok\",\n \"data\": {\n \"consolidatedBalance\": 650065\n }\n}"}],"_postman_id":"02c147de-cf64-4b75-8619-505fdbc9a0eb"},{"name":"Consulta saldo dos provedores bancários","id":"4fec41bb-b8a5-479a-a21a-284f28313241","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{AUTH_TOKEN}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{URL_BASE}}/balances","description":"

🔑 O que é consultar o saldo dos provedores bancários?

É o nosso recurso para que você consiga visualizar o saldo disponível nos
provedores bancários que você tem integração. É o recurso ideal para descobrir o saldo de
forma rápida e prática.

🔁 Resposta da API

📌 O que está incluso:

balance: Saldo disponível na conta, em centavos.
\n
Exemplo: 150000 = R$ 1.500,00
\n
provider: É o banco do provedor bancário.
\n

\n","urlObject":{"path":["balances"],"host":["{{URL_BASE}}"],"query":[],"variable":[]}},"response":[{"id":"9edbe89b-5181-4312-bc3f-031d78f36402","name":"Consulta saldo dos provedores bancários","originalRequest":{"method":"POST","header":[],"url":"{{URL_BASE}}/balances"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"success\": true,\n \"message\": \"Ok\",\n \"data\": {\n \"balances\": [\n {\n \"provider\": \"xxx\",\n \"balance\": 0\n }\n ]\n }\n}"}],"_postman_id":"4fec41bb-b8a5-479a-a21a-284f28313241"}],"id":"a1891112-0b7d-4e20-a191-927b495cd0f6","_postman_id":"a1891112-0b7d-4e20-a191-927b495cd0f6","description":""},{"name":"Transferências internas","item":[{"name":"Fazer transferência interna","id":"3c9ac318-a9eb-4582-8c5b-6f77417ef601","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"amount\": 100,\n \"referenceId\": \"BDOUG086DGSH4534RWRGE66D212\",\n \"receiverAccountId\": \"999\",\n \"description\": \"teste\"\n}","options":{"raw":{"language":"json"}}},"url":"{{URL_BASE}}/v1/internal-transfers","description":"

↔️ Fazer transferência interna entre contas

Este endpoint permite realizar uma transferência interna entre contas dentro do sistema Bankizi. A transferência interna ocorre de forma sincrona, ou seja, se o endpoint responder com sucesso significa que a transferência foi feita. Não há webhook para este recurso.

Cabeçalhos obrigatórios:

Authorization: Token de autorização

Corpo da requisição (JSON):

amount (integer): Valor da transferência em centavos
\n
referenceId (string): Identificador único da transação.
\n
receiverAccountId (string): ID da conta de destino.
\n
description (string): Descrição opcional da transferência.
\n

Casos de uso típicos:

Transferir fundos entre contas de clientes na mesma instituição.
\n
Automatizar pagamentos internos.
\n

\n","urlObject":{"path":["v1","internal-transfers"],"host":["{{URL_BASE}}"],"query":[],"variable":[]}},"response":[{"id":"89ade307-668b-4fcc-bdde-7aa0197bc747","name":"Fazer transferência interna - Sucesso","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"amount\": 100,\n \"referenceId\": \"BDOUG086DGSH4534RWRGE66D212\",\n \"receiverAccountId\": \"999\",\n \"description\": \"teste\"\n}","options":{"raw":{"language":"json"}}},"url":"{{URL_BASE}}/v1/internal-transfers"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"code\": 201,\n \"success\": true,\n \"message\": \"Ok\",\n \"data\": {\n \"amount\": 100,\n \"status\": \"DONE\",\n \"transactionId\": \"TEF2I1LGOMI8DC4V7Z2YZR7NEP18HY\",\n \"referenceId\": \"BDOUG086DGSH4534RWRGE66D212\"\n }\n}"},{"id":"5f68baf0-dbe3-4645-8a01-b4b3190ac476","name":"Fazer transferência interna - Erro","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"amount\": 100,\n \"referenceId\": \"BDOUG086DGSH4534RWRGE66D212\",\n \"receiverAccountId\": \"999\",\n \"description\": \"teste\"\n}","options":{"raw":{"language":"json"}}},"url":"{{URL_BASE}}/v1/internal-transfers"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"code\": 201,\n \"success\": true,\n \"message\": \"Ok\",\n \"data\": {\n \"amount\": 100,\n \"status\": \"FAILED\",\n \"transactionId\": \"TEF1KK41V8V0CQC10Y1ETEIYZ519N9\",\n \"referenceId\": \"BDOUG086DGSH4534RWRGE66D212\",\n \"error\": \"Error request\"\n }\n}"}],"_postman_id":"3c9ac318-a9eb-4582-8c5b-6f77417ef601"}],"id":"1003f30a-f77a-4ed5-8b17-7f7ebfb9bd84","_postman_id":"1003f30a-f77a-4ed5-8b17-7f7ebfb9bd84","description":""},{"name":"Boleto","item":[{"name":"Geração de Boleto","item":[{"name":"Cria Boleto","id":"ffa5c35d-92bf-44e5-9d67-77829bc33a0c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"amount\": 10000,\n \"customerInfo\": {\n \"name\": \"Teste\",\n \"document\": \"\"\n },\n \"referenceId\": \"{{random_string_30}}\",\n// \"fine\": {\n// \"date\": \"2025-12-16T00:00:00.000Z\",\n// \"amount\": 100,\n// \"type\": \"FIXED\" // PERCENTAGE, FIXED\n// },\n// \"interest\": {\n// \"date\": \"2025-12-20T00:00:00.000Z\",\n// \"amount\": 100,\n// \"type\": \"AMOUNT_CALENDAR_DAYS\" // AMOUNT_CALENDAR_DAYS = 'AMOUNT_CALENDAR_DAYS, PERCENTAGE_POINT_PER_MONTH_CALENDAR_DAYS, AMOUNT_WORKING_DAYS, PERCENTAGE_POINT_PER_MONTH_WORKING_DAYS, EXEMPT\n// },\n// \"discount\": {\n// \"date\": \"2025-12-13T00:00:00.000Z\",\n// \"amount\": 100,\n// \"type\": \"FIXED_AMOUNT_UNTIL_INFORMED_DATE\" // FIXED_AMOUNT_UNTIL_INFORMED_DATE,PERCENT_UNTIL_INFORMED_DATE,AMOUNT_PER_ANTICIPATION_CALENDAR_DAYS, AMOUNT_PER_ANTICIPATION_WORKING_DAYS, PERCENT_PER_ANTICIPATION_CALENDAR_DAYS, PERCENT_PER_ANTICIPATION_WORKING_DAYS\n// },\n \"dueDate\": \"2025-12-15\"\n// \"overdueDate\": \"2025-11-14T00:00:00.000Z\",\n// \"description\": \"Description\"\n}","options":{"raw":{"language":"json"}}},"url":"{{URL_BASE}}/v1/boletos","urlObject":{"path":["v1","boletos"],"host":["{{URL_BASE}}"],"query":[],"variable":[]}},"response":[{"id":"caed4d72-d281-425e-a682-0b23b87e4e73","name":"Cria Boleto","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"amount\": 10000,\n \"customerInfo\": {\n \"name\": \"Teste\",\n \"document\": \"\"\n },\n \"referenceId\": \"{{random_string_30}}\",\n// \"fine\": {\n// \"date\": \"2025-12-16T00:00:00.000Z\",\n// \"amount\": 100,\n// \"type\": \"FIXED\" // PERCENTAGE, FIXED\n// },\n// \"interest\": {\n// \"date\": \"2025-12-20T00:00:00.000Z\",\n// \"amount\": 100,\n// \"type\": \"AMOUNT_CALENDAR_DAYS\" // AMOUNT_CALENDAR_DAYS = 'AMOUNT_CALENDAR_DAYS, PERCENTAGE_POINT_PER_MONTH_CALENDAR_DAYS, AMOUNT_WORKING_DAYS, PERCENTAGE_POINT_PER_MONTH_WORKING_DAYS, EXEMPT\n// },\n// \"discount\": {\n// \"date\": \"2025-12-13T00:00:00.000Z\",\n// \"amount\": 100,\n// \"type\": \"FIXED_AMOUNT_UNTIL_INFORMED_DATE\" // FIXED_AMOUNT_UNTIL_INFORMED_DATE,PERCENT_UNTIL_INFORMED_DATE,AMOUNT_PER_ANTICIPATION_CALENDAR_DAYS, AMOUNT_PER_ANTICIPATION_WORKING_DAYS, PERCENT_PER_ANTICIPATION_CALENDAR_DAYS, PERCENT_PER_ANTICIPATION_WORKING_DAYS\n// },\n \"dueDate\": \"2025-12-15\"\n// \"overdueDate\": \"2025-11-14T00:00:00.000Z\",\n// \"description\": \"Description\"\n}","options":{"raw":{"language":"json"}}},"url":"{{URL_BASE}}/v1/boletos"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"transactionId\": \"txn_abc123def456\",\n \"referenceId\": \"ref-boleto-001\",\n \"status\": \"CREATED\",\n \"amount\": 12345,\n \"barcode\": \"34191.79001 01043.510047 91020.150008 4 10010000012345\",\n \"digitableLine\": \"34191790010104351004791020150008410010000012345\"\n}"}],"_postman_id":"ffa5c35d-92bf-44e5-9d67-77829bc33a0c"},{"name":"Get Boleto","id":"526e64e5-a81f-4709-86f7-42a2bbbdaebf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{URL_BASE}}/v1/boletos/:identfier","urlObject":{"path":["v1","boletos",":identfier"],"host":["{{URL_BASE}}"],"query":[],"variable":[{"type":"any","value":"","key":"identfier"}]}},"response":[],"_postman_id":"526e64e5-a81f-4709-86f7-42a2bbbdaebf"}],"id":"163db1ea-da90-486d-b157-f9d82d12dc21","_postman_id":"163db1ea-da90-486d-b157-f9d82d12dc21","description":""},{"name":"Pagamento de Boleto","item":[{"name":"Initiate Boleto Payment","id":"e8a32e20-3474-40ce-a390-0b595ab4f619","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"barcode\": \"34191.79001 01043.510047 91020.150008 4 10010000012345\",\n \"referenceId\": \"ref-boleto-001\"\n }","options":{"raw":{"language":"json"}}},"url":"{{URL_BASE}}/v1/boletos/payment/initiate","urlObject":{"path":["v1","boletos","payment","initiate"],"host":["{{URL_BASE}}"],"query":[],"variable":[]}},"response":[{"id":"d9f26928-6bbc-4d74-96f8-eb46d2034994","name":"Initiate Boleto Payment","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"barcode\": \"34191.79001 01043.510047 91020.150008 4 10010000012345\",\n \"referenceId\": \"ref-boleto-001\"\n }","options":{"raw":{"language":"json"}}},"url":"{{URL_BASE}}/v1/boletos/payment/initiate"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"transactionId\": \"txn_abc123def456\",\n \"dueDate\": \"2026-03-10T00:00:00.000Z\",\n \"endHour\": \"22:00\",\n \"startHour\": \"06:00\",\n \"overDueDate\": \"2026-03-17T00:00:00.000Z\",\n \"fineAmount\": 12.34,\n \"interestAmount\": 5.67,\n \"discountAmount\": 0,\n \"maxPayableAmount\": 141.46,\n \"minPayableAmount\": 123.45,\n \"originalAmount\": 123.45,\n \"status\": \"PENDING\",\n \"allowChangeValue\": false,\n \"beneficiaryInfo\": {\n \"name\": \"Empresa XYZ Ltda\",\n \"document\": \"12.345.678/0001-90\",\n \"bank\": \"Bradesco\"\n }\n}"}],"_postman_id":"e8a32e20-3474-40ce-a390-0b595ab4f619"},{"name":"Confirm Boleto Payment","id":"d0d597d7-fdd6-4d0f-8ec2-88504967b7f2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"amount\": 123.45,\n \"referenceId\": \"ref-boleto-001\"\n }","options":{"raw":{"language":"json"}}},"url":"{{URL_BASE}}/v1/boletos/payment/confirm","urlObject":{"path":["v1","boletos","payment","confirm"],"host":["{{URL_BASE}}"],"query":[],"variable":[]}},"response":[{"id":"30c5adce-89c0-47a8-9954-b986933ebf22","name":"Confirm Boleto Payment","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer YOUR_TOKEN"}],"body":{"mode":"raw","raw":"{\n \"amount\": 123.45,\n \"referenceId\": \"ref-boleto-001\"\n }","options":{"raw":{"language":"json"}}},"url":"{{URL_BASE}}/v1/boletos/payment/confirm"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"transactionId\": \"txn_abc123def456\",\n \"dueDate\": \"2026-03-10T00:00:00.000Z\",\n \"endHour\": \"22:00\",\n \"startHour\": \"06:00\",\n \"overDueDate\": \"2026-03-17T00:00:00.000Z\",\n \"fineAmount\": 12.34,\n \"interestAmount\": 5.67,\n \"discountAmount\": 0.00,\n \"maxPayableAmount\": 141.46,\n \"minPayableAmount\": 123.45,\n \"originalAmount\": 123.45,\n \"status\": \"PENDING\",\n \"allowChangeValue\": false,\n \"beneficiaryInfo\": {\n \"name\": \"Empresa XYZ Ltda\",\n \"document\": \"12.345.678/0001-90\",\n \"bank\": \"Bradesco\"\n }\n}"}],"_postman_id":"d0d597d7-fdd6-4d0f-8ec2-88504967b7f2"},{"name":"Get Boleto Payment Info","id":"06c13053-9290-4a78-87bd-9774ae0105c9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{URL_BASE}}/v1/boletos/payment/txn_abc123def456","urlObject":{"path":["v1","boletos","payment","txn_abc123def456"],"host":["{{URL_BASE}}"],"query":[],"variable":[]}},"response":[{"id":"1b3dc13b-0e08-4f0e-a238-441a65e2b74c","name":"Get Boleto Payment Info","originalRequest":{"method":"GET","header":[],"url":"{{URL_BASE}}/v1/boletos/payment/txn_abc123def456"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"transactionId\": \"txn_abc123def456\",\n \"referenceId\": \"ref-boleto-001\",\n \"settlementFee\": 150,\n \"dueDate\": \"2026-03-10T00:00:00.000Z\",\n \"endHour\": \"22:00\",\n \"startHour\": \"06:00\",\n \"overDueDate\": \"2026-03-17T00:00:00.000Z\",\n \"fineAmount\": 12.34,\n \"interestAmount\": 5.67,\n \"discountAmount\": 0.00,\n \"maxPayableAmount\": 141.46,\n \"minPayableAmount\": 123.45,\n \"originalAmount\": 123.45,\n \"status\": \"CONFIRMED\",\n \"allowChangeValue\": false,\n \"beneficiaryInfo\": {\n \"name\": \"Empresa XYZ Ltda\",\n \"document\": \"12.345.678/0001-90\",\n \"bank\": \"Bradesco\"\n }\n}"}],"_postman_id":"06c13053-9290-4a78-87bd-9774ae0105c9"}],"id":"0377f32d-494b-4aa6-b0f2-8338e39f011d","_postman_id":"0377f32d-494b-4aa6-b0f2-8338e39f011d","description":""}],"id":"be321909-ee16-44f6-aaea-2d059edca6b8","_postman_id":"be321909-ee16-44f6-aaea-2d059edca6b8","description":""}]}