Beruflich Dokumente
Kultur Dokumente
Manual do Desenvolvedor
Verso 1.4
12/03/2014
25/02/2013
SUMRIO
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
Pgina 2 de 31
1. HISTRICO DE ALTERAES
Data
Descrio
1.0
17/05/2013
Verso inicial
1.1
16/08/2013
1.2
27/08/2013
1.3
18/11/2013
1.4
06/03/2014
Pgina 3 de 31
3. SOBRE O MEUCHECKOUT
O MeuCheckout uma soluo de checkout projetado para aumentar converso, simplificar o processo de
compra, reduzir fraudes e custos operacionais.
Pgina 4 de 31
OBS: possivel realizar uma integrao via POST server to server, onde o POST enviado pelo servidor do
lojista e o MeuCheckout retorna a Url da tela de pagamento, sendo assim uma opo de maior segurana para o
lojista e o cliente.
Veja abaixo a tabela com os parmetros a serem enviados. E logo abaixo algumas instrues de uso dos grupos.
Parmetro
Carrinho de Compras
Dados do Pedido
Merchant_ID
Order_Number
Soft_Descriptor
Descrio
Identificador da loja no MeuCheckout
Voc recebeu essa informao no e-mail
de Ativao de Loja e tambm consta
no Backoffice no menu
Configurao/Dados Cadastrais.
Nmero do pedido da loja.
Se no for enviado, o MeuCheckout
gerar um nmero, que ser visualizado
pelo Consumidor.
Texto de at 13 caracteres que ser
impresso na fatura do portador, ao lado
da identificao da loja. No pode haver
espaos na mensagem
Tipo do
Campo
Tamanho
Obrigatrio
Min
Max
GUID
Sim
Alfanumrico
64
No
Alfanumrico
13
No
Shipping_Type
Numrico
Sim
Cart_N_Name
Alfanumrico
128
Sim
Descrio do produto
Alfanumrico
256
No
Cart_N_UnitPrice
Numrico
10
Sim
Cart_N_Quantity
Quantidade do produto
Numrico
10
Sim
Numrico
Sim
Cart_N_Description
Cart_N_Type
Pgina 5 de 31
Cart_N_Code
Cart_N_Weight
Desconto
Cart_N_ZipCode
32
No
Numrico
10
No
Numrico
No
No
Numrico
Discount_Value
Numrico
Boleto_discount_value
No
Numerico
100
No
Numrico
100
No
Shipping_N_Name
Alfanumrico
128
No
Shipping_N_Price
Numrico
10
No
Alfanumrico
256
No
Alfanumrico
No
Alfanumrico
256
No
Alfanumrico
64
No
Alfanumrico
64
No
Alfanumrico
No
No
288
No
Shipping_Address_Name
Shipping_Address_Numb
er
Dados de Frete
Alfanumrico
Discount_Type
Debit_discount_value
Shipping_Address_Comp
lement
Shipping_Address_Distri
ct
Shipping_Address_City
Shipping_Address_State
Shipping_ZipCode
Dados
do
Consum
idor
SKU do produto
Customer_Name
Numrico
Alfanumrico
Pgina 6 de 31
Customer_Identity
Customer_Email
Customer_Phone
Numrico
14
No
Alfanumrico
64
No
Numrico
11
No
Descrio
Correios
Frete fixo
Frete grtis
Retirar em mos/loja
Descrio
Material fsico
Digital
Servio
Descrio
Obs1: Caso o tipo de desconto escolhido seja o Valor, dever ser inserido o valor em centavos.
Ex.: 100 = 1,00 e no recibo da transao ser exibido da seguinte forma:
Pgina 7 de 31
Obs2: Caso o tipo de desconto escolhido seja o Percentual, dever ser inserido o valor em nmero inteiro.
Ex.: 10 = 10% e no recibo da transao ser exibido da seguinte forma:
Obs3: Em ambos os casos anteriores, o desconto calculado antes da soma do valor do frete.
Carrinho de Compras:
Campos: CART_N_NAME, CART_N_DESCRIPTION, CART_N_UNITPRICE, CART_N_QUANTITY, CART_N_TYPE,
CART_N_CODE, CART_N_WEIGHT, CART_N_ZIPCODE.
Nos campos referentes ao Carrinho onde sero enviados os itens escolhidos pelo Consumidor para compra. Cada
produto/servio dever ser listado nestes campos, com suas devidas informaes.
O N deve ser representado por cada item do carrinho. Exemplo de Carrinho, com uso de Frete Correios:
Produto
Descrio
Preo
Qtde
Tipo
SKU
CART_N
_NAME
CART_N_DES
CRIPTION
CART_N_UN
ITPRICE
CART_N_Q
UANTITY
CART_N
_TYPE
CART_N
_CODE
Peso
ZipCode
CART_N_
WEIGHT
CART_N_Z
IPCODE
FRETE
FRETE
Bermuda
95,00
Material
9100012
500gr
220080-120
Blusa
80,00
Material
9100013
300gr
220080-120
CART_1_NAME = Bermuda
CART_1_DESCRIPTION =
CART_1_UNITPRICE = 9500
CART_1_QUANTITY = 1
CART_1_TYPE = 1
CART_1_CODE = 9100012
CART_1_WEIGHT = 500
Pgina 8 de 31
CART_1_ZIPCODE = 220080-120
CART_2_NAME = Blusa
CART_2_DESCRIPTION =
CART_2_UNITPRICE = 8000
CART_2_QUANTITY = 1
CART_2_TYPE = 1
CART_2_CODE = 9100013
CART_2_WEIGHT = 300
CART_2_ZIPCODE = 220080-120
Exemplo de POSTs.
Material fsico
Dados do
pedido
Dados de
Compras
Bens Digitais/Servios
Merchant_Id:
Merchant_Id:
Order_Number:
Order_Number:
SHIPPING_TYPE: 1/2/3/4
SHIPPING_TYPE: 5
Soft_Descriptor:
Soft_Descriptor:
Cart_1_Name:
Cart_1_Name:
Cart_1_Unitprice:
Cart_1_Unitprice:
Cart_1_Quantity:
Cart_1_Quantity:
Cart_1_Weight:
Cart_1_Zipcode:
Cart_1_Type: 1 (Obrigatrio)
Esses parmetros no
so obrigatorios no caso de
Bens Digitais ou Servios
Cart_1_Type: 2 Ou 3 (Obrigatorio)
Shipping_1_Name:
Shipping_1_Price:
Shipping_Zipcode:
Dados de
frete
Esses parmetros no
so obrigatorios no caso de Bens
Digitais ou Servios
Shipping_Address_Complement: (Obrigatorio se
frete fixo ou gratis e se Shipping_Zipcode enviado)
Shipping_Address_District: (Obrigatorio se
frete fixo ou gratis e se Shipping_Zipcode enviado)
Pgina 9 de 31
Dados do
consumidor
Customer_Name:
Customer_Name:
Customer_Identity:
Customer_Identity:
Customer_Email:
Customer_Email:
Customer_Phone:
Customer_Phone:
Dados de Frete:
Campos: SHIPPING_N_NAME, SHIPPING_N_PRICE
O uso do campo de frete no obrigatrio. Segue abaixo as modalidades de uso do Frete:
Frete Grtis:
Voc deve passar no campo SHIPPING_TYPE o valor 3.
No preciso mandar os Dados de Frete.
MeuCheckout apresentar junto ao valor total da compra o campo
Frete grtis.
Pgina 10 de 31
Pgina 11 de 31
Pgina 12 de 31
Dados do Consumidor:
Campos: CUSTOMER_NAME, CUSTOMER_IDENTITY, CUSTOMER_EMAIL, CUSTOMER_PHONE
Estes parmetros no so obrigatrios, no entanto se o seu site j pede que o seu Cliente esteja logado e voc
possui algumas destas informaes, elas podem ser enviadas no Post e sero automaticamente preenchidas na tela
do MeuCheckout, agilizando assim a finalizao da compra por parte do consumidor. Esses campos sero editveis,
e caso seja necessrio, o consumidor poder alter-las.
Pgina 13 de 31
Pgina 14 de 31
Tipo do Produto
SKU
Ttulo
Descrio
Preo
Frete
CEP de Origem
Peso(kg)
Valor do Frete
Mtodo de envio
URL
Descrio
Min
Tamanho
Max
Obrigatrio
Sim
50
No
Titulo do Produto
50
Sim
Descrio do Produto
255
Sim
11
14
Sim
Sim
Sim
Sim
Sim
Sim
Sim
Exemplo de Boto:
Adicionando o boto na sua pgina HTML voc deve copiar o cdigo HTML do boto criado e colocar no cdigo
HTML do seu site, conforme o exemplo abaixo.
Pgina 15 de 31
6.
URL DE RETORNO
Ao finalizar uma transao, o comprador final poder ser redirecionado para a URL de retorno. Ao clicar no boto
VOLTAR na tela de comprovante de vendas, o comprador ser direcionando para a URL de retorno previamente
cadastrada no BackOffice.
Essa URL cadastrada pelo prprio lojista no Backoffice, na aba configuraes da loja.
Pgina 16 de 31
7. URL DE NOTIFICAO
Ao finalizar uma transao enviado um post com todos os dados da venda para a URL de Notificao cadastrada,
previamente cadastrada no BackOffice.
Essa URL cadastrada pelo prprio lojista no Backoffice, na aba configuraes da loja.
Descrio
Tipo do
Campo
Tamanho
Min
Max
Meucheckout_order_number
Alfanumrico
32
Amount
Numrico
10
Order_Number
Alfanumrico
32
created_date
Alfanumrico
20
Customer_Name
Nome do consumidor.
Se enviado, esse valor j vem preenchido
na tela do MeuCheckout
Alfanumrico
289
Pgina 17 de 31
Customer_Identity
Alfanumrico
14
Customer_Email
E-mail do consumidor
Se enviado, esse valor j vem preenchido
na tela do MeuCheckout
Alfanumrico
64
Customer_Phone
Telefone do consumidor
Se enviado, esse valor j vem preenchido
na tela do MeuCheckout
Numrico
11
Shipping_Type
Modalidade de frete
(vide tabela 1)
Numrico
Shipping_name
Nome do frete
Alfanumrico
128
Shipping_Price
Numrico
10
Shipping_address_zipcode
Numrico
Alfanumrico
64
64
Shipping_address_district
Shipping_address_city
Alfanumrico
Shipping_address_line1
Endereo de entrega
Alfanumrico
256
Shipping_address_line2
Alfanumrico
256
Shipping_address_number
Numrico
Payment_method_type
Numrico
Payment_method_brand
Numrico
Payment_method_bank
Numrico
Payment_maskedcredicard
Alfanumrico
20
Payment_installments
Nmero de parcelas
Numrico
Payment_antifrauderesult
Numrico
Payment_boletoexpirationdate
Numrico
10
Payment_status
Status da transao
(vide tabela 6)
Numrico
1
2
Pgina 18 de 31
Quando acessada pelo servidor da Braspag, enviando o POST da tabela acima, a URL cadastrada para
Notificao dever exibir um cdigo informando que recebeu a mudana de status e a processou com
sucesso. Cdigo:<status>OK</status>
Se a URL for acessada pelo nosso servidor e no exibir o cdigo de confirmao, o servidor ir tentar
novamente por trs vezes, a cada hora. Caso o <status>OK</status> ainda no seja exibido, ser
entendido que o servidor da loja no responde.
A URL de Notificao somente pode utilizar porta 80 (padro para http) ou porta 443 (padro para
https).
A URL de mudana de status fornecida pelo lojista. Nessa URL sero postadas as informaes
de todos os pedidos que tiverem seu status alterado.
Essa URL cadastrada pelo prprio lojista no Backoffice, na aba configuraes da loja.
Pgina 19 de 31
Quando acessada pelo servidor da Braspag, enviando o POST, a URL cadastrada para Retorno de Mudana
de Status, dever exibir um cdigo informando que recebeu a mudana de status e a processou com
sucesso: <status>OK</status>
Se a URL de mudana de status da loja for acessada pelo servidor da Braspag no exibir o cdigo de
confirmao, o servidor ir tentar novamente por trs vezes.
Caso o <status>OK</status> ainda no seja exibido, ser entendido que o servidor da loja no
responde, e ser enviado um e-mail ao responsvel pela loja, informando que o pedido em questo foi
pago.
Ou seja, o cdigo fonte da pgina indicando Sucesso dever conter APENAS <status>OK</status> e
nada mais.
OBS: Na tela de pedidos, dentro de cada transao, h a opo de reenvio do POST de mudana de status. Basta
clicar nos botes azuis, marcados na imagem abaixo
Descrio
Tipo do
Campo
Tamanho
Min
Max
Meucheckout_order_number
Alfanumrico
32
Amount
Numrico
10
Order_Number
Alfanumrico
32
Payment_status
Status da transao
(vide tabela 6)
Numrico
Valor
Descrio
Pgina 20 de 31
Correios
Frete fixo
Frete grtis
Retirar em mos/loja
Valor
Descrio
Carto de Crdito
Boleto Bancrio
Dbito Online
Carto de Dbito
Tabela 3 Bandeira
Valor
Descrio
Visa
Mastercad
AmericanExpress
Diners
Elo
Valor
Descrio
Banco do Brasil
Bradesco
Valor
Descrio
Baixo Risco
Alto Risco
No Finalizado
Risco Moderado
Valor
Descrio
Pgina 21 de 31
Nessa rea h um caixa de seleo, que quando marcada, habilitar o modo de teste do MeuCheckout. O modo
somente se iniciar quando a seleo for salva.
Pgina 22 de 31
Quando a opo for salva, uma tarja vermelha ser exibida na parte superior da tela. Ela ser exibida em todas as
telas do Backoffice e na tela de checkou do MeuCheckout.
Essa tarja indica que a sua loja MeuCheckout est agora operando em ambiente de teste, ou seja, toda a transao
realizada nesse modo ser considerada como teste.
Pgina 23 de 31
Status retornado
0, 1, 2, 3 ou 4
Autorizado
5, 6, 7, 8 ou 9
No autorizado
Pgina 24 de 31
Para definir o nivel de risco retornado na analise de fraude, basta definir o ultimo nome do comprador de acordo
com os valores descritos abaixo:
Nivel do Risco
Alto
Alto Risco
Moderado
Moderado
Baixo
Baixo Risco
Debito online
necessario informa o status da transao de Debito online para que seja retornado o status desejado. Esse
processo ocorre como no antifraude do carto de crdito descrito acima, com a alterao do nome do comprador.
Status do Dbito
Sobre nome do cliente
Status
Pago
Pago
Qualquer nome.
No autorizado
Pgina 25 de 31
Transaes de teste
Todas as transaes realizadas no modo de teste sero exibidas como transaes normais na aba Pedidos do
MeuCheckout, entretanto, elas sero marcadas como transaes de teste e no sero contabilizadas em conjunto
com as transaes realizadas fora do ambiente de teste.
Essas transaes tero o simbolo de teste as diferenciando de suas outras transaes. Elas podem ser capturadas
ou canceladas utilizando os mesmos procedimentos das transaes reais.
Pgina 26 de 31
OBS: muito importante que ao liberar sua loja para a realizao de vendas para seus clientes que ela no esteja
em modo de teste. Transaes realizadas nesse ambiente podero ser finalizadas normalmente, mas no sero
discontadas do carto do cliente e no podero ser transferidas para o ambiente de venda padro.
Pgina 27 de 31
Boleto
Boleto Vencido
(processo automatico)
EXPIRADO
PENDENTE
Boleto gerado
Boto Conciliar
PAGO
fim
fim
Erro de processamento
NO FINALIZADO
Todo boleto gerado (emitido) aparece com o status de PENDENTE no Relatrio de Pedidos exibido ao lojista
na area do Backoffice. Sua troca de status vai depender de aes manuais.
Possiveis Status do Boleto
PENDENTE boleto emitido pelo processo de transao. Status continuo at alterao manual pelo lojista.
PAGO Status usado quando o boto "Conciliar ativado pelo lojista. Esse status pode ser revertido para
pendente utiliando o Boto Desfazer conciliao.
EXPIRADO Status ativo apos 10 dias da criao do boleto, caso esse no tenha sito conciliado nesse periodo.
Boletos com status EXPIRADO podem ser conciliados.
Pgina 28 de 31
Carto de Crdito
TRANSIO DE STATUS DE VENDAS POR CARTO DE CRDITO
Autorizao Iniciada
Ainda sem confirmao da Cielo
NO AUTORIZADO
EXPIRADO
PENDENTE
AUTORIZADO
fim
fim
Boto Cancelar
Boto Capturar
Erro de processamento
NO FINALIZADO
PAGO
Boto Chargeback
fim
fim
Boto Cancelar
CANCELADO
Boto Capturar
CHARGEBACK
Anlise de Fraude
Pedidos AUTORIZADOS sero enviados online, ainda no ato da venda, para ferramenta de Antifraude da
Cybersource para anlise. O resultado desta anlise ser traduzido no campo Indicao AF no Relatrio de
Pedido, para cada pedido.
Esta anlise indicar um BAIXO RISCO ou ALTO RISCO para a venda em questo. Esta sugesto que deve
guiar a deciso de se confirmar a venda ou no. E aparecer da forma abaixo no Detalhe do Pedido.
Pgina 29 de 31
a.
Captura/Cancelamento manual
Captura Automtica
As vendas AUTORIZADAS, e com BAIXO RISCO no antifraude sero CAPTURADAS automaticamente pelo
sistema.
O status apresentado ser PAGO. Esta venda ser ento confirmada (capturada) na Cielo.
c.
Cancelamento Automtico
As vendas AUTORIZADAS, e com ALTO RISCO no antifraude sero CANCELADAS automaticamente pelo
sistema.
O status apresentado ser PAGO. Esta venda ser ento cancelada (desfeita) na Cielo.
Ateno! Voc tem a opo de escolher a melhor integrao para o seu negcio, a captura/cancelamento manual
ou automtico feito diretamente pelo seu backoffice.
Conforme abaixo:
no Detalhe do Pedido.
Pgina 30 de 31
Aps esse recebimento, voc pode entrar no Backoffice e sinalizar o pedido como tendo recebido um Chargeback,
pra seu melhor controle. Basta entrar no Detalhe do Pedido e clicar no boto
a ser CHARGEBACK.
Dbito Online
Transao iniciada
PENDENTE
NO AUTORIZADO
PAGO
fim
fim
Erro de processamento
NO FINALIZADO
Pgina 31 de 31