post
https://apisandbox.braspag.com.br/v2/sales/
Cria uma transação de boleto
| Ambiente | Método | Endpoint |
|---|---|---|
| Sandbox | post | https://apisandbox.braspag.com.br/v2/sales/ |
| Produção | post | https://api.braspag.com.br/v2/sales/ |
Saiba mais sobre essa funcionalidade na documentação.
Para o ambiente sandbox, use o valor "Simulado" no campo
Payment.Provider.
CNPJs alfanuméricos serão implementados pela Receita Federal em julho de 2026Essa mudança afeta apenas novas inscrições, não havendo mudanças em CNPJs existentes.
O CNPJ alfanumérico já está sendo suportado pela Cielo, sem mudanças na sua integração.
Recomendamos verificar a necessidade de possíveis ajustes nos sistemas próprios de checkout de sua loja.
Regras específicas por banco emissor
Segue uma lista de propriedades e suas especificações de tamanho, relativas a regras distintas de cada banco emissor e seus respectivos providers:
| Propriedade | Bradesco | Banco do Brasil | Itaú API | Santander | Citibank |
|---|---|---|---|---|---|
Provider | Bradesco2 | BancoDoBrasil3 | Itau3 | Santander2 | Citibank2 |
MerchantOrderId | 27 (*1) | 50 | 8 | 50 | 10 (*2) |
Payment.BoletoNumber | 11 (*3) | 9 (*4) | 8 (*5) | 13 (*3) | 11 (*7) |
Customer.Name | 34 | 60 (*8) | 30 | 40 | 50 (*9) |
Customer.Address.Street;Customer.Address.Number;Customer.Address.Complement;Customer.Address.District | Street: 70 Number: 10 Complement: 20 District: 50 | Totalizar até 60 caracteres (*8) | Street, Number e Complement devem totalizar até 40 caracteres District: 15 | Street, Number e Complement devem totalizar até 40 caracteres District: 15 | Street, Number e Complement devem totalizar até 40 caracteres District: 50 ( *9) |
Customer.Address.City | 50 | 18 (*8) | 15 | 30 | 50 (*9) |
Payment.Instructions | 450 | 450 | N/A | 450 | 450 |
Payment.Demonstrative | 255 | N/A | N/A | 255 | 255 |
| Observações | Detalhes |
|---|---|
*1 | Apenas letras, números e caracteres como "_" e "$". |
*2 | Caso passe dos 11 dígitos, a API gerará um número incremental a partir da configuração definida. |
*3 | O valor deve ser único, ou seja, o banco emissor não permite a repetição de valores previamente utilizados. |
*4 | Quando enviado acima de 9 posições, a API considera os últimos 9 dígitos. |
*5 | Deverá ser sempre igual ao número de pedido (MerchantOrderId). |
*6 | A API concatena automaticamente o valor “14” + 12 dígitos livres + dígito verificador, antes de mandar para o banco emissor. Caso o total ultrapasse os 14 dígitos, a API considera os últimos 14 dígitos. |
*7 | Quando enviado mais que o permitido, a API gera um número aleatório. |
*8 | São aceitos como caracteres válidos: números, letras de A a Z (MAIÚSCULAS) e caracteres especiais de conjunção (hífen "-" e apóstrofo "‘"). Quando utilizados, não pode haver espaços entre as letras. Exemplos corretos: D’EL-REI / D’ALCORTIVO / SANT’ANA. Exemplos incorretos: D’EL - REI / um espaço em branco entre palavras. |
*9 | Caracteres especiais e acentuações são removidos automaticamente. |
O boleto Caixa está indisponível por tempo indeterminado.
A integração de boleto do Banco do Brasil deve usar o provedor BancoDoBrasil3, válido a partir de 05/03/2026.
Regra adicional para boleto do Branco do Brasil:
- O parâmetro
DigitableLinenão é retornado para boleto do Banco do Brasil.