Create a boleto payment

post

https://apisandbox.cieloecommerce.cielo.com.br/new-endpoint

Create a boleto transaction.

Environment	Method	Endpoint
Sandbox	post	`https://apisandbox.cieloecommerce.cielo.com.br/1/sales/`
Production	post	`https://api.cieloecommerce.cielo.com.br/1/sales/`

ℹ️
Alphanumeric CNPJs will be implemented by the Brazilian Federal Revenue Service in July 2026
This change applies only to new registrations. There will be no changes to existing CNPJs.
The alphanumeric CNPJ is already supported by Cielo, with no changes required to your integration.
We recommend checking whether adjustments are needed in your merchant’s own checkout systems.

Additional rules for Banco do Brasil boleto:

The parameters Customer.Address.Street, Customer.Address.Number, Customer.Address.Complement, Customer.Address.District must total up to 60 characters;
The DigitableLine parameter is not returned for Banco do Brasil boleto;
The Customer node has restrictions regarding accepted characters:
Valid characters: Uppercase letters from A to Z;
Special characters: Hyphen (-) and apostrophe ('), but it cannot contain spaces between the letters;
Correct examples: D'EL-REI, D'ALCORTIVO, SANT'ANA;
Incorrect examples: D'EL - REI (space between words).

⚠️
The Banco do Brasil boleto integration must use the BancoDoBrasil3 provider, valid from 03/05/2026.

Body Params

MerchantOrderId

string

required

Order identification number. Warning: Allowed characters are a-z, A-Z, 0-9. Special characters and blank spaces are not allowed Size: Bradesco: 27
Banco do Brasil: 50

Customer

object

Payment

object

Headers

MerchantId

string

required

Defaults to 8937bd5b-9796-494d-9fe5-f76b3e4da633

Store identifier in API E-commerce Cielo. Size: 36. This documentation provides a default MerchantId to allow testing in the sandbox, but you can also provide the enabled MerchantId during the deployment process.

MerchantKey

string

required

Public key for double authentication in API E-commerce Cielo. Size: 40. This documentation provides a default MerchantKey to allow testing in the sandbox, but you can also provide the enabled MerchantKey during the deployment process.

RequestId

string

Request Identifier, used when the merchant uses different servers for each GET/POST/PUT. Size: 36.

Response

Alphanumeric CNPJs will be implemented by the Brazilian Federal Revenue Service in July 2026

The Banco do Brasil boleto integration must use the BancoDoBrasil3 provider, valid from 03/05/2026.

200