Na integração via API, a página de pagamento é montada com bases em dados enviados que formam um carrinho de compras. Esses dados são separados nos seguintes nós principais:

Após o envio dos dados do carrinho, o Checkout enviará uma resposta contendo um link para a página de pagamento no campo CheckoutUrl.

ℹ️

A requisição de criação da página de pagamento não cria uma transação.

A URL retornada (CheckoutUrl) é apenas uma pré-ordem indicando que a página de pagamento está pronta para ser utilizada. A transação é criada apenas quando o comprador clica em Finalizar na tela do Checkout.

⚠️

Atenção

Para que o seu número de pedido seja enviado na transação até o extrato para fins de conciliação, siga os seguintes padrões de formatação:

• Campo: string;
• Tamanho mínimo: 1;
• Tamanho máximo: 20;
• Permitido: letras (a-z, A-Z) e números (0-9);
• Não permitido: símbolos e caracteres especiais, inclusive espaços em branco;
• Não repetir em menos de 24 (vinte e quatro) horas.

❗

Serviço de frete Correios indisponível no momento.

Caso uma requisição com essa opção de frete seja enviada, você receberá um retorno com erro 400 e a mensagem: "O serviço de frete por correios está indisponível." Caso utilize o serviço em seus links de pagamento ou páginas de checkout, altere o tipo de frete para as outras opções disponíveis.

Criando página com pagamento parcelado

O Checkout Cielo permite que o lojista realize transações de crédito parceladas em até 18 vezes.

A loja pode configurar a quantidade de parcelas por venda. O Checkout realiza o cálculo das parcelas considerando valor total e limite de parcelas enviadas via API.

Características

• O lojista envia a quantidade máxima de parcelas que deseja exibir ao comprador;
• O valor do frete é somado ao valor do parcelamento.

O parcelamento via API é realizado enviando o campo Payment.MaxNumberOfInstallments . Isso forçará o Checkout a recalcular o valor do parcelamento. Exemplo do nó:

{ 
  "Payment": {
  	"MaxNumberOfInstallments": 3
  },
}

Criando página de pagamento com descontos

O Checkout Cielo permite que a loja aplique descontos específicos tanto para o carrinho quanto para meios de pagamento. Os descontos disponíveis no Checkout Cielo são:

Observação: Você pode aplicar descontos via API ou site Cielo. Caso um valor de desconto seja enviado na API, esse será o valor considerado, mesmo que o site Cielo possua outro valor registrado.

Aplicando desconto sobre o carrinho

Para enviar um desconto sobre o carrinho basta enviar o nó Discount dentro do nó Cart:

{
    "Discount": {
      "Type": "Percent",
      "Value": "05"
    }
  }

Aplicando desconto por meio de pagamento

Para enviar um desconto sobre o boleto e/ou cartão de crédito à vista, envie dentro do nó Payment o campo correspondente:

Boleto

Envie o campo Payment.BoletoDiscount:

Exemplo

{
    "Payment": {
      "BoletoDiscount": "05"
    }
  }

Cartão de crédito

Envie o campo Payment.FirstInstallmentDiscount:

Exemplo

{
  "Payment": {
    "FirstInstallmentDiscount": 10
  }
}