Create a boleto transaction

⚠️
The Split de Pagamento only accepts Banco do Brasil boleto.

ℹ️
The characteristics of a boleto transaction are:

Boletos must be registered.

Send the parameters exclusive to boleto: Payment.Bank, Payment.BoletoNumber, Payment.Assignor, Payment.Demonstrative, Payment.ExpirationDate, Payment.Identification, and Payment.Instructions.

It is not possible to register the merchant's trade name; the boleto will be generated with the legal business name.

Valid characters are: numbers, uppercase letters A to Z, and special conjunction characters (hyphen “-” and apostrophe “’”). When used, there must be no spaces between the letters.

Correct examples: D’EL-REI / D’ALCORTIVO / SANT’ANA
Incorrect examples: D’EL - REI / a blank space between words.

ℹ️
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.

Request

Ambiente	Método	Endpoint
Sandbox	post	`https://apisandbox.braspag.com.br/v2/sales/`
Produção	post	`https://api.braspag.com.br/v2/sales/`

{
    "MerchantOrderId": "2017091101",
    "Customer": {
        "Name": "Nome do Comprador",
        "Identity": "12345678909",
        "IdentityType": "CPF",
        "Address": {
            "Street": "Alameda Xingu",
            "Number": "512",
            "Complement": "27 andar",
            "ZipCode": "12345987",
            "City": "Sao Paulo",
            "State": "SP",
            "Country": "BRA",
            "District": "Alphaville"
        }
    },
    "Payment": {
        "Provider": "Braspag",
        "Bank": "BancoDoBrasil",
        "Type": "Boleto",
        "DoSplit": "True",
        "Amount": 10000,
        "BoletoNumber": "2017091101",
        "Assignor": "Empresa Teste",
        "Demonstrative": "Desmonstrative Teste",
        "ExpirationDate": "2017-12-31",
        "Identification": "12346578909",
        "Instructions": "Aceitar somente até a data de vencimento.",
        "splitpayments": [
            {
                "subordinatemerchantid": "f2d6eb34-2c6b-4948-8fff-51facdd2a28f",
                "amount": 5000,
                "fares": {
                    "mdr": 5,
                    "fee": 30
                }
            },
            {
                "subordinatemerchantid": "9140ca78-3955-44a5-bd44-793370afef94",
                "amount": 5000,
                "fares": {
                    "mdr": 4,
                    "fee": 15
                }
            }
        ]
    }
}

Below are the field properties in this request:

Property (Header)	Type	Size	Mandatory	Description
`MerchantId`	Guid	36	Yes	Merchant identifier in Split de Pagamento
`MerchantKey`	Text	40	Yes	Public key for Dual Authentication in Split de Pagamento
`Content-Type`	Header	40	Yes	Application/json

