Managing emitted Boletos

Avaliable providers

Asset	Provider	Status
BRLD	Dock	deprecated in 2.2.x
BRLB	BS2	deprecated in 2.2.x
BRLP	CIP	avaliable

You can find the boletos emitted to a wallet by providing some search filters, such as the wallet identifier, the start and end date of the period you want to query, and the boleto status, which can take one of the following values: EMITED, PAID or ALL.

Getting a single Boleto information

To retrieve the details of a boleto you must provide the boleto identifier, which can be be obtained by searching for boletos using filters, as shown on the previous page.

const boletoId = 'some_boleto_id';
const boletoDetails = await bitcapital.boletos().findOne(boletoId);

console.log(boletoDetails);

curl --location --request GET 'https://instance-url.btcore.app/boletos/54dad7e8-46f3-472e-980e-81f3120106ac' \
--header 'Content-Type: application/json'

Status os a Boleto emiited

The CIP Provider suports a fine grained control of the status of the boleto, currently stating:

Status ( verificar os staus com EDU)	Description
pending_registration	Boleto was created and is pending provider registration confirmation.
pending_payment	Boleto is fully registered and is pending payment.
processing_payment	Boleto was partially paid or its payment was scheduled for execution.
paid	Boleto was fully paid and is pending execution.
executed	Boleto was fully executed and the balance is available for payments.
canceled	Boleto was canceled by the provider or the issuer.
expired	Boleto was expired before the payment.

Validating a Boleto

It only validate any kind of Boleto emmited in ou out Bit Capital's Platform.

curl --location -g --request GET 'https://nightly.btcore.app/boletos/payment/validate/{{string}}' \
--header 'Authorization: Bearer TOKEN'

Payment proof

it only generate a Payment Proof only for Boletos emmited in Bit Capital's Platform.

curl --location -g --request GET 'https://nightly.btcore.app/boletos/payment/payment-proof?digitableLine={{string}}' \
--header 'Authorization: Bearer TOKEN'