Linha RM

Atalhos

Páginas filhas
  • ER_PCREQ-8625_Checkout_Cielo

 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

Portal Educacional e Processo Seletivo

Segmento Executor

Educacional

Projeto

R_EDU_CTB005

IRM

PCREQ-8624

Requisito

PCREQ-8625

Subtarefa

PDR_EDU_CTB003-594

Release de Entrega Planejada

12.1.12

Réplica

 

País

( x ) Brasil  (  ) Argentina  (  ) Mexico  (  ) Chile  (  ) Paraguai  (  ) Equador

(  ) USA  (  ) Colombia   (  ) Outro _____________.

Outros

CheckoutCielo_Manual_do_desenvolvedor_v1_3.pdf

Checkout Cielo - Manual Do Desenvolvedor V1.6 - API POST.pdf

Objetivo

Implementar o novo modelo de integração de pagamento com cartão CHECKOUT CIELO, no portal Educacional e Processo Seletivo.

 

Definição da Regra de Negócio

1 - Parametrização (Etapa 02.02.02.03 - Cartão de Crédito/Débito)

1.1 - Configurações Gerais Cartão de Crédito/Débito 

  • Configurações Gerais 1/2: 
    Como a solução BuyPage da Cielo não foi descontinuada, será criado um parâmetro "Modelo E-commerce" para informar qual a modelo de integração com a Cielo será utilizada, com as seguintes opções: 1 - BuyPage e 2 - Checkout 
  • Configurações Gerais 2/2:
    Se a opção BuyPage marcada serão exibidos os campos "Codigo de Afiliação do Lojista", "Ambiente Ativo", "Chave Acesso do Lojista", "URL Ambiente Teste" e "URL Ambiente Produção".
    Se a opção Checkout marcada serão exibidos os campos: "MerchantId" que é o identificador do cliente junto a Cielo, e "URL de Post" onde será enviado um post para Cielo utilizando a API Rest, para iniciar a transação do pagamento com cartão de crédito/débito.

1.2 - Configurações Cartão de Crédito/Débito

  • Bandeira 1/3:
    Configurações de crédito/débito para a bandeira Visa, com campos de Conta Caixa e Meio de Pagamento. Se opção BuyPage marcada será exibido o campo "Ativar Bandeira Visa", "Numero de Parcelas" e "Ativar Função Débito".
  • Bandeira 2/3:
    Configurações de crédito/débito para a bandeira Master, com campos de Conta Caixa e Meio de Pagamento. Se opção BuyPage marcada será exibido o campo "Ativar Bandeira Master" "Número de Parcelas" e somente a opção crédito.
  • Bandeira 3/3:
    Configurações de crédito para outras bandeiras, com campos de Conta Caixa e Meio de Pagamento. Somente visível se opção Checkout marcada.

2 - Envio do Post para Cielo

Será utilizada a integração com Carrinho de Compras utilizando API Rest para envio do post. A URL de Post que deverá ser utilizada é https://cieloecommerce.cielo.com.br/api/public/v1/orders.

Para a integração serão utilizados os parâmetros abaixo:

REQUISIÇÃO

Header Http

CAMPOTIPOOBRIGATÓRIOTAMANHODESCRIÇÃO
MerchantIdGuidSim36Identificador único da loja.Formato:00000000-0000-0000-0000-000000000000
Content-typeAlfanuméricoSimn/aTipo do conteúdo da mensagem a ser enviada. Utilizar:“application/json”

Body

CAMPOTIPOOBRIGATÓRIOTAMANHODESCRIÇÃO
OrderNumberAlfanuméricoOpcional0..64Número do pedido da loja.
SoftDescriptorAlfanuméricoOpcional0..13Texto para ser exibido na fatura do portador, após o nome do estabelecimento comercial.
Cart Simn/aInformações sobre o carrinho de compras.
Cart.Items Simn/aLista de items do carrinho de compras (deve conter no mínimo 1 item)
Cart.Items.[].NameAlfanumericoSim1...128Nome do item no carrinho.
Cart.Items.[].UnitPriceNumericoSim1...18Preço unitário do item no carrinho (em centavos.* Ex: R$ 1,00 = 100)*.
Cart.items.[].QuantityNuméricoSim1..9Quantidade do item no carrinho.
Cart.Items.[].TypeAlfanuméricoSimn/a"Service"
Shipping Simn/aInformações sobre a entrega do pedido
Shipping.TypeAlfanuméricoSimn/a“WithoutShipping”
Customer Condicional n/aInformações sobre dados pessoais do comprador
Customer.IdentityNuméricoCondicional0..14CPF ou CNPJ do comprador.
Customer.FullNameAlfanuméricoCondicional0..288Nome completo do comprador.
Customer.EmailAlfanuméricoCondicional0..64Email do comprador.
Customer.Phone.NuméricoCondicional0..11Telefone do comprador
Options Condicional n/aInformações sobre opções configuráveis do pedido.
Options.AntifraudEnabledBooleanConditionaln/aHabilitar ou não a análise de fraude para o pedido.


