Cria cobrança do tipo carnê

Esta API permite cadastrar uma cobrança do tipo carnê.

Requisição

CampoTipoDescriçãoObrigatório
ClienteIdGUIDID do pagador já cadastradoSim
DescricaoTextoDescrição do carnêNão
ValorNuméricoValor individual de cada parcela do carnêSim
QuantidadeParcelasNuméricoQuantidade de parcelas do carnê (mínimo de duas parcelas)Sim
VencimentoDataData de vencimento do carnêSim
NaoReceberDepoisDeDataData definida para o cliente não receber a cobrança após elaNão
MultaNuméricoValor da multa a ser aplicado na cobrançaNão
MultaCorrecaoTextoTipo da multa a ser aplicadaNão
JurosMesNuméricoJuros mensais aplicados sobre o valor da cobrançaNão
JurosCorrecaoTextoTipo do juros a ser aplicadoNão
DescontoAteVencimentoNuméricoDesconto aplicado até a data do vencimentoNão
DescontoCorrecaoTextoTipo do desconto a ser aplicadoNão

Resposta

CampoTipoDescrição
CarneIdGUIDIdentificador único do carnê gerado
EstadoTextoEstado que o carnê se encontra
ImgBase64TextoBase64 do PDF completo do carnê
ParcelasCarneParcelasLista com o detalhamento de cada parcela
CobrancaIdGUIDIdentificador único da Cobrança gerada
EstadoTextoEstado da cobrança
ValorNuméricoValor da parcela
VencimentoDataData de vencimento da parcela
NossoNumeroTextoNosso Número do boleto gerado
LinhaDigitavelTextoLinha digitável do boleto gerado
CodigoBarrasTextoCódigo de Barras do boleto gerado
QRCodeTextoTextoCopia e cola do pix (se for gerado como Boleto Híbrido)
QRCodeImagemTextoImagem do QRCode do pix (se for gerado como Boleto Híbrido)
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Dados da assinatura

uuid
string
double
int32
date-time
date-time
double
string
enum
Allowed:
double
string
enum
Allowed:
double
string
enum
Allowed:
string
string
string
string
Headers
string
required
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/json