Sie sind auf Seite 1von 31

MeuCheckout

Manual do Desenvolvedor

Verso 1.4
12/03/2014
25/02/2013

MeuCheckout - Manual do Desenvolvedor

SUMRIO

1.

HISTRICO DE ALTERAES .......................................................................................................................... 3

2.

SOBRE ESTE MANUAL .................................................................................................................................... 4

3.

SOBRE O MEUCHECKOUT .............................................................................................................................. 4

4.

INTEGRAO VIA POST ................................................................................................................................. 5

5.

INTEGRAO VIA BOTO MEUCHECKOUT COMPRAR .............................................................................. 14

6.

URL DE RETORNO ........................................................................................................................................ 16

7.

URL DE NOTIFICAO .................................................................................................................................. 17

8.

URL DE MUDANA DE STATUS .................................................................................................................... 19

9.

MODO DE TESTE MEUCHECKOUT ................................................................................................................ 22

10.

FLUXOS DOS MEIOS DE PAGAMENTOS UTILIZADOS NO MEUCHECKOUT ................................................ 28

Telefone: (21)2111-4732/ (11) 3320-9050

Pgina 2 de 31

MeuCheckout - Manual do Desenvolvedor

1. HISTRICO DE ALTERAES

MeuCheckout - Manual de Integrao e Desenvolvimento


Verso

Data

Descrio

1.0

17/05/2013

Verso inicial

1.1

16/08/2013

Insero dos Parmetros de Desconto


Anlise de Fraude: Cancelamento e Captura
Automtica

1.2

27/08/2013

Incluso da URL de Mudana de Status

1.3

18/11/2013

1.4

06/03/2014

Incluso dos Modo de testes, POST de exemplo,


Parmetros de envio de endereo e atualizao
da URL de Notificao
Reviso das configuraes de frete, das telas de
do Meucheckout. Integrao POST Server a
server, incluso do desconto para boleto e
dbito online via POST

Telefone: (21)2111-4732/ (11) 3320-9050

Pgina 3 de 31

MeuCheckout - Manual do Desenvolvedor

2. SOBRE ESTE MANUAL


O objetivo deste documento orientar o desenvolvedor sobre como integrar com o MEU CHECKOUT. Descrevendo
as funcionalidades, os mtodos a serem utilizados, listando informaes a serem enviadas e recebidas, e provendo
exemplos.

3. SOBRE O MEUCHECKOUT
O MeuCheckout uma soluo de checkout projetado para aumentar converso, simplificar o processo de
compra, reduzir fraudes e custos operacionais.

Telefone: (21)2111-4732/ (11) 3320-9050

Pgina 4 de 31

MeuCheckout - Manual do Desenvolvedor

4. INTEGRAO VIA POST


Integrao via Post deve ser usada sempre que houver um carrinho de compras a ser enviado, ou seja, no caso
do consumidor navegar pelo site e escolher 1 ou mais produtos para adicionar a um carrinho e depois ento
finalizar a venda. Se voc no possui um carrinho de compras implementado, veja a seo de integrao via boto
MEUCHECKOUT explicada no item 6.
Os campos a serem preenchidos no formulrio a ser postado para o MeuCheckout se referem basicamente a 4
grupos: Dados do Pedido, Carrinho de Compras, Dados de Frete e Dados do Consumidor.

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.

Url de Post: https://www.meucheckout.com.br/Transactional/Order/Index

Veja abaixo a tabela com os parmetros a serem enviados. E logo abaixo algumas instrues de uso dos grupos.

Tabela 1 Parmetros para integrao Post


Grupo

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

Modalidade de frete (Tabela 1.1)

Numrico

Sim

Cart_N_Name

Nome do produto. No deve ser


enviado o cdigo do produto aqui.
Influencia diretamente a analise de
fraude.

Alfanumrico

128

Sim

Descrio do produto

Alfanumrico

256

No

Cart_N_UnitPrice

Preo unitrio do produto, em centavos


(ex: R$ 1,00 = 100)

Numrico

10

Sim

Cart_N_Quantity

Quantidade do produto

Numrico

10

Sim

Tipo do produto (Tabela 1.2) Esse


parametro altera a obrigatoriedade
de outros parametros.

Numrico

Sim

Cart_N_Description

Cart_N_Type

