Boletos

Check boleto

post
/banking/cashout/boletos/check

Check a boleto barcode or line code

chevron-right
lockRequired scopes
This endpoint requires the following scopes:
Authorizations
Body

Check boleto request params

codestringRequired

Boleto barcode or digitable_line

typestring · enumOptional

Barcode type

Possible values:
Responses
post
/banking/cashout/boletos/check

Pay boleto

post
/banking/cashout/boletos

Generate a pay boleto

chevron-right
lockRequired scopes
This endpoint requires the following scopes:
Authorizations
Body

Body params to generate a boleto V1 payment

amountintegerRequired

Amount of the boleto in cents

check_idstring · uuidRequired

Unique identifier

descriptionstringOptional

Description for the boleto

external_idstringOptional

External ID for reference

virtual_account_idstring · uuidRequired

Unique identifier

Responses
post
/banking/cashout/boletos

Pay boleto v2

post
/banking/cashout/boletos/v2

Generate a pay boleto v2

chevron-right
lockRequired scopes
This endpoint requires the following scopes:
Authorizations
Body

Body params to generate a boleto V2

amountintegerRequired

Amount of the boleto in cents

codestringRequired

Barcode or digitable_line of the boleto

descriptionstringOptional

Description of the boleto

external_idstringOptional

External ID of the boleto for reference

typestring · enumOptional

Barcode type

Possible values:
virtual_account_idstring · uuidRequired

Unique identifier

Responses
post
/banking/cashout/boletos/v2

Last updated

Was this helpful?