Cadastrar Boleto

post

https://api-parceiro.sicredi.com.br/sb/cobranca/boleto/v1/boletos

Cadastra um boleto (Tradicional, Híbrido ou com Split de crédito).

Limite: 20 TPS

Tipos de cobrança:

NORMAL: Boleto tradicional (apenas linha digitável e código de barras)
HIBRIDO: Boleto com QR Code Pix (atenção: se informar dataInicioJuros ou dataInicioMulta, será convertido para NORMAL)

Split de Crédito:
Permite ratear o valor do boleto entre múltiplas contas (até 30 destinatários).
Suporta repasse via TED e contas Sicredi.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

codigoBeneficiario

string

required

^\d{5}$

dataVencimento

date

required

especieDocumento

string

enum

required

tipoCobranca

string

enum

required

Allowed:

nossoNumero

string

^\d{9}$

seuNumero

string

required

length ≤ 10

idTituloEmpresa

string

length ≤ 25

ID de controle do beneficiário (similar ao seuNumero, permite mais caracteres)

valor

double

required

diasProtestoAuto

integer

3 to 99

Dias após vencimento para protesto automático (mutuamente exclusivo com diasNegativacaoAuto)

diasNegativacaoAuto

integer

3 to 99

Dias após vencimento para negativação automática (mutuamente exclusivo com diasProtestoAuto)

validadeAposVencimento

integer

Dias que o QR Code continua válido após vencimento (boleto híbrido)

pagador

object

required

beneficiarioFinal

object

tipoDesconto

string

enum

Allowed:

valorDesconto1

double

dataDesconto1

date

valorDesconto2

double

dataDesconto2

date

valorDesconto3

double

dataDesconto3

date

descontoAntecipado

double

Mutuamente exclusivo com descontos escalonados

tipoJuros

string

enum

Allowed:

tipoJurosPercentual

string

enum

Obrigatório quando tipoJuros for PERCENTUAL

Allowed:

juros

double

dataInicioJuros

date

⚠️ Se informado, boleto será convertido para NORMAL (sem QR Code)

tipoMulta

string

enum

Allowed:

multa

double

dataInicioMulta

date

⚠️ Se informado, boleto será convertido para NORMAL (sem QR Code)

informativos

array of strings

length ≤ 5

informativos

mensagens

array of strings

length ≤ 4

mensagens

splitBoleto

object

Headers

x-api-key

uuid

required

cooperativa

string

required

^\d{4}$

posto

string

required

^\d{2}$

Responses

400

Parâmetros inválidos

401

Token ausente, inválido ou expirado

404

Recurso não encontrado

415

Content-Type não suportado

422

Violação de regra de negócio

429

Limite de TPS excedido

Language

Credentials

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Boleto cadastrado com sucesso