Telefone: (21)2111-4732/ (11) 3320-9050

Pgina 5 de 31

MeuCheckout - Manual do Desenvolvedor

Cart_N_Code

Cart_N_Weight

Desconto

Cart_N_ZipCode

32

No

Numrico

10

No

Numrico

No

No

Tipo de Desconto (Tabela 1.3)

Numrico

Discount_Value

Valor do Desconto (Tabela 1.3)

Numrico

Boleto_discount_value

Valor de desconto para uso do boleto.


Valor representa % de desconto
OBS: Prioridade sobre o valor
definido no backoffice
Valor de desconto para uso do dbito.
Valor representa % de desconto
OBS: Prioridade sobre o valor
definido no backoffice

No

Numerico

100

No

Numrico

100

No

Shipping_N_Name

Nome do servio de frete. Descrio


informativa ao comprador.

Alfanumrico

128

No

Shipping_N_Price

Valor do servio de frete, em centavos


(ex: R$ 10,00 = 1000)

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

Peso do produto, em gramas (ex: 1 Kg =


1000 gramas). Usado no clculo de frete.
Obs.: caso o tipo de frete seja
"Correios" ou o tipo de produto
Material fsico, este parmetro tornase obrigatrio.
CEP de origem do produto. Usado no
clculo de frete.
Obs.: caso o tipo de frete seja
"Correios" , este parmetro no
permitir edio.

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

Logradouro do endereo. obrigatorio


se o tipo de frete fixo ou grtis, e o
CEP enviado
Nmero do endereo de entrega.
obrigatorio se o tipo de frete fixo
ou grtis, e o CEP enviado
Complemento do endereo de entrega.
obrigatorio se o tipo de frete fixo
ou grtis, e o CEP enviado
Bairro do endereo de entrega.
obrigatorio se o tipo de frete fixo
ou grtis, e o CEP enviado
Cidade do endereo de entrega.
obrigatorio se o tipo de frete fixo
ou grtis, e o CEP enviado
Estado (UF) do endereo de entrega.
obrigatorio se o tipo de frete fixo
ou grtis, e o CEP enviado
CEP de Destino do Produto. Usado no
clculo de frete.
Obs.:Caso o tipo de frete seja Frete
Fixo, na pgina do Meucheckout
Transacional, o valor do CEP no ser
passvel de edio
Nome do consumidor.
Se enviado, esse valor j vem preenchido
na tela do MeuCheckout

Telefone: (21)2111-4732/ (11) 3320-9050

Numrico

Alfanumrico

Pgina 6 de 31

MeuCheckout - Manual do Desenvolvedor

Customer_Identity

Customer_Email

Customer_Phone

Identificao do consumidor (CPF ou


CNPJ)
Se enviado, esse valor j vem preenchido
na tela do MeuCheckout. Enviar sem
nenhuma formatao
Email do consumidor
Se enviado, esse valor j vem preenchido
na tela do MeuCheckout
Telefone do consumidor
Se enviado, esse valor j vem preenchido
na tela do MeuCheckout. Enviar sem
nenhuma formatao

Numrico

14

No

Alfanumrico

64

No

Numrico

11

No

Tabela 1.1 Modalidade de Frete


Entenda mais sobre como usar o frete aqui
Valor

Descrio

Correios

Frete fixo

Frete grtis

Retirar em mos/loja

Sem cobrana de frete (servios ou produtos digitais)

Tabela 1.2 Tipo de produto


Valor

Descrio

Material fsico

Digital

Servio

Tabela 1.3 Tipo de desconto


Valor

Descrio

Valor (Em centavos)

Percentual (Nmero Inteiro)

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:

Telefone: (21)2111-4732/ (11) 3320-9050

Pgina 7 de 31

MeuCheckout - Manual do Desenvolvedor

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

O seu cdigo deve seguir desta maneira:

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

Telefone: (21)2111-4732/ (11) 3320-9050

Pgina 8 de 31

MeuCheckout - Manual do Desenvolvedor

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

Shipping_Address_Name: (Obrigatorio se frete


fixo ou gratis e se Shipping_Zipcode enviado)
Shipping_Address_Number: (Obrigatorio se
frete fixo ou gratis e se Shipping_Zipcode enviado)

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)

Telefone: (21)2111-4732/ (11) 3320-9050

Pgina 9 de 31

