Create a boleto payment

EnvironmentMethodEndpoint
Sandboxhttps://apisandbox.braspag.com.br/v2/sales/
Productionhttps://api.braspag.com.br/v2/sales/

For the Sandbox environment, use the value "Simulado" in the Payment.Provider field.

ℹ️

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.



Specific Rules by Issuer

The following is a list of properties and their size specifications, related to different rules for each issuer and their respective providers:

PropertyBradescoBanco do BrasilItaú APISantanderCitibank
ProviderBradesco2BancoDoBrasil3Itau3Santander2Citibank2
MerchantOrderId27 (*1)5085010 (*2)
Payment.BoletoNumber11 (*3)9 (*4)8 (*5)13 (*3)11 (*7)
Customer.Name3460 (*8)304050 (*9)
Customer.Address.Street; Customer.Address.Number; Customer.Address.Complement; Customer.Address.DistrictStreet: 70

Number: 10

Complement: 20

District: 50
Total up to 60 characters (*8)Street, Number and Complement must total up to 40 characters

District: 15
Street, Number and Complement must total up to 40 characters

District: 15
Street, Number e Complement must total up to 40 characters

District: 50 (*9)
Customer.Address.City5018 (*8)153050 (*9)
Payment.Instructions450450N/A450450
Payment.Demonstrative255N/AN/A255255
RemarksDetails
*1Only letters, numbers, and characters like "_" and "$".
*2If it exceeds 11 digits, the API will generate an incremental number from the defined configuration.
*3The value must be unique, i.e., the bank does not allow repeating previously used values.
*4When submitted with over 9 positions, the API considers the last 9 digits.
*5Must always be the same as the order number (MerchantOrderId).
*6The API automatically concatenates the value “14” + 12 free digits + check digit, before sending it to the bank. If the total exceeds 14 digits, the API considers the last 14 digits.
*7When the number sent exceeds the maximum number, the API generates a random number.
*8The following are accepted as valid characters: numbers, letters A to Z (UPPERCASE) and conjunction special characters (hyphen "-" and apostrophe "'". When used, there must be no space between letters. Correct examples: D'EL-REI / D'ALCORTIVO / SANT'ANA. Incorrect examples: D'EL - REI / a space between words.
*9Special characters and diacritics will be removed automatically.
⚠️

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

Additional rules for Banco do Brasil boleto:

  • The DigitableLine parameter is not returned for Banco do Brasil boleto;

Body Params
string
required

Order ID number. Rule varies according to the provider used (see table annexed).

Customer
object
Payment
object
Headers
string
required

Store identifier at Braspag.

string
required

Public key for dual authentication at Braspag.

string

Store-defined request identifier used when the merchant uses different servers for each GET/POST/PUT.

Response

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json