C6 Bank
17 min
objetivo esta integração permite que você automatize a emissão e a gestão de boletos bancários e cobranças via pix diretamente pela nossa plataforma abaixo, você encontra os recursos disponíveis e as informações necessárias para configurar cada ação para mais informações, o portal developers é acessível através do link https //developers c6bank com br/apis https //developers c6bank com br/apis 1\ boleto bancário este módulo permite criar novos boletos, consultar o status de pagamentos e cancelar boletos emitidos 1 1 emitir boleto ação utilizada para gerar um novo boleto bancário para o seu cliente você precisará preencher os dados do pagador e do boleto campos a preencher campo obrigatório descrição / exemplo id de referência externa sim um código de identificação único gerado pelo seu controle interno (ex boleto 12345 ) valor do boleto sim o valor total a ser pago, utilizando ponto para os centavos (ex 123 45 ) data de vencimento sim o dia limite para pagamento no formato aaaa mm dd (ex 2023 12 31 ) nome do pagador sim o nome completo ou a razão social do cliente que vai pagar o boleto documento (cpf/cnpj) sim o número do cpf ou cnpj do pagador, contendo apenas números cep sim o cep do endereço do pagador, contendo apenas números rua sim o nome da rua/logradouro do pagador número sim o número do endereço do pagador cidade sim a cidade de residência do pagador estado (uf) sim a sigla do estado em letras maiúsculas (ex sp , sc , rj ) e mail do pagador não o endereço de e mail do cliente para contato complemento não informações adicionais do endereço (ex apto 4b ) esquema de faturamento não utilize 15 para ambiente real (produção) ou 21 para testes (sandbox) instruções não você pode adicionar até 4 linhas de texto com instruções que serão impressas no boleto (ex "não receber após o vencimento") 1 2 consultar boleto ação utilizada para verificar a situação de um boleto que você já emitiu (por exemplo, para saber se já foi pago) campos a preencher campo obrigatório descrição / exemplo id do boleto sim o código único de identificação gerado pelo sistema no momento em que o boleto foi emitido 1 3 cancelar boleto ação utilizada para invalidar um boleto gerado, impedindo que o cliente consiga realizar o pagamento campos a preencher campo obrigatório descrição / exemplo id do boleto sim o código único de identificação gerado pelo sistema no momento em que o boleto foi emitido 2\ cobrança pix este módulo permite a geração de cobranças instantâneas via qr code (pix copia e cola), além da consulta e listagem de transações 2 1 criar cobrança pix imediata ação utilizada para gerar o código pix para o seu cliente pagar na hora campos a preencher campo obrigatório descrição / exemplo expiração (segundos) sim quanto tempo o pix ficará válido para pagamento, em segundos (ex para 1 hora, use 3600 ) nome do devedor sim o nome completo ou razão social de quem vai realizar o pagamento documento (cpf/cnpj) sim o número do cpf ou cnpj do pagador, contendo apenas números valor original sim o valor exato da cobrança, utilizando ponto para os centavos (ex 37 00 ) modalidade de alteração sim digite 0 se o valor for fixo (o cliente não pode mudar) ou 1 se o cliente puder digitar o valor no aplicativo do banco chave pix sim a sua chave pix cadastrada no banco recebedor (pode ser e mail, telefone, cpf/cnpj ou chave aleatória) solicitação ao pagador não uma mensagem curta que aparecerá na tela do celular do seu cliente na hora de pagar (ex pagamento referente ao pedido 99 ) id do location não o código de identificação de localização caso utilize geração de qr code atrelada a uma filial ou caixa específico informações adicionais não permite adicionar campos extras com nome e valor para enviar dados personalizados junto com a cobrança 2 2 consultar cobrança pix ação para verificar em tempo real se um pix específico já foi pago pelo cliente campos a preencher campo obrigatório descrição / exemplo txid da cobrança sim o código identificador único (txid) que foi retornado para você na hora em que a cobrança pix foi criada 2 3 consultar lista de cobranças pix ação que permite buscar o histórico de várias cobranças geradas em um período, ajudando no fechamento de caixa ou conciliação bancária campos a preencher campo obrigatório descrição / exemplo data de início sim a data inicial da busca (ex 2023 01 01t00 00 00z ) data de fim sim a data final da busca (ex 2023 12 31t23 59 59z ) filtro de documento não se desejar, informe o cpf ou cnpj para ver apenas as cobranças geradas para este cliente específico status não filtre as cobranças por situação (ex ativa , concluida ) página atual não se houver muitas cobranças, você pode navegar pelas páginas o padrão inicial é 0 itens por página não a quantidade de resultados que deve aparecer de uma vez o padrão é mostrar até 100 por vez location presente? não marque para filtrar apenas as cobranças que têm um id de localização atrelado na prática exemplo de fluxo emissão de boleto 1\ conexão primeiro, certifique se de que existe uma conexão configurada caso não exista, crie uma nova informando os parâmetros solicitados conforme a imagem 2\ parametrização selecione recurso boleto bancário operação emitir boleto tipo de corpo campos dinâmicos exemplo de preenchimento campo valor de exemplo id de referência externa boleto 001 valor do boleto 100 50 data de vencimento 2026 06 10 nome do pagador joão da silva documento 12345678900 cep 88000000 rua rua das flores número 123 cidade florianópolis estado sc esquema de faturamento 21 imagem de referência 3\ execução após configurar o passo, execute o fluxo 4\ resposta do conector o conector retornará um objeto detalhado com as informações do boleto { "amount" 100 5, "due date" "2026 06 10", "originator id" "000006441036", "our number" "10203286", "billing scheme" "21", "billing type" "3", "id" "01kqwmvpr4xmdc3dhagpchkwn1", "bar code" "33695147300000100500000064410360010203286213", "digitable line" "33690 00009 64410 360016 02032 862134 5 14730000010050" }