MeuCheckout - Manual do Desenvolvedor

Shipping_Address_City: (Obrigatorio se frete fixo


ou gratis e se Shipping_Zipcode enviado)
Shipping_Address_State (Obrigatorio se frete
fixo ou gratis e se Shipping_Zipcode enviado)

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.

No trabalho com cobrana de frete:


Voc deve passar no campo SHIPPING_TYPE o valor 5.
No preciso mandar os Dados de Frete.
MeuCheckout no apresentar nenhuma informao sobre frete e no
solicitar endereo de entrega.

Telefone: (21)2111-4732/ (11) 3320-9050

Pgina 10 de 31

MeuCheckout - Manual do Desenvolvedor

Cliente retira em mos os produtos:


Neste caso, voc deve passar no campo SHIPPING_TYPE o valor 4.
No precisa mandar os Dados de Frete.
O MeuCheckout apresentar junto ao valor total da compra o campo
Retirar na loja.

Clculo de frete Prprio:


Voc deve passar no campo SHIPPING_TYPE o
valor 2.
Nessa opo, valor total da compra ( Valor da
compra + Frete definido pelo lojista ) deve ser
enviado. O comprador no ter a opo de
escolha de frete, e o valor do frete ser incluido
diretamente no carrinho.

Clculo de frete Prprio + Opo de frete


extra:
Voc deve passar no campo SHIPPING_TYPE o
valor 1.
E obrigatrio o envio dos Dados do Frete, com o
valor do mesmo.
possvel passar 1 ou mais opes de frete, elas
sero apresentadas ao consumidor para sua
escolha. O valor selecionado pelo Consumidor ser
adicionado ao valor total da compra.

Telefone: (21)2111-4732/ (11) 3320-9050

Pgina 11 de 31

MeuCheckout - Manual do Desenvolvedor

Contrato com os Correios prprio:


Neste caso, voc deve passar no campo SHIPPING_TYPE o valor 1 e deve configurar no Backoffice os seu nmero
de contrato com os Correios.
O MeuCheckout usar este nmero de contrato para fazer o clculo de frete, utilizando assim a tabela de frete que
voc possui acordado junto aos Correios. O MeuCheckout apresentar todas as opes de frete dos Correios
(Sedex, Sedex 10, Sedex Hoje e PAC, e qualquer outra que ele disponibilize pelo servio futuramente) para o
consumidor escolher, de acordo com o CEP de destino digitado.
O valor selecionado pelo Consumidor ser adicionado ao valor total da compra.

Usar o clculo de frete dos Correios do MeuCheckout


Neste caso, voc deve passar no campo SHIPPING_TYPE o valor 1, o MeuCheckout usar a tabela padro dos
Correios para fazer o clculo do frete.
O MeuCheckout apresentar todas as opes de frete dos Correios (Sedex, Sedex 10, Sedex Hoje e PAC, e
qualquer outra que ele disponibilize pelo servio futuramente) para o consumidor escolher, de acordo com o CEP
de destino digitado.
O valor selecionado pelo Consumidor ser adicionado ao valor total da compra.

Telefone: (21)2111-4732/ (11) 3320-9050

Pgina 12 de 31

MeuCheckout - Manual do Desenvolvedor

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.

Exemplo de consumo via Post


Segue abaixo um exemplo de consumo via post, e como a tela se apresentaria para este caso.

<form action="https://www.meucheckout.com.br/Transactional/Order/Index" method="post">


<input type="hidden" name="merchant_id" value="00000000-0000-0000-000000000000" />
<input type="hidden" name="order_number" value="0000000000" />
<input type="hidden" name="shipping_type" value="1" />
<input type="hidden" name="cart_1_name" value="Camiseta Branca" />
<input type="hidden" name="cart_1_unitprice" value="8000" />
<input type="hidden" name="cart_1_quantity" value="2" />
<input type="hidden" name="cart_1_weight" value="1000" />
<input type="hidden" name="cart_1_zipcode" value="20020080" />
<input type="hidden" name="cart_1_type" value="1" />
<input type="hidden" name="cart_2_name" value="Bermuda xadrez" />
<input type="hidden" name="cart_2_unitprice" value="9500" />
<input type="hidden" name="cart_2_quantity" value="1" />
<input type="hidden" name="cart_2_weight" value="1000" />
<input type="hidden" name="cart_2_zipcode" value="20020080" />
<input type="hidden" name="cart_2_type" value="1" />
<input type="hidden" name="cart_3_name" value="Cinto lona" />
<input type="hidden" name="cart_3_unitprice" value="3000" />
<input type="hidden" name="cart_3_quantity" value="1" />
<input type="hidden" name="cart_3_weight" value="1000" />
<input type="hidden" name="cart_3_zipcode" value="20020080" />
<input type="hidden" name="cart_3_type" value="1" />
<input type="submit" value="Comprar" />
</form>

