v1

latestOpenAPI 3.0.02026-07-2671191208.7 KB

Pagamentos de boletos

Consultar os dados de um boleto antes do pagamento

post/v1/marketplace/payments/check-billet

integration-keystring required

Chave de integração.

x-tokenstring required

x-token utilizado para autenticação. Pode ser encontrado em nosso portal, na guia de integração com a api pública.

digitablestring

Linha digitável do boleto.

barcodestring

Código de barras do boleto.

barcodestring required

Código de barras do boleto.

digitable_linestring required

Linha digitável do boleto.

expected_onstring date-time required

Data de vencimento do boleto.

typenumber required

Tipo do boleto.

amountnumber required

Valor a ser pago.

nominal_amountnumber required

Valor nominal do boleto.

discountnumber required

Valor de desconto aplicado ao boleto.

finenumber required

Valor de multa aplicado ao boleto.

interestnumber required

Valor de juros aplicado ao boleto.

max_amountnumber nullable required

Valor máximo permitido para pagamento do boleto.

min_amountnumber nullable required

Valor mínimo permitido para pagamento do boleto.

transaction_idstring required

Identificador da transação.