Create a boleto payment

Environment

Method

Endpoint

Sandbox

https://apisandbox.braspag.com.br/v2/sales/

Production

https://api.braspag.com.br/v2/sales/

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

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:

Property

Bradesco

Banco do Brasil

Itaú Shopline

Itaú API

Santander

Citibank

Provider

Bradesco2

BancoDoBrasil2

ItauShopline

Itau3

Santander2

Citibank2

MerchantOrderId

27 (*1)

50

8

8

50

10 (*2)

Payment.BoletoNumber

11 (*3)

9 (*4)

8 (*5)

8 (*5)

13 (*3)

11 (*7)

Customer.Name

34

60 (*8)

30

30

40

50 (*9)

Customer.Address.Street; Customer.Address.Number; Customer.Address.Complement; Customer.Address.District

Street: 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 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.City

50

18 (*8)

15

15

30

50 (*9)

Payment.Instructions

450

450

N/A

N/A

450

450

Payment.Demonstrative

255

N/A

N/A

N/A

255

255

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.

Additional rules for Banco do Brasil boleto:

  • The DigitableLine parameter is not returned for Banco do Brasil boleto;
Language
Click Try It! to start a request and see the response here!