Telefone: (21)2111-4732/ (11) 3320-9050

Pgina 13 de 31

MeuCheckout - Manual do Desenvolvedor

5. INTEGRAO VIA BOTO MEUCHECKOUT COMPRAR


Integrao via Boto deve ser usada sempre que no houver um carrinho de compras a ser enviado ou quando
se deseja associar uma compra rpida direta a um produto, como uma promoo numa homepage pulando a etapa
do carrinho.
A integrao via boto tambm pode ser usada para enviar um e-mail marketing, ou uma cobrana via e-mail, ou
seja, adicionando o boto (HTML) referente ao produto/servio a ser comprado/pago. Ou sempre que desejar
disponibilizar uma venda rpida sem desenvolvimento algum.
Para utilizar este recurso, necessrio cadastrar o produto que deseja vender, suas informaes, e depois
simplesmente copiar o cdigo fonte gerado para este boto. Cada boto gerado serve somente para o
determinado produto.
A incluso dos produtos feita dentro do Backoffice, no menu de Produtos/Cadastrar Produto. Existem algumas
opes de botes a serem usadas, escolha a que mais lhe agrada.

URL Backoffice: www.meucheckout.com.br/Backoffice e logue-se com sua senha

Telefone: (21)2111-4732/ (11) 3320-9050

Pgina 14 de 31

MeuCheckout - Manual do Desenvolvedor

Abaixo seguem as informaes necessrias para cadastrar um produto.

Tabela 5 Parmetros para cadastro de produto


Parmetro

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

Indique se est vendendo um bem Material,


um Servio ou um bem Digital.
Para bens Digitais, no ser apresentada a
opo de tipo de Frete.

Sim

Cdigo de identificao do produto

50

No

Titulo do Produto

50

Sim

Descrio do Produto

255

Sim

11

14

Sim

Sim

Sim

Sim

Sim

Sim

Sim

Valor total do pedido em centavos (ex.:


R$1,00 = 100).
Escolher dentre uma das opes de Frete
(Correios, Frete Fixo, Frete Grtis, Retirar na
loja, Sem Cobrana).
Entenda mais sobre eles na seo de
Integrao via Post
Esse campo s aparece para o frete tipo
Correios, deve ser preenchido com o CEP de
onde vai partir a mercadoria para fins de
clculo de frete.
Esse campo s aparece para o frete tipo
Correios, deve ser preenchido com o peso do
produto em kg para fins de clculo de frete
Esse campo s aparece para o frete tipo Frete
Fixo, e deve ser preenchido com o valor que o
lojista especificar para seus produtos.
Esse campo s aparece para Tipo Produto
igual a Material Fsico e Tipo de Frete igual a
Frete Fixo.
Esse campo s aparece para Tipo Produto
igual a Digital.

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.

Cdigo gerado pelo boto, vai ser similar ao abaixo:


<form method='post' action='https://meucheckout.com.br/transactional/Checkout/BuyNow' target='blank'>
<input type='hidden' name='id' value=00000000-0000-0000-000000000000/>
<input type='image' name='submit' alt='Comprar' src='https:// meucheckout.com.br
/BackOffice/Content/images/botao_comprar_3.jpg' />
</form>

Telefone: (21)2111-4732/ (11) 3320-9050

Pgina 15 de 31

MeuCheckout - Manual do Desenvolvedor

O cdigo deve ser inserido dentro da rea adequada no seu HTML.


Cada boto possui um cdigo nico que s permite comprar aquele determinado produto nas condies de preo e
frete cadastrado. Portanto, um fraudador no consegue alterar nenhuma destas informaes na hora de submeter
a compra, pois o MeuCheckout vai buscar todos os dados do produto no cadastro do Backoffice, e valero os dados
do cadastro.

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.