RESPOSTA

Em caso de sucesso

CAMPOTIPOOBRIGATÓRIOTAMANHODESCRIÇÃO
SettingsSettingsSimn/aInformações da resposta sobre a criação do pedido.
CheckoutUrlAlfanuméricoSim1..128URL de checkout do pedido. Formato: https://cieloecommerce.cielo.com.br/transacional/order/index?id={id}
ProfileAlfanuméricoSim1..16Perfil do lojista: fixo “CheckoutCielo”.
VersionAlfanuméricSim1Versão do serviço de criação de pedido (versão: 1).

Em caso de erro

CAMPOTIPOOBRIGATÓRIOTAMANHODESCRIÇÃO
MessageStringSim1..254Mensagem descritiva do erro

 

3 - Portal Educacional e Processo Seletivo

Quando o cliente estiver usando o modelo Checkout da Cielo, na tela 'Confirmar Dados Cadastrais', quando o usuário clicar no botão 'Avançar' o mesmo será redirecionado para a pagina de pagamento segura da Cielo.

4 - Retorno, Notificação e Mudança de status

4.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. Caso o cliente não configure a página de retorno no BackOffice da Cielo o usuário será redirecionado para uma página própria da Cielo.

4.2 - Será criada uma página, sem autenticação, que deve ser preparadas para receber os dados do POST de Notificação e Mudança de Status enviados pela Cielo no momento que a transação é finalizada ou ter seu status alterado. 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

 

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

 

Tabela 1 - Meio de Pagamento

Valor
Descrição
1Cartão de Crédito
2

Boleto Bancário

3Débito Online
4Cartão de Débito

Tabela 2 - Bandeira

Valor
Descrição
1Visa
2Mastercard
3AmericanExpress
4Diners
5Elo
6Aura
7JCB

 

Tabela 3 - Banco Emissor

Valor
Descrição
1Banco do Brasil
2Bradesco

 

Tabela 4 - Status AntiFraude

Valor
Descrição
1Baixo Risco
2Alto Risco
3Não Finalizado
4Risco Moderado

 

Tabela 5 - Status da transação

VALORDESCRIÇÃO
1Pendente (Para todos os meios de pagamento)
2Pago (Para todos os meios de pagamento)
3Negado (Somente para Cartão Crédito)
4Expirado (Cartão de Credito e Boleto)
5Cancelado (Para cartões de crédito)
6Não Finalizado (Todos os meios de pagamento)
7Autorizado (somente para Cartão de Crédito)
8ChargeBack (Somente Cartão de Credito)

 

Processos:

Após receber o post notificação e enviar o status "ok" o sistema deve armazenar na tabela de Integração do cartão (FINTEGRACAOCARTAO), com os seguintes valores:

  • IDENTIFICADORORIGEM: "Coligada" + '|' + "Identificador do Boleto"
  • IDPROCESSO: tid
  • IDCHECKOUT: checkout_cielo_order_numbe
  • BANDEIRA: payment_method_brand
  • DATAHORA: created_date
  • IDSTATUS: payment_status
  • CODAFILIACAO: merchantid
  • MEIOPAGTO: payment_method_type
  • NUMPARCELAS; payment_installments
  • CODCOLIGADA: código da coligada
  • IDBOLETO: identificador do boleto
  • IDMODELO: preencher com 2 (Checkout Cielo)

Os pagamentos com cartão de crédito com status Autorizado serão automaticamente marcados como Baixa Pendente no RM e serão baixado somente quando o pagamento for capturado.

Ao mudar o status de pagamento com status "Pago" para "Cancelado" ou "ChargeBack" no BackOffice da Cielo, será automaticamente cancelado a baixa do boleto referente ao pagamento no RM.

Ao mudar o status de pagamento com status "Autorizado" para "Cancelado" no BackOffice da Cielo, será automaticamente liberado a Baixa Pendente do lançamento referente ao pagamento no RM.

Toda mudança de status do pagamento na Cielo será também alterado o status na tabela Integração do cartão (FINTEGRACAOCARTAO) do RM.

5 - Backoffice Checkout Cielo

O cliente deve configurar a URL de Retorno, Notificação e Mudança de Status no BackOffice. A URL de Retorno é opcional.

URL de Retorno: .../Corpore.Net/Source/Fin-Financeiro/RM.Fin.Lan/FinLanCartaoRetornoCheckout.aspx

URL de Notificação : .../Corpore.Net/Source/Fin-Financeiro/RM.Fin.Lan/CheckoutCielo/FinLanCartaoNotificacao.aspx

URL de Mudança de Status: .../Corpore.Net/Source/Fin-Financeiro/RM.Fin.Lan/CheckoutCielo/FinLanCartaoMudancaStatus.aspx

Fluxo do Processo


Dicionário de Dados

 

Arquivo ou Código do Script: FS.2016.03_01; FS.2016.03_02; FS.2016.06_02

 

 Este documento é material de especificação dos requisitos de inovação, trata-se de conteúdo extremamente técnico.