post
https://apisandbox.cieloecommerce.cielo.com.br/1/sales/
Cria transação de boleto.
| Ambiente | Método | Endpoint |
|---|---|---|
| Sandbox | post | https://apisandbox.cieloecommerce.cielo.com.br/1/sales/ |
| Produção | post | https://api.cieloecommerce.cielo.com.br/1/sales/ |
Saiba mais sobre essa funcionalidade na documentação.
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 adicionais para boleto do Branco do Brasil:
- Os parâmetros
Customer.Address.Street,Customer.Address.Number,Customer.Address.Complement,Customer.Address.Districtdevem totalizar até 60 caracteres; - O parâmetro
DigitableLinenão é retornado para boleto do Banco do Brasil; - O nó
Customertem restrição quanto aos caracteres aceitos:- Caracteres válidos: Letras de A a Z maiúsculas;
- Caracteres especiais: hífen (-) e apóstrofo ('), mas não pode conter espaços entre as letras;
- Exemplos corretos: D'EL-REI, D'ALCORTIVO, SANT'ANA;
- Exemplos incorretos: D'EL - REI (espaço em branco entre palavras).
AtençãoA integração de boleto do Banco do Brasil deve usar o provedor BancoDoBrasil3, válido a partir de 05/03/2026.
Resposta da criação do boleto
Na resposta da transação de boleto, a API E-commerce Cielo vai enviar a URL do boleto e o código de barras que a loja deverá exibir para o comprador.
| Propriedade | Descrição | Tipo | Tamanho |
|---|---|---|---|
PaymentId | Número de identificação do pagamento; poderá ser usado no futuro para a operação de consulta. | GUID | 36 |
Instructions | Instruções do Boleto. Ex: "Aceitar somente até a data de vencimento, após essa data juros de 1% dia". | string | 255 |
ExpirationDate | Data de expiração no formato AAAA-MM-DD. | string | 10 |
Url | URL do boleto gerado. Ex: https://.../pagador/reenvia.asp/8464a692-b4bd-41e7-8003-1611a2b8ef2d | string | 256 |
Number | "NossoNumero" gerado. Ex: 1000000012-8 | string | 50 |
BarCodeNumber | Representação numérica do código de barras. Ex: 00091628800000157000494250100000001200656560 | string | 44 |
DigitableLine | Linha digitável. Ex: 00090.49420 50100.000004 12006.565605 1 62880000015700 | string | 256 |
Assignor | Nome do Cedente. Ex: Loja Teste | string | 256 |
Address | Endereço do Cedente. Ex: Av. Teste, 160 | string | 256 |
Identification | Documento de identificação do Cedente. CPF ou CNPJ do Cedente sem os caracteres especiais (., /, -) | string | 14 |
Status | Status da Transação. Veja a tabela completa de Status transacional | byte | *** |