Registro de boleto

Permite realizar o registro de um único boleto ou uma lista de boletos, veja os exemplos no REQUEST do CURL.

Instruções para impressão nos boletos

Para as instruções são permitidos o máximo de 5 linhas com instruções ou textos livres, podendo serem adicionadas diretamente na configuração da conta na plataforma, nos campos "instrucao1", "instrucao2", "instrucao3", "instrucao4" e "instrucao5", definido de forma fixa ou enviando no endpoint, se enviado serão substistuidas as informações fixas, o máximo por são 100 carateres, observe que cada banco aceita uma quantidade diferente um do outro, a plataforma por padrão trunca o texto de cada instrução. Como sugestão envie 60 carateres, na maioria dos bancos serão aceitos.

Veja a seção limitações para entender sobre este tópico

Instruções como Multa, Juros e Protestos são instruções que devem ser configuradas dentro dos parâmetros da conta e são adicionados ao boleto de forma automática.

Fila de processamento

A plataforma sempre está atenta a possíveis problemas que possam ocorrer durante a emissão de boletos com os bancos, isso porque cada banco trata seus erros de forma separada e distinta, para resolver isso a plataforma vai sempre trabalhar no formato de fila e irá tratar possíveis erros de comunicação de forma distinta a cada banco, sempre fique atento aos tipos de erro para que em seu sistema não corra o risco de gerar duplicidades de informação.

Request

Body Params application/json

Example

[
    {
        "idConta": "d5b7f1a2-b389-4fca-96f3-6584fd0df07c",
        "pagadorNome": "JOAO SANTOS SOUZA FERREIRA",
        "pagadorCprf": "00306146680",
        "pagadorLogradouro": "Rua dos Carijos",
        "pagadorNumero": "141",
        "pagadorComplemento": "Sala 1001",
        "pagadorCidade": "Belo Horizonte",
        "pagadorBairro": "Centro",
        "pagadorUf": "MG",
        "pagadorCep": "30120060",
        "valor": 54.00,
        "dataVencimento": "2025-09-11",
        "documento": "1",
        "codigoExterno": "1",
        "instrucao1": "",
        "instrucao2": "",
        "instrucao3": "",
        "instrucao4": "",
        "instrucao5": ""
    }
]

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢201Created

application/json

Body

Example

{
    "uuidLote": "bd31348b-3563-4abd-9ac6-87a59a5cceb8",
    "boletosValidos": [
        {
            "uuidConta": "251cb838-7b30-4217-8ebf-c670d15e96f1",
            "uuidBeneficiario": "ac13df67-58ae-4dc8-a2b6-a06619583f35",
            "uuidLote": "bd31348b-3563-4abd-9ac6-87a59a5cceb8",
            "situacaoBoleto": "201 - Recebido pela Api",
            "uuidBoleto": "0b90bc41-edc6-4a9e-88fb-3786029b7047",
            "codigoExterno": "116"
        }
    ],
    "boletosInvalidos": [
        {
            "idConta": "251cb838-7b30-4217-8ebf-c670d15e96f1",
            "pagadorNome": "BRUNO JOSE FERREIRA COSTA",
            "pagadorCprf": "04366146690",
            "pagadorLogradouro": "Rua dos Carijos",
            "pagadorNumero": "141",
            "pagadorComplemento": "apto 402",
            "pagadorCidade": "Belo Horizonte",
            "pagadorBairro": "Centro",
            "pagadorUf": "MG",
            "pagadorCep": "30120060",
            "valor": 54,
            "dataVencimento": "2025-09-11",
            "documento": "1",
            "codigoExterno": "1",
            "instrucao1": "",
            "instrucao2": "",
            "instrucao3": "",
            "instrucao4": "",
            "instrucao5": "",
            "nossoNumero": "8835648901",
            "error": [
                "Código externo existente para essa conta. O codigoExterno na chamada do endpoint deve ser único por conta. Valor retornado 1."
            ]
        }
    ]
}

🟢205Emissao concluida

🟢205Pago

🟢202Aguardando processamento

🟠400Erro

🔴500Timeout

Instruções para impressão nos boletos#

Fila de processamento#

Request

Request Code Samples

Responses

Instruções para impressão nos boletos

Fila de processamento