Telefone: (21)2111-4732/ (11) 3320-9050

Pgina 16 de 31

MeuCheckout - Manual do Desenvolvedor

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.

Parmetros para integrao Post Url de Notificao


Parmetro

Descrio

Tipo do
Campo

Tamanho
Min
Max

Meucheckout_order_number

Identificador nico gerado pelo


MeuChekout.

Alfanumrico

32

Amount

Preo unitrio do produto, em centavos


(ex: R$ 1,00 = 100)

Numrico

10

Order_Number

Nmero do pedido enviado pela loja

Alfanumrico

32

created_date

Data da criao do pedido


(dd/MM/yyyy HH:mm:ss)

Alfanumrico

20

Customer_Name

Nome do consumidor.
Se enviado, esse valor j vem preenchido
na tela do MeuCheckout

Alfanumrico

289

Telefone: (21)2111-4732/ (11) 3320-9050

Pgina 17 de 31

MeuCheckout - Manual do Desenvolvedor

Customer_Identity

Identificao do consumidor (CPF ou CNPJ)


Se enviado, esse valor j vem preenchido
na tela do MeuCheckout

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

Valor do servio de frete, em centavos (ex:


R$ 10,00 = 1000)

Numrico

10

Shipping_address_zipcode

CEP do endereo de entrega

Numrico

Alfanumrico

64
64

Shipping_address_district

Estado do endereo de entrega

Shipping_address_city

Cidade do endereo de entrega

Alfanumrico

Shipping_address_line1

Endereo de entrega

Alfanumrico

256

Shipping_address_line2

Complemento do endereo de entrega

Alfanumrico

256

Shipping_address_number

Nmero do endereo de entrega

Numrico

Payment_method_type

Cd. do tipo de meio de pagamento


(vide tabela 2)

Numrico

Payment_method_brand

Bandeira (somente para transaes com


meio de pagamento carto de crdito)
(vide tabela 3)

Numrico

Payment_method_bank

Banco emissor (Para transaes de Boleto e


Dbito Automtico)
(vide tabela 4)

Numrico

Payment_maskedcredicard

Carto Mascarado (Somente para


transaes com meio de pagamento carto
de crdito)

Alfanumrico

20

Payment_installments

Nmero de parcelas

Numrico

Payment_antifrauderesult

Status das transaes de carto de Crdito


no Antifraude
(vide tabela 5)

Numrico

Payment_boletoexpirationdate

Data de vencimento para transaes


realizadas com boleto bancrio

Numrico

10

Payment_status

Status da transao
(vide tabela 6)

Numrico

1
2

URL Post de Notificao enviando nos seguintes cenrios:


Telefone: (21)2111-4732/ (11) 3320-9050

Pgina 18 de 31

MeuCheckout - Manual do Desenvolvedor

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).

8. URL DE MUDANA DE STATUS


Quando um pedido tiver seu status alterado, ser enviando um post para a URL de Mudana de Status,
previamente cadastrada no BackOffice.

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.

Telefone: (21)2111-4732/ (11) 3320-9050

Pgina 19 de 31

MeuCheckout - Manual do Desenvolvedor

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

Parmetros para integrao Post Url de Mudana de Status


Parmetro

Descrio

Tipo do
Campo

Tamanho
Min
Max

Meucheckout_order_number

Identificador nico gerado pelo


MeuChekout.

Alfanumrico

32

Amount

Preo unitrio do produto, em centavos


(ex: R$ 1,00 = 100)

Numrico

10

Order_Number

Nmero do pedido enviado pela loja

Alfanumrico

32

Payment_status

Status da transao
(vide tabela 6)

Numrico

Tabela 1 Modalidade de Frete

Valor

Descrio

Telefone: (21)2111-4732/ (11) 3320-9050

Pgina 20 de 31

MeuCheckout - Manual do Desenvolvedor

Correios

Frete fixo

Frete grtis

Retirar em mos/loja

Sem cobrana de frete (servios ou produtos digitais)

Tabela 2 Meio de Pagamento

Valor

Descrio

Carto de Crdito

Boleto Bancrio

Dbito Online

Carto de Dbito

Tabela 3 Bandeira

Valor

Descrio

Visa

Mastercad

AmericanExpress

Diners

Elo

Tabela 4 Banco Emissor

Valor

