Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

 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

CheckoutCielo_Manual_do_desenvolvedor_v1_3.pdf

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 - 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 statusDeverá ser criadas páginas

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 Retorno, Notificação e Mudança de Status enviados pela Cielo.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:

VALORDESCRIÇÃO
1Pendente (Para todos os meios de pagamento)
2Pago (Para todos os meios de pagamento)
3Negado (Somente para Cartão Crédito)
5Cancelado (Para cartões de crédito)
6Não Finalizado (Todos os meios de pagamento)
7Autorizado (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.