Emissão de Boleto

post

https://sandbox.openfinance.celcoin.dev/billissuance/v1/bill

Esta API permite que o cliente emita um boleto, podendo atrelar ou não à uma Carteira (Wallet) criada anteriormente. Nesta API, poderá configurar parâmetros como: Beneficiário Original, Beneficiário Final, Pagador, valor nominal, data de vencimento, desconto, juros, multa, entre outros.

Body Params

Requisição de emissão do boleto.

walletCode

int32 | null

1 to 999

Propriedade WalletCode Código da carteira.

requestId

string

required

length ≥ 1

Propriedade Identifier Identificador único da requisição.

beneficiary

object

Classe BeneficiaryRequest Modelo de requisição do beneficiário original.

beneficiaryFinal

object

Classe BeneficiaryFinalRequest Modelo de requisição do beneficiário final.

payer

object

required

Classe PayerRequest Modelo de requisição do pagador.

nominalValue

double

required

1 to 1000000000000000.1

Propriedade NominalValue Valor nominal do boleto.

dueDate

string

required

length ≥ 1

Propriedade DueDate Data de vencimento do boleto.

documentKind

string

enum

required

Valores DocumentKind Código Espécie da cobrança.

Values:

DUPLICATA_MERCANTIL - Duplicata Mercantil.
DUPLICATA_SERVICO - Duplicata de Serviço.
OUTROS - Outros.
DEPOSITO_APORTE - Boleto de Depósito e Aporte.

Allowed:

paymentType

string

enum

required

Valores PaymentType Tipo de Pagamento do boleto.

Values:

TOTAL - Aceita apenas um único pagamento no valor total do boleto, incluindo juros, multas e descontos.
DIVERGENTE - Aceita apenas um único pagamento no valor definido entre o intervalo dos campos maxValue e minValue.
PARCIAL - Aceite a quantidade de pagamentos estipulada no campo partials no valor definido entre o intervalo dos campos maxValue e minValue.

Allowed:

maxValue

double | null

1 to 1000000000000000.1

Propriedade MaxValue Valor Máximo aceito para pagamento.

minValue

double | null

1 to 1000000000000000.1

Propriedade MinValue Valor Mínimo aceito para pagamento.

partials

int32 | null

1 to 999

Propriedade Partials Quantidade de pagamento parcial.

discount

object

Classe DiscountRequest Modelo de requisição de desconto do pagamento.

deductionValue

double | null

0 to 1000000000000000.1

Propriedade DeductionValue Valor de Abatimento do valor nominal por antecipação do pagamento.

fine

object

Classe FineRequest Modelo de requisição de multa do pagamento.

interestPercentage

double | null

0 to 60

Propriedade InterestPercentage Percentual de Juros do pagamento.

settleDaysAmount

int32 | null

0 to 90

Propriedade SettleDaysAmount Quantidade de Dias de Baixa após vencimento.

201Created

400Bad Request

401Unauthorized

403Forbidden

404Not Found

412Client Error

500Server Error