Histórico da Página
Este documento é material de especificação dos requisitos de inovação, trata-se de conteúdo extremamente técnico. |
|---|
Informações Gerais
Especificação | |||
Produto | RM | Módulo | Gestão Financeira |
Segmento Executor | Educacional | ||
Projeto | R_EDU_CTB005 | IRM | PCREQ-8624 |
Requisito | PCREQ-8625 | Subtarefa | PDR_EDU_CTB003-594 |
Release de Entrega Planejada | 12.1.9 | Réplica |
|
País | ( x ) Brasil ( ) Argentina ( ) Mexico ( ) Chile ( ) Paraguai ( ) Equador ( ) USA ( ) Colombia ( ) Outro _____________. | ||
Outros | |||
Objetivo
Implementar o novo modelo de integração de pagamento com cartão CHECKOUT CIELO, descrevendo as funcionalidades, os métodos a serem utilizados, listando informações a serem enviadas e recebidas.
Definição da Regra de Negócio
O CHECKOUT CIELO é uma solução de checkout projetada para aumentar a conversão, simplificar o processo de compra, reduzir fraudes e custos operacionais. Será utilizada a integração com Carrinho de Compras (via POST).
Os campos a serem preenchidos no formulário a ser postado para o Checkout Cielo se referem basicamente a 5 grupos: Dados do Pedido, Carrinho de Compras, Dados do Frete, Dados do Consumidor e Antifraude.
A integração via POST deve enviar os parâmetros, descritos na tabela 1B do manual em anexo, a URL: https://cieloecommerce.cielo.com.br/Transactional/Order/Index.
1 - Parametrização
1.1 - Configurações Gerais Cartão de Crédito/Débito
Como a solução BuyPage da Cielo não foi descontinuada, será criado um parâmetro para informar qual a modelo de integração com a Cielo será utilizada, com as seguintes opções: 0 - BuyPage e 1 - Checkout (Id. 1104 da FPARAM usando o campo INTEIRO)
Será criado um parâmetro para informar a URL de Post (Id. 1105 da FPARAM usando o campo TEXTO). Este parâmetro será visível para ambos os modelos.
Os parâmetros Código de afiliação do Lojista, URL Ambiente Teste, URL Ambiente Produção e Ambiente Ativo ficará habilitado somente para o modelo BuyPage. E o parâmetro Chave de acesso do Lojista será habilitado para ambos os modelos.
1.2 - Configurações Cartão Bandeira Visa
Os parâmetros Ativar Bandeira Visa e Ativar Função Débito serão descontinuados, ou seja, para o modelo BuyPage na página onde o usuário seleciona a bandeira e função crédito ou débito sempre será apresentada.
O parâmetro Numero máximo de Parcelas será habilitado somente no modelo BuyPage.
1.3 - Configurações Cartão Bandeira MasterCard
O parâmetro Ativar Bandeira Master será descontinuado, ou seja, para o modelo BuyPage na página onde o usuário seleciona a bandeira e função crédito ou débito sempre será apresentada.
O parâmetro Numero máximo de Parcelas será habilitado somente no modelo BuyPage.
1.4 - Configurações Cartão Outras Bandeiras
Será criada essa nova etapa para configuração da Conta Caixa e Meio de Pagamento quando utilizado outras bandeiras para pagamento com cartão.
2 - Integração para Vendas de Produtos ou Serviços
Será utilizada a integração com Carrinho de Compras.
Os parâmetros a serem enviados para o Checkout Cielo se referem basicamente a 6 grupos: Dados do Pedido, Carrinho de Compras, Desconto, Dados do Frete, Dados do Consumidor e Antifraude.
Todas as requisições deverão ser enviadas utilizando o método HTTP POST para a URL https://cieloecommerce.cielo.com.br/api/public/v1/orders.
Parâmetros Dados do Pedido
PARÂMETRO | DESCRIÇÃO | TIPO DO CAMPO | TAM MÍN | TAM MÁX | OBRIGATORIO |
merchant_id | Identificador da loja no Checkout Cielo. Consta no Backoffice no menu Configuração/Dados Cadastrais. | Guid |
|
| Sim |
order_number | Número do pedido da loja. Se não for enviado, o Checkout Cielo gerará um número, que será visualizado pelo Consumidor. | Alfanumérico | 1 | 64 | Não |
| soft_descriptor | Texto que será impresso na fatura do portador, ao lado da identificação da loja. Não pode haver espaços na mensagem | Alfanumérico | 1 | 13 | Não |
| shipping_type | Modalidade de frete | Numérico | 1 | 1 | Sim |
Parâmetros Carrinho de compra
PARÂMETRO | DESCRIÇÃO | TIPO DO CAMPO | TAM MÍN | TAM MÁX | OBRIGATORIO |
cart_n_name | Nome do produto. Não deve ser enviado o código do produto aqui. Influencia diretamente a analise de fraude. | Alfanumérico | 1 | 128 | Sim |
cart_n_description | Descrição do produto | Alfanumérico | 1 | 256 | Não |
| cart_n_unitprice | Preço unitário do produto, em centavos (ex: R$ 1,00 = 100) | Numérico | 1 | 10 | Sim |
| cart_n_quantity | Quantidade do produto | Numérico | 1 | 10 | Sim |
| cart_n_type | Tipo do produto (Tabela 1.2B) – Esse parâmetro altera a obrigatoriedade de outros parâmetros. | Numérico | 1 | 1 | Sim |
| cart_n_code | SKU do produto | Alfanumérico | 1 | 32 | Não |
| cart_n_weight | Peso do produto, em gramas. Usado no cálculo de frete. Obs.: caso o tipo de frete seja "Correios" ou o tipo de produto Material físico, este parâmetro torna-se obrigatório. | Numérico | 1 | 10 | Não |
| cart_n_zipcode | CEP de origem do produto. Usado no cálculo de frete. Caso o tipo de frete seja "Correios". | Numérico | 8 | Não |
Parâmetros Desconto
PARÂMETRO | DESCRIÇÃO | TIPO DO CAMPO | TAM MÍN | TAM MÁX | OBRIGATORIO |
discount_type | Tipo de Desconto | Numérico |
| 1 | Não |
discount_value | Valor do Desconto | Numérico | 1 | 18 | Não |
| boleto_discount_value | Valor de desconto para uso do boleto. Valor representa % de desconto OBS: Prioridade sobre o valor definido no backoffice | Numérico | 1 | 3 | Não |
| debit_discount_value | Valor de desconto para uso do débito. Valor representa % de desconto OBS: Prioridade sobre o valor definido no backoffice | Numérico | 1 | 3 | Não |
REQUISIÇÃO
CABEÇALHO HTTP
| CAMPO | TIPO | OBRIGATÓRIO | TAMANHO | DESCRIÇÃO |
|---|---|---|---|---|
| MerchantId | Guid | Sim | 36 | Identificador único da loja.Formato:00000000-0000-0000-0000-000000000000 |
| Content-type | Alfanumérico | Sim | n/a | Tipo do conteúdo da mensagem a ser enviada. Utilizar:“application/json” |
| CAMPO | TIPO | OBRIGATÓRIO | TAMANHO | DESCRIÇÃO |
|---|---|---|---|---|
| OrderNumber | Alfanumérico | Opcional | 0..64 | Número do pedido da loja. |
| SoftDescriptor | Alfanumérico | Opcional | 0..13 | Texto para ser exibido na fatura do portador, após o nome do estabelecimento comercial. |
| Cart | Cart | Sim | n/a | Informações sobre o carrinho de compras. |
| Shipping | Shipping | Sim | n/a | Informações sobre a entrega do pedido.“ |
| Payment | Payment | Conditional | n/a | Informações sobre o pagamento do pedido. |
| Customer | Customer | Condicional | n/a | Informações sobre dados pessoais do comprador. |
| Options | Options | Conditional | n/a | Informações sobre opções configuráveis do pedido. |
Cart
Parâmetro de requisição com informações sobre o carrinho de compras.
| CAMPO | TIPO | OBRIGATÓRIO | TAMANHO | DESCRIÇÃO |
|---|---|---|---|---|
| Discount | Discount | Opcional | n/a | Informações do desconto sobre o carrinho de compras. |
| Items | Item[] | Sim | n/a | Lista de itens do carrinho de compras(deve conter no mínimo 1 item). |
Discount
Parâmetro de requisição com informações sobre descontos.
Independentemente do tipo do desconto, ele deverá ser calculado antes da soma do valor do frete.| CAMPO | TIPO | OBRIGATÓRIO | TAMANHO | DESCRIÇÃO |
|---|---|---|---|---|
| Type | Alfanumérico | Condicional | n/a | Tipo do desconto a ser aplicado: "Amount”, “Percent”. Obrigatório caso Valuefor maior ou igual a zero. |
| Value | Numérico | Condicional | 0..18 | Valor do desconto a ser aplicado(pode ser valor absoluto ou percentual). Obrigatório caso Typefor “Amount” ou “Percent”. |
Item
Parâmetro de requisição com informações sobre o item do carrinho de compras.
| CAMPO | TIPO | OBRIGATÓRIO | TAMANHO | DESCRIÇÃO |
|---|---|---|---|---|
| Name | Alfanumérico | Sim | 1..128 | Nome do item no carrinho. |
| Description | Alfanumérico | Opcional | 0.256 | Descrição do item no carrinho. |
| UnitPrice | Numérico | Sim | 1..18 | Preço unitário do item no carrinho (em centavos.* Ex: R$ 1,00 = 100)*. |
| Quantity | Numérico | Sim | 1..9 | Quantidade do item no carrinho. |
| Type | Alfanumérico | Sim | n/a | Tipo do item no carrinho. |
| Sku | Alfanumérico | Opcional | 0..32 | Sku do item no carrinho. |
| Weight | Numérico | Condicional | 0..9 | Peso em gramas do item no carrinho. |
Tipos de item
| TIPO | DESCRIÇÃO |
|---|---|
| Asset | Material Físico |
| Digital | Produtos Digitais |
| Service | Serviços |
| Payment | Outros |
Shipping
Parâmetro de requisição com informações sobre endereço e serviço de entrega dos produtos.
| CAMPO | TIPO | OBRIGATÓRIO | TAMANHO | DESCRIÇÃO |
|---|---|---|---|---|
| Type | Alfanumérico | Sim | n/a | Tipo do frete: “Correios”, “FixedAmount”, “Free”, “WithoutShippingPickUp”, “WithoutShipping”. |
| SourceZipCode | Numérico | Condicional | 8 | CEP de origem do carrinho de compras. |
| TargetZipCode | Numérico | Opcional | 8 | CEP do endereço de entrega do comprador. |
| Address | Address | Opcional | n/a | Informações sobre o endereço de entrega do comprador. |
| Services | Service[] | Condicional | n/a | Lista de serviços de frete. |
Address
Parâmetro de requisição com informações sobre o endereço do comprador. Veja também o parâmetro Customer
| CAMPO | TIPO | OBRIGATÓRIO | TAMANHO | DESCRIÇÃO |
|---|---|---|---|---|
| Street | Alfanumérico | Sim | 1..256 | Rua, avenida, travessa, etc, do endereço de entrega do comprador. |
| Number | Alfanumérico | Sim | 1..8 | Número do endereço de entrega do comprador. |
| Complement | Alfanumérico | Opcional | 0..256 | Complemento do endereço de entrega do comprador. |
| District | Alfanumérico | Sim | 1..64 | Bairro do endereço de entrega do comprador. |
| City | Alfanumérico | Sim | 1..64 | Cidade do endereço de entrega do comprador. |
| State | Alfanumérico | Sim | 2 | Estado (UF) do endereço de entrega do comprador. |
Service
Parâmetro de requisição com informações sobre o serviço de frete que será utilizado.
| CAMPO | TIPO | OBRIGATÓRIO | TAMANHO | DESCRIÇÃO |
|---|---|---|---|---|
| Name | Alfanumérico | Sim | 1..128 | Nome do serviço de frete. |
| Price | Numérico | Sim | 1..18 | Preço do serviço de frete (em centavos. Ex: R$ 1,00 = 100). |
| Deadline | Numérico | Condicional | 0..9 | Prazo de entrega (em dias). |
Payment
Parâmetro com informações sobre o desconto para pagamento via boleto ou débito online.
| CAMPO | TIPO | OBRIGATÓRIO | TAMANHO | DESCRIÇÃO |
|---|---|---|---|---|
| BoletoDiscount | Numérico | Condicional | 0..3 | Desconto, em porcentagem, para pagamentos a serem realizados com boleto. |
| DebitDiscount | Numérico | Condicional | 0..3 | Desconto, em porcentagem, para pagamentos a serem realizados com débito online. |
| RecurrentPayment | RecurrentPayment | Condicional | Objeto necessário para pagamentos recorrentes |
Customer
Parâmetro de requisição com informações sobre o comprador.
| CAMPO | TIPO | OBRIGATÓRIO | TAMANHO | DESCRIÇÃO |
|---|---|---|---|---|
| Identity | Numérico | Condicional | 0..14 | CPF ou CNPJ do comprador. |
| FullName | Alfanumérico | Condicional | 0..288 | Nome completo do comprador. |
| Alfanumérico | Condicional | 0..64 | Email do comprador. | |
| Phone | Numérico | Condicional | 0..11 | Telefone do comprador. |
Options
Parâmetro para configurar o sistema de anti-fraude para a transação.
| CAMPO | TIPO | OBRIGATÓRIO | TAMANHO | DESCRIÇÃO |
|---|---|---|---|---|
| AntifraudEnabled | Boolean | Conditional | n/a | Habilitar ou não a análise de fraude para o pedido. |
2 - Página de Extrato Financeiro - Portal Educacional
Quando o cliente estiver usando o modelo Checkout da Cielo e no Totvs Gestão Educacional a opção "Pagamento dos boletos pode ser efetuado com cartão de crédito" estive marcado, quando o usuário clicar na imagem do cartão o mesmo será redirecionado para a pagina de pagamento segura da Cielo.
3 - Retorno, Notificação e Mudança de status
3.1 - Será criada uma página de Retorno na qual o usuário será redirecionado assim que pagamento for concluído no ambiente seguro da Cielo.
3.2 - Será criada uma página que deve ser preparadas para receber os dados do POST de Notificação enviados pela Cielo no momento que a transação é finalizada. A página deverá exibir um código informando que recebeu a notificação e a processou com sucesso. Código:<status>OK</status>
Parâmetros do Post de Notificação
PARÂMETRO | DESCRIÇÃO | TIPO DO CAMPO | TAM MÍN | TAM MÁX |
checkout_cielo_order_number | Identificador único gerado pelo CHECKOUT CIELO | Alfanumérico | 1 | 32 |
amount | Preço unitário do produto, em centavos (ex: R$ 1,00 = 100) | Numérico | 1 | 10 |
order_number | Número do pedido enviado pela loja | Alfanumérico | 1 | 32 |
created_date | Data da criação do pedido (dd/MM/yyyy HH:mm:ss) | Alfanumérico | 1 | 20 |
customer_name | Nome do consumidor. Se enviado, esse valor já vem preenchido na tela do CHECKOUT CIELO | Alfanumérico | 1 | 289 |
customer_identity | Identificação do consumidor (CPF ou CNPJ) Se enviado, esse valor já vem preenchido na tela do CHECKOUT CIELO | Alfanumérico | 1 | 14 |
customer_email | E-mail do consumidor. Se enviado, esse valor já vem preenchido na tela do CHECKOUT CIELO | Alfanumérico | 1 | 64 |
customer_phone | Telefone do consumidor. Se enviado, esse valor já vem preenchido na tela do CHECKOUT CIELO | Numérico | 1 | 11 |
discount_amount | Valor do desconto fornecido (enviado somente se houver desconto) | Numérico | 1 | 10 |
shipping_type | Modalidade de frete | Numérico | 1 | 1 |
shipping_name | Nome do frete | Alfanumérico | 1 | 128 |
shipping_price | Valor do serviço de frete, em centavos (ex: R$ 10,00 = 1000) | Numérico | 1 | 10 |
shipping_address_zipcode | CEP do endereço de entrega | Numérico | 1 | 8 |
shipping_address_district | Bairro do endereço de entrega | Texto | 1 | 64 |
shipping_address_city | Cidade do endereço de entrega | Alfanumérico | 1 | 64 |
shipping_address_state | Estado de endereço de entrega | Alfanumérico | 1 | 64 |
shipping_address_line1 | Endereço de entrega | Alfanumérico | 1 | 256 |
shipping_address_line2 | Complemento do endereço de entrega | Alfanumérico | 1 | 256 |
shipping_address_number | Número do endereço de entrega | Numérico | 1 | 8 |
payment_method_type | Cód. do tipo de meio de pagamento | Numérico | 1 | 1 |
payment_method_brand | Bandeira (somente para transações com meio de pagamento cartão de crédito) | Numérico | 1 | 1 |
payment_method_bank | Banco emissor (Para transações de Boleto e Débito Automático) | Numérico | 1 | 1 |
payment_maskedcredicard | Cartão Mascarado (Somente para transações com meio de pagamento cartão de crédito) | Alfanumérico | 1 | 20 |
payment_installments | Número de parcelas | Numérico | 1 | 1 |
payment_antifrauderesult | Status das transações de cartão de Crédito no Antifraude | Numérico | 1 | 1 |
payment_boletonumber | Numero do boleto gerado | String | ||
payment_boletoexpirationdate | Data de vencimento para transações realizadas com boleto bancário | Numérico | 1 | 10 |
payment_status | Status da transação | Numérico | 1 | 1 |
tid | TID Cielo gerado no momento da autorização da transação | Alfanumérico | 1 | 32 |
3.3 - Será criada uma página que deve ser preparada para receber os dados do POST de Mudança de Status enviados pela Cielo quando um pedido tiver seu status alterado. Este post contém apenas os dados de identificação do pedido. A página deverá exibir um código informando que recebeu a mudança de status e a processou com sucesso. Código:<status>OK</status>
Parâmetros do Post de Mudança de Staus
PARÂMETRO | DESCRIÇÃO | TIPO DO CAMPO | TAM MÍN | TAM MÁX |
checkout_cielo_order_number | Identificador único gerado pelo CHECKOUT CIELO. | Alfanumérico | 1 | 32 |
amount | Preço unitário do produto, em centavos (ex: R$ 1,00 = 100) | Numérico | 1 | 10 |
order_number | Número do pedido enviado pela loja | Alfanumérico | 1 | 32 |
payment_status | Status da transação | Numérico | 1 | 1 |
O parâmetro payment_status poderá vir com um dos seguintes valores:
| VALOR | DESCRIÇÃO |
|---|---|
| 1 | Pendente (Para todos os meios de pagamento) |
| 2 | Pago (Para todos os meios de pagamento) |
| 3 | Negado (Somente para Cartão Crédito) |
| 5 | Cancelado (Para cartões de crédito) |
| 6 | Não Finalizado (Todos os meios de pagamento) |
| 7 | Autorizado (somente para Cartão de Crédito) |
4 - Cancelamento
Diferente do modelo BuyPage, no modelo de Checkout o cancelamento do pagamento com cartão deve ser feito no Backoffice Checkout da Cielo e no Totvs Gestão Financeira manualmente.
5 - Backoffice Checkout Cielo
O cliente deve configurar as 3 URLs (Retorno, Notificação e Mudança de Status), as bandeiras de cartão ativas, o numero máximo de parcelas e o ambiente de testes em seu Backoffice Checkout Cielo, na aba Configurações:
Fluxo do Processo
Este documento é material de especificação dos requisitos de inovação, trata-se de conteúdo extremamente técnico. |
|---|
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas