Boleto
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
401
Unauthorized
application/json
404
Unprocessable Entity
application/json
500
Internal server error
application/json
post/banking/cashout/boleto/check
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
401
Unauthorized
application/json
404
Unprocessable Entity
application/json
500
Internal server error
application/json
post/banking/cashout/boleto/pay
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
401
Unauthorized
application/json
404
Unprocessable Entity
application/json
500
Internal server error
application/json
post/banking/cashout/boleto/pay/v2
Last updated