Descrio

Banco do Brasil

Bradesco

Tabela 5 Status AntiFraude

Valor

Descrio

Baixo Risco

Alto Risco

No Finalizado

Risco Moderado

Tabela 6 Status da Transao

Valor

Descrio

Pendente (Para todos os meios de pagamento)

Pago (Para todos os meios de pagamento)

Telefone: (21)2111-4732/ (11) 3320-9050

Pgina 21 de 31

MeuCheckout - Manual do Desenvolvedor

Negado (Somente para Carto Crdito)

Cancelado (Para cartes de crdito)

No Finalizado (Todos os meios de pagamento)

Autorizado (somente para Carto de Crdito)

9. MODO DE TESTE MEUCHECKOUT


O modo de teste MeuCheckout metodo de fazer testes de integrao do MeuCheckout com o seu site, sem o
consumo de crditos. O modo de Teste MeuCheckout permite realizar transaes, testando a integrao utilizando
diferentes meios de pagamento simulados
Ativao do Modo de Teste.
O modo de teste pode ser ativado na aba Configuraes:

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.

Telefone: (21)2111-4732/ (11) 3320-9050

Pgina 22 de 31

MeuCheckout - Manual do Desenvolvedor

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.

Telefone: (21)2111-4732/ (11) 3320-9050

Pgina 23 de 31

MeuCheckout - Manual do Desenvolvedor

Como transacionar no Modo de teste.


A realizao de transaes no modo de teste ocorre de forma normal. As informaes da transao so enviadas
via POST, utilizando os paramentros como descrito no topico

4. INTEGRAO VIA POST, entretanto, os meios de

pagamentos a serem usados sero meios simulados.


Para realizar transaes de teste com diferentes meios de pagamento, siga as seguintes regras:
Transaes com Carto de crdito:
Para testar cartes de crdito necessario que dois dados importantes sejam definidos, o status da autorizao do
carto e o retorno da analise de fraude.

Status da Autorizao do Carto de Crdito


Digito final do Carto

Status retornado

0, 1, 2, 3 ou 4

Autorizado

5, 6, 7, 8 ou 9

No autorizado

Telefone: (21)2111-4732/ (11) 3320-9050

Pgina 24 de 31

MeuCheckout - Manual do Desenvolvedor

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:

Retorno da Analise de fraude


Sobre nome do cliente

Nivel do Risco

Alto

Alto Risco

Moderado

Moderado

Baixo

Baixo Risco

Exemplo: Transao autorizada, Alto Risco;


Numero do Carto de credito: 5404434242930107
Nome do Cliente: Maria Alto
Boleto Bancario
Basta realzar o processo de compra normalmente sem nenhuma alterao no procedimento. O boleto gerado no
modo de teste sempre ser um boleto simulado.

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

Exemplo: Status no Autorizado.


Nome do Cliente: Maria Pereira

Telefone: (21)2111-4732/ (11) 3320-9050

Pgina 25 de 31

MeuCheckout - Manual do Desenvolvedor

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.

Telefone: (21)2111-4732/ (11) 3320-9050

Pgina 26 de 31

MeuCheckout - Manual do Desenvolvedor

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.

Telefone: (21)2111-4732/ (11) 3320-9050

Pgina 27 de 31

MeuCheckout - Manual do Desenvolvedor

10.FLUXOS DOS MEIOS DE PAGAMENTOS UTILIZADOS NO MEUCHECKOUT


Conhea abaixo os possveis status que cada pedido pode ter, de acordo com seu meio de pagamento.

Boleto

TRANSIO DE STATUS DE VENDAS POR BOLETO

Boleto Vencido
(processo automatico)

EXPIRADO

Boto Desfazer Conciliao


Boto Conciliar

PENDENTE

Boleto gerado

Boto Conciliar

PAGO

fim
fim

Boto Desfazer Conciliao

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.

Telefone: (21)2111-4732/ (11) 3320-9050

Pgina 28 de 31

MeuCheckout - Manual do Desenvolvedor

Carto de Crdito
TRANSIO DE STATUS DE VENDAS POR CARTO DE CRDITO

Autorizao Iniciada
Ainda sem confirmao da Cielo

NO AUTORIZADO

EXPIRADO

Transao negada pela Cielo

Autorizao feita a mais de 5 dias


(processo automatico)

