For the complete documentation index, see llms.txt. This page is also available as Markdown.

Boleto

Check boleto

post
/banking/cashout/boleto/check

Check a boleto barcode or line code

Required scopes
This endpoint requires the following scopes:
Authorizations
Body

Check boleto request params

codestringRequired

Boleto barcode or digitable_line

Responses
201

Created

application/json

Response schema for a single boleto generation

post/banking/cashout/boleto/check

Pay boleto

post
/banking/cashout/boleto/pay

Generate a pay boleto

Required 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
201

Created

application/json

Response schema for a single boleto V1 generation

post/banking/cashout/boleto/pay

Pay boleto v2

post
/banking/cashout/boleto/pay/v2

Generate a pay boleto v2

Required 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

virtual_account_idstring · uuidRequired

Unique identifier

Responses
201

Created

application/json

Response schema for a single boleto V2 generation

post/banking/cashout/boleto/pay/v2

Last updated