Criar pagamento com boleto

Cria transação de boleto.

AmbienteMétodoEndpoint
Sandboxhttps://apisandbox.cieloecommerce.cielo.com.br/1/sales/
Produçãohttps://api.cieloecommerce.cielo.com.br/1/sales/

ℹ️

Saiba mais sobre essa funcionalidade na documentação.


Regras adicionais para boleto do Branco do Brasil:

  • Os parâmetros Customer.Address.Street, Customer.Address.Number, Customer.Address.Complement, Customer.Address.District devem totalizar até 60 caracteres;
  • O parâmetro DigitableLine não é retornado para boleto do Banco do Brasil;
  • O nó Customer tem 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).

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.

PropriedadeDescriçãoTipoTamanho
PaymentIdNúmero de identificação do pagamento; poderá ser usado no futuro para a operação de consulta.GUID36
InstructionsInstruções do Boleto.
Ex: "Aceitar somente até a data de vencimento, após essa data juros de 1% dia".
string255
ExpirationDateData de expiração no formato AAAA-MM-DD.string10
UrlURL do boleto gerado.
Ex: https://.../pagador/reenvia.asp/8464a692-b4bd-41e7-8003-1611a2b8ef2d
string256
Number"NossoNumero" gerado.
Ex: 1000000012-8
string50
BarCodeNumberRepresentação numérica do código de barras.
Ex: 00091628800000157000494250100000001200656560
string44
DigitableLineLinha digitável.
Ex: 00090.49420 50100.000004 12006.565605 1 62880000015700
string256
AssignorNome do Cedente.
Ex: Loja Teste
string256
AddressEndereço do Cedente.
Ex: Av. Teste, 160
string256
IdentificationDocumento de identificação do Cedente.
CPF ou CNPJ do Cedente sem os caracteres especiais (., /, -)
string14
StatusStatus da Transação. Veja a tabela completa de Status transacionalbyte***
Language
Click Try It! to start a request and see the response here!