Criar pagamento de boleto

Cria uma transação de boleto

AmbienteMétodoEndpoint
Sandboxhttps://apisandbox.braspag.com.br/v2/sales/
Produçãohttps://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.

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:

PropriedadeBradescoBanco do BrasilItaú ShoplineSantanderCaixa EconômicaCitibank
ProviderBradesco2BancoDoBrasil2 e BancoDoBrasil3ItauShoplineSantander2Caixa2Citibank2
MerchantOrderId27 (*1)5085011 (*2)10 (*2)
Payment.BoletoNumber11 (*3)9 (*4)8 (*5)13 (*3)12 (*6)11 (*7)
Customer.Name3460 (*8)30404050 (*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: 15
Street, Number e Complement devem totalizar até 40 caracteres
District: 50 (*9)
Customer.Address.City5018 (*8)15301550 (*9)
Payment.Instructions450450N/A450450450
Payment.Demonstrative255N/AN/A255255255
ObservaçõesDetalhes
*1Apenas letras, números e caracteres como "_" e "$".
*2Caso passe dos 11 dígitos, a API gerará um número incremental a partir da configuração definida.
*3O valor deve ser único, ou seja, o banco emissor não permite a repetição de valores previamente utilizados.
*4Quando enviado acima de 9 posições, a API considera os últimos 9 dígitos.
*5Deverá ser sempre igual ao número de pedido (MerchantOrderId).
*6A 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.
*7Quando enviado mais que o permitido, a API gera um número aleatório.
*8Sã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.
*9Caracteres especiais e acentuações são removidos automaticamente.

Regra adicional para boleto do Branco do Brasil:

  • O parâmetro DigitableLine não é retornado para boleto do Banco do Brasil.
Language
Click Try It! to start a request and see the response here!