1
Data
13/12/2012
16/05/2013
24/05/2013
14/10/2013
01/11/2013
17/06/2014
Descrição
Atualização do Documento
Inclusão do Serviço FingerPrint
Atualização do Documento
Atualização da URL da aplicação e especificação do
campo SessionID
Mudança na Obrigatoriedade de alguns campos
Inclusão do Fingerprint Clearsale
Responsável
Daniele Soares
Daniele Soares
Erasmo Sogabe
Daniele Soares
Daniele Soares
Sumário
1.
FLUXO DE INTEGRAÇÃO CLEARSALE ..................................................................................3
2. MÉTODOS............................................................................................................................ 4
2.1 IMPLEMENTAÇÃO OBRIGATÓRIA DO FINGERPRINT ........................................................................ 4
2.2 SENDORDERS .........................................................................................................................5
2.3 MÉTODOS DE RETORNO DE STATUS .............................................................................. 20
2.3.1 GETPACKAGESTATUS ............................................................................................................ 20
2.3.2 GETORDERSTATUS ............................................................................................................... 21
2.3.3 GETORDERSSTATUS.............................................................................................................. 21
2.4 GETANALYSTCOMMENTS .......................................................................................................... 23
ENDEREÇOS ........................................................................................ERRO! INDICADOR NÃO DEFINIDO.
3 APÊNDICE: TABELAS CÓDIGO E DESCRIÇÃO ....................................................................... 25
TIPO DE TELEFONE ........................................................................................................................ 25
TIPO DE PESSOA ........................................................................................................................... 25
TIPO DE SEXO ............................................................................................................................... 25
TIPO DE PAGAMENTO ..................................................................................................................... 25
BANDEIRA CARTÃO .......................................................................................................................26
TIPO IDENTIFICAÇÃO ......................................................................................................................26
LISTA DE STATUS .........................................................................................................................26
LISTA DE STATUS (DE ENTRADA)* .................................................................................................... 27
LISTA DE PRODUTOS ..................................................................................................................... 27
LISTA DE MOEDA ......................................................................................................................... 28
LISTA DE TIPOS DE LISTAS ..............................................................................................................34
2
O Fluxo de integração do ClearSale representará como a comunicação deve ser realizada entre o
cliente e a ClearSale.
Pedido realizado no
site da loja
Pedido enviado à
ClearSale via Web
Service
(SendOrders)
Status diferente de
AMA ou NVO?
Sim
Site da Loja
(Finalização da
Compra)
Sim
Não
Consultar o retorno
da análise via Web
Service (Métodos
Get’s)
Status diferente de
AMA ou NVO?
Não
Fim
O fluxo acima representa a integração do pedido com sucesso.
É de extrema importância ressaltar que o processo definido como Finalização da Compra referese que a compra deverá ser finalizada, pois houve um retorno definitivo por parte da ClearSale.
Porém se a compra será ou não liberada ao cliente dependerá do status retornado pelo ClearSale,
de acordo com a Listas de Status.
3
O objetivo é auxiliar na implantação da tecnologia de Device FingerPrint na integração com a
ClearSale e detalhar as alterações que devem ser feitas no website e no web server do cliente para
o perfeito funcionamento do produto.
Essas tags são responsáveis por carregar objetos invisíveis que não irão alterar o visual da página
onde estiverem inseridas. Estes objetos são responsáveis pelo processo de profiling da máquina
utilizada para acessar o site.
Recomenda-se utilizar este código na página de check out ou equivalente, antes da tag </BODY>.
Conforme instrução nos comentários abaixo, faz-se necessário substituir o UNIQUE_SESSION_ID
por um ID de sessão único gerado pelo seu web site. Esse ID de sessão deve ser do tipo CHAR, 128
bytes, e pode ser composto por letras maiúsculas ou minúsculas, dígitos, underscore ou hífen ([a
- z], [A - Z], 0 - 9, _, -).
<!-- Início das tags de profiling -->
<script src=" https://device.clearsale.com.br/v1.0.0/JS/FingerPrintLib.js" type="text/javascript">
</script>
<script type="text/javascript">
fp_lib_execute({ useIFrame: true, sessionId:"UNIQUE_SESSION_ID", key: "DEFAULT",
technologies: "100" } );
</script>
<img src="https://device.clearsale.com.br/v1.0.0/clearsale_logoweb_vert.png?SessionID=
UNIQUE_SESSION_ID" alt="" style="display:none!important" />
4
Este método é utilizado para enviar os pedidos a serem analisados pelo ClearSale.
Assinatura: xml SendOrders (string entityCode, string xml )
EntityCode: Este código é criado para que sua empresa seja identificada no sistema. Caso não
tenha recebido entre em contato com a equipe de integração ([email protected]).
O método recebe uma string com um XML no seguinte formato:
<ClearSale>
<Orders>
<Order>
<ID></ID>
<FingerPrint>
<SessionID></SessionID>
</FingerPrint>
<Date></Date>
<Email></Email>
<B2B_B2C></B2B_B2C>
<ShippingPrice></ShippingPrice>
<TotalItems></TotalItems>
<TotalOrder></TotalOrder>
<QtyInstallments></QtyInstallments>
<DeliveryTimeCD></DeliveryTimeCD>
<QtyItems></QtyItems>
<QtyPaymentTypes></QtyPaymentTypes>
<IP></IP>
<ShippingType></ShippingType>
<Gift></Gift>
<GiftMessage></GiftMessage>
<Obs></Obs>
<Status></Status>
<Reanalise></Reanalise>
<Origin></Origin>
<ReservationDate></ReservationDate>
<Country></Country>
<Nationality></Nationality>
<Product></Product>
<ListTypeID></ListTypeID>
<ListID></ListID>
<BillingData>
<ID></ID>
<Type></Type>
<LegalDocument1></LegalDocument1>
<LegalDocument2></LegalDocument2>
<Name></Name>
<BirthDate></BirthDate>
<Email></Email>
<Gender></Gender>
<Address>
<Street></Street>
5
<Number></Number>
<Comp></Comp>
<County></County>
<City></City>
<State></State>
<Country></Country>
<ZipCode></ZipCode>
<Reference></Reference>
</Address>
<Phones>
<Phone>
<Type></Type>
<DDI></DDI>
<DDD></DDD>
<Number></Number>
<Extension></Extension>
</Phone>
</Phones>
</BillingData>
<ShippingData>
<ID></ID>
<Type></Type>
<LegalDocument1></LegalDocument1>
<LegalDocument2></LegalDocument2>
<Name></Name>
<BirthDate></BirthDate>
<Email></Email>
<Gender></Gender>
<Address>
<Street></Street>
<Number></Number>
<Comp></Comp>
<County></County>
<City></City>
<State></State>
<Country></Country>
<ZipCode></ZipCode>
<Reference></Reference>
</Address>
<Phones>
<Phone>
<Type></Type>
<DDI></DDI>
<DDD></DDD>
<Number></Number>
<Extension></Extension>
</Phone>
</Phones>
</ShippingData>
<Payments>
<Payment>
<Sequential></Sequential>
<Date></Date>
<Amount></Amount>
<PaymentTypeID></PaymentTypeID>
<QtyInstallments></QtyInstallments>
<Interest></Interest>
<InterestValue></InterestValue>
<CardNumber></CardNumber>
<CardBin></CardBin>
<CardEndNumber></CardEndNumber>
<CardType></CardType>
<CardExpirationDate></CardExpirationDate>
6
<Name></Name>
<LegalDocument></LegalDocument>
<Address>
<Street></Street>
<Number></Number>
<Comp></Comp>
<County></County>
<City></City>
<State></State>
<Country></Country>
<ZipCode></ZipCode>
</Address>
<Nsu></Nsu>
<Currency></Currency>
</Payment>
</Payments>
<Items>
<Item>
<ID></ID>
<Name></Name>
<ItemValue></ItemValue>
<Qty></Qty>
<Gift></Gift>
<CategoryID></CategoryID>
<CategoryName></CategoryName>
</Item>
</Items>
<Passengers>
<Passenger>
<Name></Name>
<FrequentFlyerCard></FrequentFlyerCard>
<LegalDocumentType></LegalDocumentType>
<LegalDocument></LegalDocument>
<BirthDate></BirthDate>
</Passenger>
</Passengers>
<Connections>
<Connection>
<Company></Company>
<FlightNumber></FlightNumber>
<FlightDate></FlightDate>
<Class></Class>
<From></From>
<To></To>
<DepartureDate></DepartureDate>
<ArrivalDate></ArrivalDate>
</Connection>
</Connections>
<HotelReservations>
<HotelReservation>
<Hotel></Hotel>
<City></City>
<State></State>
7
<Country></Country>
<ReservationDate></ReservationDate>
<ReservationExpirationDate></ReservationExpirationDate>
<CheckInDate></CheckInDate>
<CheckOutDate></CheckOutDate>
</HotelReservation>
</HotelReservations>
</Order>
</Orders>
</ClearSale>
<ClearSale>
<Orders>
<Order>
<FingerPrint>
<SessionID></SessionID>
</FingerPrint>
<ID></ID>
<Date></Date>
<Email></Email>
<B2B_B2C></B2B_B2C>
<ShippingPrice></ShippingPrice>
<TotalItems></TotalItems>
<TotalOrder></TotalOrder>
<QtyInstallments></QtyInstallments>
<DeliveryTimeCD></DeliveryTimeCD>
<QtyItems></QtyItems>
<QtyPaymentTypes></QtyPaymentTypes>
<IP></IP>
<ShippingType></ShippingType>
<Gift></Gift>
<GiftMessage></GiftMessage>
<Obs></Obs>
<Status></Status>
<Reanalise></Reanalise>
<Origin></Origin>
<ReservationDate></ReservationDate>
<Country></Country>
<Nationality></Nationality>
<Product></Product>
<ListTypeID></ListTypeID>
<ListID></ListID>
Nome
Descrição
FingerPrint.SessionID Identificador único da
sessão do usuário
ID
Código do pedido
Date
Data do pedido
Email
Email do pedido
Tipo
Tamanho
Obrigatório
String
128
S
Texto
Data
(yyyy-mmddThh:mm:ss)
Texto
50
S
S
150
S
8
B2B_B2C
ShippingPrice
TotalItems
TotalOrder
QtyInstallments
DeliveryTimeCD
QtyItems
QtyPaymentTypes
IP
Gift
GiftMessage
Obs
Status
Reanalise
Origin
ReservationDate
Tipo do ecommerce
Valor do Frete
Valor do Itens
Valor Total do Pedido
Quantidade
de
Parcelas
Prazo de Entrega
Quantidade de Itens
Quantidade
de
Pagamentos
IP do Pedido
Identifica se o pedido
é presente
Mensagem
de
Presente
Observação
do
Pedido
Status do Pedido (na
entrada) (Lista de
status (de entrada)
Marcação que indica
se o pedido será
reanalisado ou não (1
caso for, 0 caso não)
Origem do Pedido
Data de reserva de
Voo
Texto
Decimal
Decimal
Decimal
Número
3
(20,4)
(20,4)
(20,4)
(1,0)
N
N
S
S
S
Texto
Número
Número
50
(1,0)
(1,0)
N
N
N
Texto
Número
(50)
(1,0)
S
N
Texto
8000
N
Texto
8000
N
Número
(1,0)
Número
(1,0)
N (se não for enviada a
tag o pedido entrará
como novo )
N
Texto
Data
(yyyy-mmddThh:mm:ss)
Texto
150
Texto
50
Country
Nome do País
Nationality
Nome
Nacionalidade
Product
ID do produto (Lista
de Produtos)
Número
4
ListTypeID
ID do tipo de lista
(Lista de Tipos de
Lista)
ID da lista na loja
Número
(1,0)
S
N(somente
empresas de
passagens aéreas)
N(somente
para
pedidos de análise
internacional)
N(somente
para
pedidos de análise
internacional)
N(somente
para
pedidos de análise
internacional
ou
clientes que utilizam
mais produtos da
ClearSale)
S
Texto
200
S
ListID
da
50
9
<BillingData>
<ID></ID>
<Type></Type>
<LegalDocument1></LegalDocument1>
<LegalDocument2></LegalDocument2>
<Name></Name>
<BirthDate></BirthDate>
<Email></Email>
<Gender></Gender>
<Address>
<Street></Street>
<Number></Number>
<Comp></Comp>
<County></County>
<City></City>
<State></State>
<Country></Country>
<ZipCode></ZipCode>
<Reference></Reference>
</Address>
<Phones>
<Phone>
<Type></Type>
<DDI></DDI>
<DDD></DDD>
<Number></Number>
<Extension></Extension>
</Phone>
</Phones>
</BillingData>
Nome
Descrição
ID
Type
Código do cliente
Pessoa Física ou Jurídica
(Lista de Tipos de Pessoa)
CPF ou CNPJ
RG ou Inscrição Estadual
Nome do cliente
Data de Nascimento
LegalDocument1
LegalDocument2
Name
BirthDate
Email
Gender
Address.Street
Address.Number
Address.Comp
Address.County
Address.City
Email
Sexo (Lista de Tipo de
Sexo)
Nome do logradouro (Sem
abreviações)
Número do Endereço
Complemento do Endereço
(Sem abreviações)
Bairro do Endereço (Sem
abreviações)
Cidade do Endereço (Sem
abreviações)
Tipo
Tamanho Obrigatório
Texto
Número
50
(1,0)
S
S
Texto
Texto
Texto
Data
(yyyy-mmddThh:mm:ss)
100
100
500
S
N
S
S
Texto
Texto
150
1
N
N
Texto
200
S
Texto
Texto
15
250
S
N
Texto
150
S
Texto
150
S
10
Address.State
Sigla do Estado do
Endereço - UF
Address.Country
Pais do Endereço (Sem
abreviações)
Address.ZipCode
CEP do Endereço
Address.Reference
Referência do Endereço
(Sem abreviações)
Phones.Phone.Type
Tipo de Telefone (Lista de
Tipo de Telefone)
Phones.Phone.DDI
DDI do Telefone
Phones.Phone.DDD
DDD do Telefone
Phones.Phone.Number
Número do Telefone
Phones.Phone.Extension Ramal do Telefone
Texto
2
S
Texto
150
N
Número
Texto
10
250
S
N
Número
1
S
Número
Número
Número
Texto
3
2
9
10
N
S
S
N
<ShippingData>
<ID></ID>
<Type></Type>
<LegalDocument1></LegalDocument1>
<LegalDocument2></LegalDocument2>
<Name></Name>
<BirthDate></BirthDate>
<Email></Email>
<Gender></Gender>
<Address>
<Street></Street>
<Number></Number>
<Comp></Comp>
<County></County>
<City></City>
<State></State>
<Country></Country>
<ZipCode></ZipCode>
<Reference></Reference>
</Address>
<Phones>
<Phone>
<Type></Type>
<DDI></DDI>
<DDD></DDD>
<Number></Number>
<Extension></Extension>
</Phone>
</Phones>
</ShippingData>
11
Nome
Descrição
ID
Type
Código do cliente
Pessoa Física ou Jurídica
(Lista de Tipos de Pessoa)
CPF ou CNPJ
RG ou Inscrição Estadual
Nome do cliente
Data de Nascimento
LegalDocument1
LegalDocument2
Name
BirthDate
Tipo
Tamanho
Obrigatório
Texto
Número
50
(1,0)
S
S
100
100
500
S
N
S
N
150
1
200
N
N
S
15
250
S
N
150
S
150
S
2
S
150
N
10
250
S
N
1
S
3
2
9
10
N
S
S
N
Texto
Texto
Texto
Data
(yyyy-mmddThh:mm:ss)
Email
Email
Texto
Gender
Sexo (Lista de Tipo de Sexo)
Texto
Address.Street
Nome do logradouro (Sem
Texto
abreviações)
Address.Number
Número do Endereço
Texto
Address.Comp
Complemento do Endereço
Texto
(Sem abreviações)
Address.County
Bairro do Endereço (Sem
Texto
abreviações)
Address.City
Cidade do Endereço (Sem
Texto
abreviações)
Address.State
Sigla do Estado do Endereço
Texto
- UF
Address.Country
Pais do Endereço (Sem
Texto
abreviações)
Address.ZipCode
CEP do Endereço
Número
Address.Reference
Referência do Endereço (Sem
Texto
abreviações)
Phones.Phone.Type
Tipo de Telefone (Lista de
Número
Tipo de Telefone)
Phones.Phone.DDI
DDI do Telefone
Número
Phones.Phone.DDD
DDD do Telefone
Número
Phones.Phone.Number
Número do Telefone
Número
Phones.Phone.Extension Ramal do Telefone
Texto
12
<Payments>
<Payment>
<Sequential></Sequential>
<Date></Date>
<Amount></Amount>
<PaymentTypeID></PaymentTypeID>
<QtyInstallments></QtyInstallments>
<Interest></Interest>
<InterestValue></InterestValue>
<CardNumber></CardNumber>
<CardBin></CardBin>
<CardEndNumber></CardEndNumber>
<CardType></CardType>
<CardExpirationDate></CardExpirationDate>
<Name></Name>
<LegalDocument></LegalDocument>
<Address>
<Street></Street>
<Number></Number>
<Comp></Comp>
<County></County>
<City></City>
<State></State>
<Country></Country>
<ZipCode></ZipCode>
</Address>
</Payment>
</Payments>
13
Nome
Descrição
Sequential
Sequencia de realização do
pagamento
Data do pagamento
Date
Amount
Valor
cobrado
neste
pagamento
PaymentTypeID
Tipo de Pagamento (Lista de
Tipos de Pagamento)
QtyInstallments
Quantidade de Parcelas
Interest
Taxa de Juros
InterestValue
Valor dos Juros
CardNumber
Número do Cartão
CardBin
Número do BIN do Cartão
CardEndNumber
4 últimos digitos do número de
cartão
CardType
Bandeira do Cartão (Lista de
Bandeiras de Cartão)
CardExpirationDate Data da Expiração
Name
Nome de Cobrança
LegalDocument
Documento da Pessoa de
Cobrança
Address.Street
Nome do logradouro (Sem
abreviações)
Address.Number
Número do Endereço
Address.Comp
Complemento do Endereço
(Sem abreviações)
Address.County
Bairro do Endereço (Sem
abreviações)
Address.City
Cidade do Endereço (Sem
abreviações)
Address.State
Sigla do Estado do Endereço UF
Address.Country
Pais do Endereço (Sem
abreviações)
Address.ZipCode
CEP do Endereço
Address.Reference Referência do Endereço (Sem
abreviações)
Nsu
Número identificador único de
uma transação de cartão
Currency
Código da moeda - (Tabela de
ID da Moeda)
Tipo
Número
Tamanho Obrigatório
(1,0)
Data
(yyyy-mmddThh:mm:ss)
N
S
Número
(20,4)
S
Número
(2,0)
S
Número
Número
Número
Texto
Texto
Texto
(2,0)
(4,2)
(20,4)
200
6
4
N
N
N
N
N
N
Número
(1,0)
N
Texto
Texto
Texto
50
150
100
N
N
N
Texto
200
N
Texto
Texto
15
250
N
N
Texto
150
N
Texto
150
N
Texto
2
N
Texto
150
N
Número
Texto
10
250
N
N
Texto
50
N
Número
4
N
14
Para empresas que no fluxo de venda o pedido será enviado a ClearSale antes do processamento definitivo
do pagamento é de extrema importância enviar o status do pagamento sendo Aprovado ou Reprovado.
A atualização do status do pagamento deve ser realizada no seguinte Web Service:
http://homologacao.clearsale.com.br/integracaov2/paymentintegration.asmx
http://www.clearsale.com.br/integracaov2/paymentintegration.asmx
Este método atualiza o status do pedido para o status do processamento do pagamento.
String UpdateOrderStatusID (string entityCode, string orderID, string statuspedido)
Código gerado pela ClearSale, que identifica a sua empresa em nosso sistema. Entre em
contato com nossa equipe de integração ([email protected]) caso não tenha recebido.
Código do Pedido a ser marcado.
Status de Pagamento que deve ser informado como Aprovado ou Reprovado.
O método retorna uma string XML com o seguinte formato:
<Order>
<ID></ID>
<Status> </Status>
<Score> </Score>
</Order>
A atualização somente ocorrerá para pedidos aprovados no ClearSale (APA ou APM), status diferentes de
aprovação não serão permitidos para atualizar o status de pagamento.
15
<Items>
<Item>
<ID></ID>
<Name></Name>
<ItemValue></ItemValue>
<Qty></Qty>
<Gift></Gift>
<CategoryID></CategoryID>
<CategoryName></CategoryName>
</Item>
</Items>
Nome
Descrição
ID
Name
ItemValue
Qty
Gift
CategoryID
CategoryName
Código do Produto
Nome do Produto
Valor Unitário
Quantidade
Presente
Código da Categoria do Produto
Nome da Categoria do Produto
Tipo
Texto
Texto
Número
Número
Número
Número
Texto
Tamanho Obrigatório
50
150
(20,4)
(1,0)
(1,0)
(1,0)
200
S
S
S
S
N
N
N
As seções abaixo Passangers e Connections somente são utilizadas em empresas de PASSAGENS
AÉREAS, caso não necessite utilizar esse metodos, favor omitir no XML.
Na seção Connections informar somente os dados de origem e destino, não informar as escalas e
conexões.
“Para um vôo entre São Paulo (Guarulhos) para Londres, via New York (JFK), você ira informar apenas
GRU-LHR, ao invés de GRU-JFK e JFK-LHR.”
<Passengers>
<Passenger>
<Name></Name>
<FrequentFlyerCard></FrequentFlyerCard>
<LegalDocumentType></LegalDocumentType>
<LegalDocument></LegalDocument>
<BirthDate></ BirthDate>
<Passenger>
</Passengers>
16
Nome
Descrição
Tipo
Name
Nome do Passageiro
FrequentFlyerCard
Cartão de Milhagem (Fidelidade)
LegalDocumentType Tipo de Documento de Identificação
Tamanho Obrigatório
Texto
Texto
Número
100
50
(1,0)
S
N
S
Texto
50
S
(Tipo Identificação)
LegalDocument
Número do Documento
BirthDate
Data de nascimento
Data
(yyyy-mmdd)
N
<Connections>
<Connection>
<Company></Company>
<FlightNumber></FlightNumber>
<FlightDate></FlightDate>
<Class></Class>
<From></From>
<To></To>
<DepartureDate></DepartureDate>
<ArrivalDate></ArrivalDate>
</Connection>
</Connections>
Nome
Descrição
Company
FlightNumber
FlightDate
Nome da Companhia Aérea
Número do Voo
Data do Voo
Class
From
To
DepartureDate
Classe do Assento
Origem
Destino
Data de Embarque
ArrivalDate
Data de Desembarque
Tipo
Tamanho
Obrigatório
Texto
Número
Data
(yyyy-mmddThh:mm:ss)
Texto
Texto
Texto
Data
(yyyy-mmddThh:mm:ss)
Data
(yyyy-mmddThh:mm:ss)
50
(6,0)
S
S
S
10
5
5
S
S
S
S
S
17
<HotelReservations>
<HotelReservation>
<Hotel></Hotel>
<City></City>
<State></State>
<Country></Country>
<ReservationDate></ReservationDate>
<ReservationExpirationDate></ReservationExpirationDate>
<CheckInDate></CheckInDate>
<CheckOutdate></CheckOutDate>
</HotelReservation>
</HotelReservations>
</Order>
</Orders>
</ClearSale>
Nome
Descrição
Hotel
City
Nome do Hotel
Cidade (sem
abreviações)
Estado (sem
abreviações)
País
Data da Reserva
State
Country
ReservationDate
Tipo
Tamanho
Obrigatório
Texto
Texto
200
150
S
S
Texto
150
S
150
(yyyy-mmddThh:mm:ss)
(yyyy-mmddThh:mm:ss)
(yyyy-mmddThh:mm:ss)
(yyyy-mmddThh:mm:ss)
S
S
Texto
Datetime
ReservationExpirationDate Data da Expiração da
Reserva
CheckInDate
Data da Chegada
Datetime
CheckOutDate
Datetime
Data da Saída
Datetime
S
S
S
O método retorna um string ( resposta ) no seguinte formato:
<ClearSale>
<PackageStatus>
<TransactionID></TransactionID>
<StatusCode></StatusCode>
<Message></Message>
<Orders>
<Order>
<ID></ID>
<Status></Status>
<Score></Score>
</Order>
</Orders>
</PackageStatus>
</ClearSale>
18
Descrição dos campos da string XML retornada pelo método SendOrders:
Campo
Tipo
Descrição
TransactionID
GUID
StatusCode
String
Message
ID
String
String
Status
Score
String
String
Identificador único para a transação (pacote) do pedido
enviado.
Código do erro ou da mensagem de sucesso referente à
transação.
Mensagem de erro ou de sucesso da operação.
O mesmo ID enviado no XML de entrada para identificação
do número do pedido é retornado neste campo.
Sigla do status do pedido.
Score do pedido.
Abaixo está a lista dos códigos retornados na TAG StatusCode:
Código
00
01
02
03
04
05
06
07
Descrição
Reenviar
Transação Concluída
Usuário Inexistente
Erro na validação do XML
Erro ao transformar XML
Erro Inesperado
Pedido já enviado ou não está em reanalise
Erro no Plugin de Entrada
Erro no Plugin de Saída
N
N
S
S
S
S
S
N
Verificar valores do Status no apêndice Lista de Status.
1 – Cada pacote (xml) deve ser limitado em no máximo 10 pedidos.
2 – Cuidado para não confundir Reenvio e Reanalise.
19
O reenvio do pedido deve ser feito quando ao tentar integrar o XML através do SendOrders e no XML de
retorno do método retornar um código de erro na tag StatusCode. Os códigos de erros são:
Código
02
03
04
05
06
Descrição
Reenviar
Erro na validação do XML
Erro ao transformar XML
Erro Inesperado
Pedido já enviado e não está em reanalise
OU Pedido não existe e está como
reanalise.
Erro no Plugin de Entrada
S
S
S
S
S
Caso retorne algum erro acima citado o XML enviado com os dados do pedido deve ser analisado para
identificar a causa deste erro e após corrigi-lo o pedido deve ser reenviado.
A tag reanalise, só deve ser marcada caso exista à importância de uma nova análise. Tendo em vista um
pedido, que tenha dado entrada no ClearSale, sem erros. Este comando é geralmente utilizado caso exista
a necessidade de mandar o pedido novamente com novas alterações nas informações, como por exemplo
a troca do número de telefone ou forma de pagamento.
A consulta do retorno de status deve ser realizada para os pedidos que foram integrados no ClearSale,
através do método SendOrders, e tiverem o status informado na TAG <Status> do XML de retorno como
AMA (Análise Manual) ou NVO (Novo).
Serão detalhados três métodos disponíveis para esta consulta.
2.3.1 GetPackageStatus
Este método é utilizado para recuperar o status atual dos pedidos no ClearSale, enviados em um pacote
de pedidos. Sendo assim, será possível recuperar o status de todos os pedidos de um determinado pacote
através do TransactionID.
Assinatura: xml GetPackageStatus (string entityCode, string packageID)
EntityCode: Código gerado pela Clear Sale, que identifica a sua empresa em nosso sistema. Entre em
contato com nossa equipe de integração ([email protected]), caso não tenha recebido.
PackageID: Código do pacote a ser consultado (retornado na tag TransactionID do XML de retorno do
método SendOrders).
20
O método retorna uma string XML com o seguinte formato:
<ClearSale>
<Orders>
<Order>
<ID></ID>
<Status></Status>
<Score></Score>
</Order>
</Orders>
</ClearSale>
2.3.2 GetOrderStatus
Este método é utilizado para recuperar o status atual dos pedidos no Clear Sale passando pedido a pedido.
Assinatura: xml GetOrderStatus (string entityCode, string orderID)
EntityCode: Código gerado pela Clear Sale, que identifica a sua empresa em nosso sistema. Entre em
contato com nossa equipe de integração ([email protected]) caso não tenha recebido.
OrderID: Código do Pedido a ser consultado.
O método retorna uma string XML com o seguinte formato:
<ClearSale>
<Orders>
<Order>
<ID></ID>
<Status></Status>
<Score></Score>
</Order>
</Orders>
</ClearSale>
2.3.3 GetOrdersStatus
Este método é utilizado para recuperar o status atual dos pedidos no Clear Sale passando uma lista de
pedidos num formato XML.
Assinatura: xml GetOrderStatus(string entityCode, string xml)
EntityCode: Código gerado pela Clear Sale que identifica a sua empresa em nosso sistema. Entre em
contato com nossa equipe de integração ([email protected]) caso não tenha recebido.
21
Xml: Xml no formato abaixo.
<ClearSale>
<Orders>
<Order>
<ID></ID>
</Order>
</Orders>
</ClearSale>
O método retorna uma string XML com o seguinte formato
<ClearSale>
<Orders>
<Order>
<ID></ID>
<Status></Status>
<Score></Score>
</Order>
</Orders>
</ClearSale>
O retorno ativo é outra opção disponibilizada pela ClearSale para obter o retorno de status do pedido que
estiver com status de AMA ou NVO, ou seja, pendente de análise de risco por parte da ClearSale.
O ClearSale após cada tomada de decisão em nosso sistema, poderá atuar como ativo no processo de
integração enviando um post com o status atual e definitivo do pedido. Porém, é importante ressaltar que
este retorno somente ocorrerá para pedidos que derivarem para a análise manual de risco, ou seja, pedidos
que tiverem a finalização automática como (APA, RPA, RPP) ou que foram aprovados por meio de liberação
em lote não serão retornado pelo modo ativo.
Para realizarmos o retorno ativo será necessário que o cliente desenvolva uma URL apta para receber um
post com o tipo determinado pelo cliente.
O sistema irá submeter os valores abaixo para uma URL especificada pelo cliente.
Tipo 1 (POST com Campos):
ID
Status
Score
Tipo 2 (POST com XML):
Formato XML
<ClearSale>
<ID></ID>
<Status></Status>
<Score></Score>
</ClearSale>
Para a configuração do retorno ativo é necessário enviar um e-mail para nossa equipe de integração
([email protected]) com a URL e o tipo de retorno definido.
Caso esta opção seja escolhida para o retorno de status sugerimos que também seja desenvolvida a
consulta via Web Service, através dos métodos de retorno. Pois, o sistema não irá checar problemas de
22
comunicação por parte do cliente. Caso a URL informada esteja indisponível, o sistema não tentará
submeter às informações novamente.
2.4 GetAnalystComments
Este método é utilizado para recuperar os comentários dos analistas inclusos nos pedidos.
Assinatura: xml GetAnalystComments (string entityCode, string OrderID, string getAll)
EntityCode: Código gerado pela Clear Sale que identifica a sua empresa em nosso sistema. Entre em
contato com nossa equipe de integração ([email protected]) caso não tenha recebido.
getAll: No parâmetro getAll o valor que deve ser inserido será : True ou False.
True quando desejar retornar todos os comentários inseridos no pedido.
False quando desejar retornar apenas o último comentário inserido no pedido.
OrderID: Código do Pedido a ser consultado.
O método retorna uma string XML com o seguinte formato:
<Order>
<ID></ID>
<Date d2p1:nil="true" xmlns:d2p1="http://www.w3.org/2001/XMLSchema-instance" />
<QtyInstallments d2p1:nil="true" xmlns:d2p1="http://www.w3.org/2001/XMLSchema-instance" />
<ShippingPrice d2p1:nil="true" xmlns:d2p1="http://www.w3.org/2001/XMLSchema-instance" />
<ShippingTypeID></ShippingTypeID>
<TotalItens></TotalItens>
<TotalOrder></TotalOrder>
<Status></Status>
<Reanalise></Reanalise>
<WeddingList d2p1:nil="true" xmlns:d2p1="http://www.w3.org/2001/XMLSchema-instance" />
<ReservationDate d2p1:nil="true" xmlns:d2p1="http://www.w3.org/2001/XMLSchema-instance" />
<ShippingData>
<Type d3p1:nil="true" xmlns:d3p1="http://www.w3.org/2001/XMLSchema-instance" />
<BirthDate d3p1:nil="true" xmlns:d3p1="http://www.w3.org/2001/XMLSchema-instance" />
<Phones />
<Address />
</ShippingData>
<CollectionData>
<Type d3p1:nil="true" xmlns:d3p1="http://www.w3.org/2001/XMLSchema-instance" />
<BirthDate d3p1:nil="true" xmlns:d3p1="http://www.w3.org/2001/XMLSchema-instance" />
<Phones />
<Address />
</CollectionData>
<Payments />
<Items />
<Passangers />
<Connections />
<AnalystComments>
<AnalystComments>
<CreateDate></CreateDate>
<Comments></Comments>
<UserName></UserName>
<Status></Status>
<LineName></LineName>
23
</AnalystComments>
</AnalystComments>
</Order>
Para enviar pedidos manualmente acesse a “URL” na Web Service informada abaixo, será necessário
informar o “EntityCode”, esse código é gerado pela ClearSale, para identificar a sua empresa em nosso
sistema.
Após o envio, também é possível acessar a “URL” da aplicação para verificar se o pedido foi recebido com
sucesso.
Caso não tenha recebido o “EntityCode” ou usuário da aplicação, entre em contato com nossa equipe de
integração ([email protected]).
Homologação
Web Service:
http://homologacao.clearsale.com.br/integracaov2/service.asmx
Aplicação:
http://aplicacao.homologacao.clearsale.com.br/Login.aspx
Produção
Web Service:
http://integracao.clearsale.com.br/service.asmx
Aplicação:
http://aplicacao.clearsale.com.br/Login.aspx
24
Tipo de Telefone
Código
0
1
2
3
4
5
6
Descrição
Não definido
Residencial
Comercial
Recados
Cobrança
Temporário
Celular
Código
1
2
Pessoa Física
Pessoa Jurídica
Código
M
F
Masculino
Feminino
Tipo de Pessoa
Descrição
Tipo de Sexo
Descrição
Tipo de Pagamento
Código
1
2
3
4
5
6
7
8
9
10
Descrição
Cartão de Crédito
Boleto Bancário
Débito Bancário
Débito Bancário – Dinheiro
Débito Bancário – Cheque
Transferência Bancária
Sedex a Cobrar
Cheque
Dinheiro
Financiamento
25
11
12
13
14
Fatura
Cupom
Multicheque
Outros
Bandeira Cartão
Código
Descrição
1
Diners
2
MasterCard
3
Visa
4
Outros
5
American Express
6
HiperCard
7
Aura
Tipo de Identificação
Código
Descrição
1
CPF
2
CNPJ
3
RG
4
IE
5
Passaporte
6
CTPS
7
Titulo Eleitor
Lista de Status
Código
APA
APM
RPM
AMA
ERR
NVO
Descrição
(Aprovação Automática) – Pedido foi aprovado automaticamente segundo parâmetros
definidos na regra de aprovação automática.
(Aprovação Manual) – Pedido aprovado manualmente por tomada de decisão de um
analista.
(Reprovado Sem Suspeita) – Pedido Reprovado sem Suspeita por falta de contato com
o cliente dentro do período acordado e/ou políticas restritivas de CPF (Irregular, SUS ou
Cancelados).
(Análise manual) – Pedido está em fila para análise
(Erro) - Ocorreu um erro na integração do pedido, sendo necessário analisar um possível
erro no XML enviado e após a correção reenvia-lo.
(Novo) – Pedido importado e não classificado Score pela analisadora (processo que roda
o Score de cada pedido).
26
SUS
CAN
FRD
RPA
RPP
(Suspensão Manual) – Pedido Suspenso por suspeita de fraude baseado no contato
com o “cliente” ou ainda na base ClearSale.
(Cancelado pelo Cliente) – Cancelado por solicitação do cliente ou duplicidade do pedido.
(Fraude Confirmada) – Pedido imputado como Fraude Confirmada por contato com a
administradora de cartão e/ou contato com titular do cartão ou CPF do cadastro que
desconhecem a compra.
(Reprovação Automática) – Pedido Reprovado Automaticamente por algum tipo de
Regra de Negócio que necessite aplicá-la (Obs: não usual e não recomendado).
(Reprovação Por Política) – Pedido reprovado automaticamente por política
estabelecida pelo cliente ou ClearSale.
Lista de Status (de entrada)*
*Atenção: Ao enviar o status no pedido é importante ressaltar que este pedido será incluso como
histórico e não será analisado pela ClearSale. Somente os pedidos que forem enviados com o status
0 – NVO ou que não tiverem o status definido que serão analisados pelo ClearSale.
Status
0
9
41
45
Descrição
Novo (será analisado pelo ClearSale)
Aprovado (irá ao ClearSale já aprovado e
não será analisado)
Cancelado pelo cliente (irá ao ClearSale já
cancelado e não será analisado)
Reprovado (irá ao ClearSale já reprovado e
não será analisado)
Lista de Produtos
ID
-1
1
2
3
4
5
6
7
8
9
10
11
Descrição
Outros
A-ClearSale
M-ClearSale
T-ClearSale
TG-ClearSale
TH-ClearSale
TG-LightClearSale
TG-FullClearSale
T-Monitorado
Score de Fraude
ClearID
Análise Internacional
27
Lista de Moeda
Currency
Afghani
Euro
Lek
Algerian Dinar
US Dollar
Euro
Kwanza
East Caribbean Dollar
No universal currency
East Caribbean Dollar
Argentine Peso
Armenian Dram
Aruban Florin
Australian Dollar
Euro
Azerbaijanian Manat
Bahamian Dollar
Bahraini Dinar
Taka
Barbados Dollar
Belarussian Ruble
Euro
Belize Dollar
CFA Franc BCEAO
Bermudian Dollar
Ngultrum
Indian Rupee
Boliviano
Mvdol
US Dollar
Convertible Mark
Pula
Norwegian Krone
Brazilian Real
US Dollar
Brunei Dollar
Bulgarian Lev
CFA Franc BCEAO
Burundi Franc
Riel
CFA Franc BEAC
Canadian Dollar
Cape Verde Escudo
Cayman Islands Dollar
CFA Franc BEAC
Alphabetic Code
AFN
EUR
ALL
DZD
USD
EUR
AOA
XCD
Numeric Code
971
978
008
012
840
978
973
951
XCD
ARS
AMD
AWG
AUD
EUR
AZN
BSD
BHD
BDT
BBD
BYR
EUR
BZD
XOF
BMD
BTN
INR
BOB
BOV
USD
BAM
BWP
NOK
BRL
USD
BND
BGN
XOF
BIF
KHR
XAF
CAD
CVE
KYD
XAF
951
032
051
533
036
978
944
044
048
050
052
974
978
084
952
060
064
356
068
984
840
977
072
578
986
840
096
975
952
108
116
950
124
132
136
950
28
CFA Franc BEAC
Unidades de fomento
Chilean Peso
Yuan Renminbi
Australian Dollar
Australian Dollar
Colombian Peso
Unidad de Valor Real
Comoro Franc
CFA Franc BEAC
Congolese Franc
New Zealand Dollar
Costa Rican Colon
CFA Franc BCEAO
Croatian Kuna
Peso Convertible
Cuban Peso
Netherlands Antillean Guilder
Euro
Czech Koruna
Danish Krone
Djibouti Franc
East Caribbean Dollar
Dominican Peso
US Dollar
Egyptian Pound
El Salvador Colon
US Dollar
CFA Franc BEAC
Nakfa
Euro
Ethiopian Birr
Euro
Falkland Islands Pound
Danish Krone
Fiji Dollar
Euro
Euro
Euro
CFP Franc
Euro
CFA Franc BEAC
Dalasi
Lari
Euro
XAF
CLF
CLP
CNY
AUD
AUD
COP
COU
KMF
XAF
CDF
NZD
CRC
XOF
HRK
CUC
CUP
ANG
EUR
CZK
DKK
DJF
XCD
DOP
USD
EGP
SVC
USD
XAF
ERN
EUR
ETB
EUR
FKP
DKK
FJD
EUR
EUR
EUR
XPF
EUR
XAF
GMD
GEL
EUR
950
990
152
156
036
036
170
970
174
950
976
554
188
952
191
931
192
532
978
203
208
262
951
214
840
818
222
840
950
232
978
230
978
238
208
242
978
978
978
953
978
950
270
981
978
29
Ghana Cedi
Gibraltar Pound
Euro
Danish Krone
East Caribbean Dollar
Euro
US Dollar
Quetzal
Pound Sterling
Guinea Franc
CFA Franc BCEAO
Guyana Dollar
Gourde
US Dollar
Australian Dollar
Euro
Lempira
Hong Kong Dollar
Forint
Iceland Krona
Indian Rupee
Rupiah
SDR (Special Drawing Right)
Iranian Rial
Iraqi Dinar
Euro
Pound Sterling
New Israeli Sheqel
Euro
Jamaican Dollar
Yen
Pound Sterling
Jordanian Dinar
Tenge
Kenyan Shilling
Australian Dollar
North Korean Won
Won
Kuwaiti Dinar
Som
Kip
Latvian Lats
Lebanese Pound
Loti
Rand
Liberian Dollar
Libyan Dinar
Swiss Franc
Lithuanian Litas
Euro
Pataca
Denar
Malagasy Ariary
GHS
GIP
EUR
DKK
XCD
EUR
USD
GTQ
GBP
GNF
XOF
GYD
HTG
USD
AUD
EUR
HNL
HKD
HUF
ISK
INR
IDR
XDR
IRR
IQD
EUR
GBP
ILS
EUR
JMD
JPY
GBP
JOD
KZT
KES
AUD
KPW
KRW
KWD
KGS
LAK
LVL
LBP
LSL
ZAR
LRD
LYD
CHF
LTL
EUR
MOP
MKD
MGA
936
292
978
208
951
978
840
320
826
324
952
328
332
840
036
978
340
344
348
352
356
360
960
364
368
978
826
376
978
388
392
826
400
398
404
036
408
410
414
417
418
428
422
426
710
430
434
756
440
978
446
807
969
30
Kwacha
Malaysian Ringgit
Rufiyaa
CFA Franc BCEAO
Euro
US Dollar
Euro
Ouguiya
Mauritius Rupee
Euro
ADB Unit of Account
Mexican Peso
Mexican Unidad de Inversion (UDI)
US Dollar
Moldovan Leu
Euro
Tugrik
Euro
East Caribbean Dollar
Moroccan Dirham
Mozambique Metical
Kyat
Namibia Dollar
Rand
Australian Dollar
Nepalese Rupee
Euro
CFP Franc
New Zealand Dollar
Cordoba Oro
CFA Franc BCEAO
Naira
New Zealand Dollar
Australian Dollar
US Dollar
Norwegian Krone
Rial Omani
Pakistan Rupee
US Dollar
No universal currency
Balboa
US Dollar
Kina
Guarani
Nuevo Sol
MWK
MYR
MVR
XOF
EUR
USD
EUR
MRO
MUR
EUR
XUA
MXN
MXV
USD
MDL
EUR
MNT
EUR
XCD
MAD
MZN
MMK
NAD
ZAR
AUD
NPR
EUR
XPF
NZD
NIO
XOF
NGN
NZD
AUD
USD
NOK
OMR
PKR
USD
454
458
462
952
978
840
978
478
480
978
965
484
979
840
498
978
496
978
951
504
943
104
516
710
036
524
978
953
554
558
952
566
554
036
840
578
512
586
840
PAB
USD
PGK
PYG
PEN
590
840
598
600
604
31
Philippine Peso
New Zealand Dollar
Zloty
Euro
US Dollar
Qatari Rial
Euro
New Romanian Leu
Russian Ruble
Rwanda Franc
Euro
Saint Helena Pound
East Caribbean Dollar
East Caribbean Dollar
Euro
Euro
East Caribbean Dollar
Tala
Euro
Dobra
Saudi Riyal
CFA Franc BCEAO
Serbian Dinar
Seychelles Rupee
Leone
Singapore Dollar
Netherlands Antillean Guilder
Sucre
Euro
Euro
Solomon Islands Dollar
Somali Shilling
Rand
No universal currency
South Sudanese Pound
Euro
Sri Lanka Rupee
Sudanese Pound
Surinam Dollar
Norwegian Krone
Lilangeni
Swedish Krona
WIR Euro
Swiss Franc
WIR Franc
Syrian Pound
New Taiwan Dollar
Somoni
Tanzanian Shilling
Baht
US Dollar
CFA Franc BCEAO
New Zealand Dollar
PHP
NZD
PLN
EUR
USD
QAR
EUR
RON
RUB
RWF
EUR
SHP
XCD
XCD
EUR
EUR
XCD
WST
EUR
STD
SAR
XOF
RSD
SCR
SLL
SGD
ANG
XSU
EUR
EUR
SBD
SOS
ZAR
608
554
985
978
840
634
978
946
643
646
978
654
951
951
978
978
951
882
978
678
682
952
941
690
694
702
532
994
978
978
090
706
710
SSP
EUR
LKR
SDG
SRD
NOK
SZL
SEK
CHE
CHF
CHW
SYP
TWD
TJS
TZS
THB
USD
XOF
NZD
728
978
144
938
968
578
748
752
947
756
948
760
901
972
834
764
840
952
554
32
Pa’anga
Trinidad and Tobago Dollar
Tunisian Dinar
Turkish Lira
Turkmenistan New Manat
US Dollar
Australian Dollar
Uganda Shilling
Hryvnia
UAE Dirham
Pound Sterling
US Dollar
US Dollar (Next day)
US Dollar (Same day)
US Dollar
Uruguay Peso en Unidades Indexadas (URUIURUI)
Peso Uruguayo
Uzbekistan Sum
Vatu
Euro
Bolivar Fuerte
Dong
US Dollar
US Dollar
CFP Franc
Moroccan Dirham
Yemeni Rial
Zambian Kwacha
Zimbabwe Dollar
Bond Markets Unit European Composite Unit
(EURCO)
Bond Markets Unit European Monetary Unit
(E.M.U.-6)
Bond Markets Unit European Unit of Account 9
(E.U.A.-9)
Bond Markets Unit European Unit of Account 17
(E.U.A.-17)
UIC-Franc
Codes specifically reserved for testing purposes
The codes assigned for transactions where no
currency is involved
Gold
Palladium
Platinum
Silver
TOP
TTD
TND
TRY
TMT
USD
AUD
UGX
UAH
AED
GBP
USD
USN
USS
USD
UYI
UYU
UZS
VUV
EUR
VEF
VND
USD
USD
XPF
MAD
YER
ZMK
ZWL
XBA
776
780
788
949
934
840
036
800
980
784
826
840
997
998
840
940
858
860
548
978
937
704
840
840
953
504
886
894
932
955
XBB
956
XBC
957
XBD
958
XFU
XTS
XXX
Nil
963
999
XAU
XPD
XPT
XAG
959
964
962
961
33
Tipos de Listas
ID
1
2
3
4
5
6
Descrição
Lista Não Cadastrada
Lista de Chá de Bebê
Lista de Casamento
Lista de Desejos
Lista de Aniversário
Lista de Chá Bar / Chá de Panela
34