Property (Body)	Type	Size	Required	Description
`MerchantOrderId`	Text	50	Yes	Order identification number
`Customer.Name`	Text	60	Yes	Shopper`s name
`Customer.Identity`	Text	14	Yes	Shopper's CPF, or CNPJ number Allows submission of alphanumeric CNPJs.
`Customer.IdentityType`	Text	255	Yes	Type of shopper identification document (CPF or CNPJ)
`Customer.Address.Street`	Text	60	Yes	Shopper's address
`Customer.Address.Number`	Text	60	Yes	Shopper's address number
`Customer.Address.Complement`	Text	60	Yes	Shopper's address complement
`Customer.Address.ZipCode`	Text	8	Yes	Shopper's address ZIP code
`Customer.Address.District`	Text	60	Yes	Shopper`s address neighborhood
`Customer.Address.City`	Text	18	Yes	Shopper's address city
`Customer.Address.State`	Text	2	Yes	Shopper's address state
`Customer.Address.Country`	Text	35	Yes	Shopper`s address country
`Payment.Provider`	Text	15	Yes	Name of the boleto payment provider `Braspag`
`Payment.Bank`	Text	15	Yes	Name of the bank where the boleto will be issued `BancoDoBrasil`
`Payment.Type`	Text	100	Yes	Type of payment method. In this case, `Boleto`
`Payment.Amount`	Number	15	Yes	Order amount (must be sent in cents)
`Payment.BoletoNumber`	Text	9	No	Boleto number ("Nosso Número"). If provided, it overrides the value configured in the payment method
`Payment.Assignor`	Text	200	No	Assignor name. If provided, it overrides the value configured in the payment method
`Payment.Demonstrative`	Text	N/A	No	Statement text. If provided, it overrides the value configured in the payment method
`Payment.ExpirationDate`	Date	AAAA-MM-DD	No	Days until the boleto due date. If not previously set in the payment method, this field is mandatory. If sent in the request, it overrides the value configured in the payment method.
`Payment.Identification`	Text	14	No	Assignor's CNPJ. If provided, it overrides the value configured in the payment method
`Payment.Instructions`	Text	450	No	Boleto instructions. If provided, it overrides the value configured in the payment method

Response

{
    "MerchantOrderId": "2017091101",
    "Customer": {
        "Name": "Nome do Comprador",
        "Identity": "12345678909",
        "IdentityType": "CPF",
        "Address": {
            "Street": "Alameda Xingu",
            "Number": "512",
            "Complement": "27 andar",
            "ZipCode": "12345987",
            "City": "Sao Paulo",
            "State": "SP",
            "Country": "BRA",
            "District": "Alphaville"
        }
    },
    "Payment": {
        "Instructions": "Aceitar somente até a data de vencimento.",
        "ExpirationDate": "2020-12-31",
        "Demonstrative": "Desmonstrative Teste",
        "Url": "https://transactionsandbox.pagador.com.br/post/pagador/reenvia.asp/4b97aa02-9bf2-4e06-8197-c099b861e226",
        "BoletoNumber": "0000000248",
        "BarCodeNumber": "",
        "DigitableLine": "",
        "Assignor": "Empresa Teste",
        "Address": "N/A, 1",
        "Identification": "12346578909",
        "ProviderReturnCode": "0",
        "ProviderReturnMessage": "Transação criada com sucesso",
        "Bank": 4,
        "Amount": 10000,
        "ReceivedDate": "2020-03-08 08:19:27",
        "Provider": "Braspag",
        "Status": 1,
        "IsSplitted": true,
        "ReturnMessage": "Transação criada com sucesso",
        "ReturnCode": "0",
        "PaymentId": "4b97aa02-9bf2-4e06-8197-c099b861e226",
        "Type": "Boleto",
        "Currency": "BRL",
        "Country": "BRA",
        "SplitPayments": [
            {
                "SubordinateMerchantId": "f2d6eb34-2c6b-4948-8fff-51facdd2a28f",
                "Amount": 6000,
                "Fares": {
                    "Mdr": 5.0,
                    "Fee": 30
                },
                "Splits": [
                    {
                        "MerchantId": "f2d6eb34-2c6b-4948-8fff-51facdd2a28f",
                        "Amount": 5670
                    },
                    {
                        "MerchantId": "f43fca07-48ec-46b5-8b93-ce79b75a8f63",
                        "Amount": 330
                    }
                ]
            },
            {
                "SubordinateMerchantId": "f2d6eb34-2c6b-4948-8fff-51facdd2a28f",
                "Amount": 4000,
                "Fares": {
                    "Mdr": 4.0,
                    "Fee": 15
                },
                "Splits": [
                    {
                        "MerchantId": "9140ca78-3955-44a5-bd44-793370afef94",
                        "Amount": 3825
                    },
                    {
                        "MerchantId": "f43fca07-48ec-46b5-8b93-ce79b75a8f63",
                        "Amount": 175
                    }
                ]
            }
        ],
        "Links": [
            {
                "Method": "GET",
                "Rel": "self",
                "Href": "https://apiquerysandbox.cieloecommerce.cielo.com.br/1/sales/4b97aa02-9bf2-4e06-8197-c099b861e226"
            }
        ]
    }
}

Below are the field properties in this response:

Property	Description	Type	Size	Format
`PaymentId`	Order identifier field	Guid	36	xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
`ExpirationDate`	Expiration date	Text	10	2014-12-25
`Url`	URL of the generated boleto	string	256	`https://.../pagador/reenvia.asp/8464a692-b4bd-41e7-8003-1611a2b8ef2d`
`BoletoNumber`	Generated "Our Number"	Text	50	2017091101
`BarCodeNumber`	Numeric representation of the barcode	Text	44	00091628800000157000494250100000001200656560
`DigitableLine`	Digitable line	Text	256	00090.49420 50100.000004 12006.565605 1 62880000015700
`Address`	Merchant address registered with the bank	Text	256	Av. Teste, 160
`Status`	Transaction status	Byte	2	e.g., 1