PENDENTE

Transao Autorizada pela Cielo

AUTORIZADO

fim
fim

Boto Cancelar
Boto Capturar
Erro de processamento

NO FINALIZADO

PAGO

Boto Chargeback

fim
fim

Boto Cancelar

CANCELADO

Boto Capturar

CHARGEBACK

Recebendo uma Venda de Carto de Crdito


Pedidos vendidos por meio de carto de crdito sero includos no Backoffice como AUTORIZADO ou NO
AUTORIZADO, dependendo do resultado da autorizao na Cielo. Caso haja algum problema no processamento
deste pedido (consumidor fechou a tela, por exemplo), ele constar como NO FINALIZADO.

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.

Telefone: (21)2111-4732/ (11) 3320-9050

Pgina 29 de 31

MeuCheckout - Manual do Desenvolvedor

a.

Captura/Cancelamento manual

Concluindo uma Venda (captura ou cancelamento)


As vendas AUTORIZADAS aguardam uma deciso de confirmao ou cancelamento. E esta deciso deve vir em
conformidade com a anlise de fraude.
A confirmao da venda deve ser feita pelo boto
no Detalhe do Pedido, e seu status mudar para
PAGO. Esta venda ser ento confirmada (capturada) na Cielo.
E o cancelamento deve ser feito pelo boto
no Detalhe do Pedido, e seu status mudar para
CANCELADO. Esta venda ser ento cancelada (desfeita) na Cielo.
Ateno! Voc tem at 5 dias pra confirmar a venda! Caso isso no seja feito ela no ser mais vlida na Cielo, e o
limite reservado para sua loja/venda ser liberado. Este um procedimento padro para todas as lojas.
b.

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:

Vendas de Cartes de Crdito Expiradas


Conforme o prazo de confirmao da venda autorizada se acabar, seu pedido passar automaticamente para o
status EXPIRADO. Isso acontecer no sexto dia aps a data de autorizao (data do venda).
Estornando uma Venda
Caso a venda j tenha sido confirmada (status PAGO) ela pode ser ainda, futuramente, estornada. Para isso, basta
clicar no boto

no Detalhe do Pedido.

Recebimento de informao de Chargeback da Cielo


Seu cliente pode por algum motivo cancelar a compra diretamente com o banco emissor de seu carto de crdito.
Caso isso ocorra voc receber da Cielo um aviso de Chargeback de No Reconhecimento de compra. Ou caso
tenha havido uma compra com carto fraudado, voc recebera um aviso de Chargeback por Fraude.
Telefone: (21)2111-4732/ (11) 3320-9050

Pgina 30 de 31

MeuCheckout - Manual do Desenvolvedor

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.

, e seu status passar

Este aviso direto entre Cielo e Loja, no havendo interferncia do MeuCheckout.

Dbito Online

TRANSIO DE STATUS DE VENDAS POR DBITO ONLINE E VISA ELECTRON

Transao negada pelo Banco


Ou Visa Eletron

Transao iniciada

PENDENTE

Transao confirmada pelo Banco


Ou Visa Eletron

NO AUTORIZADO

PAGO

fim
fim

Sem retorno do Bankline/VisaEletron

Erro de processamento

NO FINALIZADO

Recebendo uma Venda de Dbito Online


Pedidos vendidos por meio de Dbito online sero includos no Backoffice como PENDENTE, PAGO, NO
AUTORIZADO ou NO FINALIZADO, dependendo do resultado da autorizao junto ao Banco.
Possiveis Status do Carto de Crdito
PENDENTES - Staus gerado quando o comprador ao finalizar o pedido e no obter resposta por parte do Banco,
ou seja, no conseguir nem carregar a pgina do Banco para inserir os dados para o Dbito.
PAGO - Staus gerado quando o comprador conseguir realizar o pagamento do dbito com sucesso.
NO AUTORIZADO - Staus gerado para o Lojista quando o comprador tentar realizar uma transao via dbito e
no teM saldo para a transao.
NO FINALIZADO Staus gerado para o Lojista caso o comprador tenha algum problema para finalizar o
pagamento do meio Dbito, seja fechando a janela do banco ou simplesmente no chegando tela do banco.

Telefone: (21)2111-4732/ (11) 3320-9050

Pgina 31 de 31

Das könnte Ihnen auch gefallen