Clearsale
Table of Contents
Clearsale – Device Fingerprint
O Device Fingerprint é um scprit em JavaScript que realiza coleta de dados e análise de informações públicas da máquina do usuário. Através desse recurso é possível identificar se uma máquina já é conhecida pela Clearsale e qual seu histórico de ações.
-
É necessário que o script esteja em somente uma única página do website.
-
É obrigatório a inclusão das tags do script ao final da página html, antes do fechamento da tag body. Pois o cumprimento desta recomendação garante que o website não sofra nenhum prejuízo de performance na integração.
O código que deverá ser incluído na página, antes da tag body, está abaixo:
<script>
(function (a, b, c, d, e, f, g){
a['CsdpObject'] = e; a[e] = a[e] || function () {
(a[e].q = a[e].q || []).push(arguments)
},
a[e].l = 1 * new Date(); f = b.createElement(c),
g = b.getElementsByTagName(c)[0]; f.async = 1; f.src = d;
g.parentNode.insertBefore(f, g)
})
(window, document, 'script', '//device.clearsale.com.br/p/fp.js','csdp');
csdp('app', 'seu_app');
csdp('sessionid', 'seu_id_de_sessao');
</script>
A Clearsale deverá informar qual valor deve ser utilizado na palavra sinalizada na variável “seu-app”. Ele serve para identificar o seu website em nosso sistema.
Já o valor a ser informador na variável “seu-id-de-sessao”, trata-se do id da sessão do usuário no website. Esta informação é extremamente relevante e deverá ser armazenada para um envio posterior.
Clearsale – t-Clearsale
A transação de fraude do t-Clearsale pode ser realizada utilizando ou não as tags “hotelReservation”, “airTravelInformation” e “itemList”, ou seja dá a flexibilidade que o estabelecimento necessita para transacionar os “n” tipos de negócio junto à maxiPago!.
Clearsale – URL de envio dos dados
SANDBOX: https://testapi.maxipago.net/UniversalAPI/postXML
PRODUÇÃO: https://api.maxipago.net/UniversalAPI/postXML
Clearsale – Exemplo de chamada de autorização utilizando as tags hotelReservation, airTravelInformation e itemList
<?xml version="1.0" encoding="UTF-8"?> <transaction-request> <version>3.1.1.15</version> <verification> <merchantId>store-id</merchantId> <merchantKey>secret-key</merchantKey> </verification> <order> <auth> <processorID>1</processorID> <referenceNum>CS-CASE-APPROVED-01</referenceNum> <fraudCheck>Y</fraudCheck> <billing> <name>Fulano Pedroso</name> <address>Av. Republica do Chile, 230</address> <address2>16 Andar</address2> <district>Braz de Pina</district> <city>Rio de Janeiro</city> <state>RJ</state> <postalcode>20031170</postalcode> <country>BR</country> <phone>2140099400</phone> <email>fulanodetal@email.com</email> <id>2546582</id> <type>Individual</type> <gender>M</gender> <birthDate>1982-03-08</birthDate> <phones> <phone> <phoneType>Commercial</phoneType> <phoneCountryCode>55</phoneCountryCode> <phoneAreaCode>11</phoneAreaCode> <phoneNumber>55554444</phoneNumber> <phoneExtension>B101</phoneExtension> </phone> <phone> <phoneType>Residential</phoneType> <phoneCountryCode>55</phoneCountryCode> <phoneAreaCode>11</phoneAreaCode> <phoneNumber>55554444</phoneNumber> <phoneExtension>B101</phoneExtension> </phone> </phones> <documents> <document> <documentType>CPF</documentType> <documentValue>259228370-60X</documentValue> </document> <document> <documentType>RG</documentType> <documentValue>12546785-2Y</documentValue> </document> </documents> </billing> <shipping> <name>Fulano de Tal</name> <address>Rua de Teste, 123</address> <city>São Paulo</city> <state>SP</state> <district>Braz de Pina</district> <postalcode>12345000</postalcode> <country>BR</country> <id>5557</id> <type>Individual</type> <gender>F</gender> <phones> <phone> <phoneType>Commercial</phoneType> <phoneCountryCode>55</phoneCountryCode> <phoneAreaCode>11</phoneAreaCode> <phoneNumber>55554444</phoneNumber> <phoneExtension>101</phoneExtension> </phone> <phone> <phoneType>Residential</phoneType> <phoneCountryCode>55</phoneCountryCode> <phoneAreaCode>11</phoneAreaCode> <phoneNumber>55554444</phoneNumber> <phoneExtension>101</phoneExtension> </phone> </phones> <documents> <document> <documentType>CPF</documentType> <documentValue>123456789-60Z</documentValue> </document> <document> <documentType>CTPS</documentType> <documentValue>123456789-60Z</documentValue> </document> </documents> </shipping> <fraudDetails> <fraudProcessorID>97</fraudProcessorID> <captureOnLowRisk>N</captureOnLowRisk> <voidOnHighRisk>N</voidOnHighRisk> <fraudToken>q1234564987981alksf43549138</fraudToken> <hotelReservations> <hotelReservation> <hotel>Hilton Hotel</hotel> <city>Sao Paulo</city> <state>SP</state> <country>BR</country> <reservationDate>2015-09-03 17:50:00</reservationDate> <reservationExpirationDate>2015-11-20 09:00:00</reservationExpirationDate> <checkInDate>2015-12-20 13:00:00</checkInDate> <checkOutDate>2016-01-05 18:00:00</checkOutDate> </hotelReservation> </hotelReservations> <airTravelInformation> <passengers> <passenger> <name>Pax Hum Test</name> <frequentFlyerCard>444555888-1</frequentFlyerCard> <documentType>CPF</documentType> <documentValue>123.456.789-01</documentValue> <birthDate>1982-03-08</birthDate> </passenger> <passenger> <name>Pax Dois Test</name> <frequentFlyerCard>444555888-2</frequentFlyerCard> <documentType>CPF</documentType> <documentValue>124.457.780-01</documentValue> <birthDate>1983-08-03</birthDate> </passenger> </passengers> <connections> <connection> <company>TAM</company> <flightNumber>8956</flightNumber> <flightDate>2015-12-20 10:00:00</flightDate> <class>Business</class> <from>GRU</from> <to>EZE</to> <departureDate>2015-12-20 10:00:00</departureDate> <arrivalDate>2015-12-20 11:25:00</arrivalDate> </connection> <connection> <company>TAM</company> <flightNumber>4946</flightNumber> <flightDate>2016-01-05 21:15:00</flightDate> <class>Business</class> <from>EZE</from> <to>GRU</to> <departureDate>2016-01-05 21:15:00</departureDate> <arrivalDate>2016-01-05 22:35:00</arrivalDate> </connection> </connections> </airTravelInformation> </fraudDetails> <transactionDetail> <payType> <creditCard> <number>4111111111111111</number> <expMonth>12</expMonth> <expYear>2016</expYear> <cvvNumber>123</cvvNumber> </creditCard> </payType> </transactionDetail> <payment> <chargeTotal>60.00</chargeTotal> <shippingTotal>0.00</shippingTotal> </payment> <itemList itemCount="2"> <item> <itemIndex>1</itemIndex> <itemProductCode>Produto de Teste Um</itemProductCode> <itemDescription>Certificação de Integração ClearSale</itemDescription> <itemQuantity>1</itemQuantity> <itemTotalAmount>10.00</itemTotalAmount> <itemUnitCost>10.00</itemUnitCost> </item> <item> <itemIndex>2</itemIndex> <itemProductCode>Produto de Teste Três</itemProductCode> <itemDescription>Certificação de Integração ClearSale</itemDescription> <itemQuantity>1</itemQuantity> <itemTotalAmount>10.00</itemTotalAmount> <itemUnitCost>10.00</itemUnitCost> </item> </itemList> </auth> </order> </transaction-request>
Clearsale – Exemplo de chamada de autorização sem a utilizando das tags hotelReservation, airTravelInformation e itemList
<?xml version="1.0" encoding="UTF-8"?> <transaction-request> <version>3.1.1.15</version> <verification> <merchantId>store-id</merchantId> <merchantKey>secret-key</merchantKey> </verification> <order> <fraud> <referenceNum>CS-CASE-FRAUDONLY-01</referenceNum> <billing> <name>Fulano de Tal</name> <address>Av. Paulista, 1728</address> <address2>7 Andar</address2> <district>Bela Vista</district> <city>Sao Paulo</city> <state>SP</state> <postalcode>01310200</postalcode> <country>BR</country> <phone>1140099400</phone> <email>fulanodetal@email.com</email> <id>2546582</id> <type>Individual</type> <gender>M</gender> <birthDate>1982-03-08</birthDate> <phones> <phone> <phoneType>Commercial</phoneType> <phoneCountryCode>55</phoneCountryCode> <phoneAreaCode>11</phoneAreaCode> <phoneNumber>55554444</phoneNumber> <phoneExtension>B101</phoneExtension> </phone> <phone> <phoneType>Residential</phoneType> <phoneCountryCode>55</phoneCountryCode> <phoneAreaCode>11</phoneAreaCode> <phoneNumber>55554444</phoneNumber> <phoneExtension>B101</phoneExtension> </phone> </phones> <documents> <document> <documentType>CPF</documentType> <documentValue>259228370-60X</documentValue> </document> <document> <documentType>RG</documentType> <documentValue>12546785-2Y</documentValue> </documents> </billing> <shipping> <name>Fulano de Tal</name> <address>Rua de Teste, 123</address> <district>Centro</district> <city>São Paulo</city> <state>SP</state> <postalcode>12345000</postalcode> <country>BR</country> <id>5557</id> <type>Individual</type> <gender>F</gender> <phones> <phone> <phoneType>Commercial</phoneType> <phoneCountryCode>55</phoneCountryCode> <phoneAreaCode>11</phoneAreaCode> <phoneNumber>55554444</phoneNumber> <phoneExtension>B101</phoneExtension> </phone> <phone> <phoneType>Residential</phoneType> <phoneCountryCode>55</phoneCountryCode> <phoneAreaCode>11</phoneAreaCode> <phoneNumber>55554444</phoneNumber> <phoneExtension>B101</phoneExtension> </phone> </phones> <documents> <document> <documentType>CPF</documentType> <documentValue>123456789-60Z</documentValue> </document> <document> <documentType>CTPS</documentType> <documentValue>123456789-60Z</documentValue> </document> </documents> </shipping> <fraudDetails> <fraudProcessorID>97</fraudProcessorID> <captureOnLowRisk>Y</captureOnLowRisk> <voidOnHighRisk>N</voidOnHighRisk> <fraudToken>q1234564987981alksf43549138</fraudToken> </fraudDetails> <transactionDetail> <payType> <creditCard> <number>4111111111111111</number> <expMonth>12</expMonth> <expYear>2016</expYear> <cvvNumber>123</cvvNumber> </creditCard> </payType> </transactionDetail> <payment> <chargeTotal>50.00</chargeTotal> <shippingTotal>0.00</shippingTotal> </payment> <itemList itemCount="2"> <item> <itemIndex>1</itemIndex> <itemProductCode>Produto de Teste Um</itemProductCode> <itemDescription>Certificaco de Integraaoo ClearSale</itemDescription> <itemQuantity>1</itemQuantity> <itemTotalAmount>30.00</itemTotalAmount> <itemUnitCost>30.00</itemUnitCost> </item> <item> <itemIndex>2</itemIndex> <itemProductCode>Produto de Teste Dois</itemProductCode> <itemDescription>Certifica de Integra ClearSale</itemDescription> <itemQuantity>1</itemQuantity> <itemTotalAmount>20.00</itemTotalAmount> <itemUnitCost>20.00</itemUnitCost> </item> </itemList> </fraud> </order> </transaction-request>
Clearsale – Exemplo de retorno da chamada de autorização com sucesso
<?xml version="1.0" encoding="UTF-8"?> <transaction-response> <authCode>123456</authCode> <orderID>0A011599:0157F782E170:EDA1:047AE51F</orderID> <referenceNum>CS-CASE-APPROVED-01</referenceNum> <transactionID>160882593</transactionID> <transactionTimestamp>1477326384</transactionTimestamp> <responseCode>0</responseCode> <responseMessage>1</responseMessage> <avsResponseCode>YYY</avsResponseCode> <cvvResponseCode>M</cvvResponseCode> <processorCode>A</processorCode> <processorMessage>APPROVED</processorMessage> <errorMessage/> <processorReferenceNumber>135792468</processorReferenceNumber> <creditCardCountry>US</creditCardCountry> <creditCardScheme>Visa</creditCardScheme> </transaction-response>
Clearsale – Exemplo de retorno da chamada de autorização com erro
<?xml version="1.0" encoding="UTF-8"?> <transaction-response> <authCode/> <orderID/> <referenceNum/> <transactionID/> <transactionTimestamp>1477326390128</transactionTimestamp> <responseCode>1024</responseCode> <responseMessage>INVALID REQUEST</responseMessage> <avsResponseCode/> <cvvResponseCode/> <processorCode/> <processorMessage/> <errorMessage>The transaction has an expired credit card.</errorMessage> <creditCardScheme>Visa</creditCardScheme> </transaction-response>
Clearsale – Tabela de parâmetros
|
Nome |
Obrigatório |
Tamanho |
Descrição |
|
version |
Sim |
11 |
Versão da API |
|
merchantId |
Sim |
20 |
Id de Loja que identifica o estabelecimento |
|
merchantKey |
Sim |
80 |
Chave associada ao ID da loja |
|
referenceNum |
Sim |
128 |
Identificador do pedido no estabelecimento |
|
processorID |
Sim |
2 |
Código da Adquirente que irá processar a transação SIMULADOR DE TESTES = 1 REDE = 2 GETNET = 3 CIELO = 4 e.REDE = 5 ELAVON = 6 CHASEPAYMENTECH = 8 STONE = 9 |
|
fraudCheck |
Não |
1 |
Flag para enviar transação para verificação de fraude. Se deixado em branco a transação será verificada
Y ou vazio/nulo = Checar N = Não Checar
Este campo só funciona para clientes que possuem o serviço de antifraude contratado. |
|
ipAddress |
Não |
16 |
Endereço de IP do comprador |
|
billing/id |
Sim |
50 |
ID do consumidor na base do lojista |
|
billing/name |
Sim |
64 |
Nome do cliente (somente alfabético) |
|
billing/address |
Sim |
128 |
Logradouro de cobrança da transação (sem acentos e caracteres especiais) |
|
billing/address2 |
Não |
128 |
Complemento do Logradouro de cobrança da transação (sem acentos e caracteres especiais) |
|
billing/district |
Sim |
64 |
Bairro (sem acentos e caracteres especiais) |
|
billing/city |
Sim |
64 |
Cidade (sem acentos e caracteres especiais) |
|
billing/state |
Sim |
32 |
Estado (enviado com 2 dígitos) |
|
billing/postalcode |
Sim |
16 |
CEP de Cobrança |
|
billing/country |
Sim |
64 |
País (Abreviação de 2 dígitos) |
|
billing/email |
Sim |
128 |
Utilização obrigatória de “@” |
|
billing/type |
Sim |
50 |
Use “Individual” para CPF e “Legal entity” para CNPJ |
|
billing/gender |
Sim |
1 |
Sexo (“M” ou “F) |
|
billing/birthDate |
Sim |
12 |
Data de nascimento (AAAA-MM-DD) |
|
phone/phoneType |
Sim |
50 |
Utilize um dos dados abaixo: – Residential – Commercial – Mobile – Fax – Undefined – Message – Billing |
|
document/documentType |
Sim |
50 |
Tipo de Documento. Utilize a lista abaixo: CPF RG CNPJ StateRegistration (não aplicado ao BR) MunicipalRegistration (não aplicado ao BR) Passport CTPS (Carteira de Trabalho – número PIS) VoterDocument (Título de Eleitor) |
|
document/documentValue |
Sim |
50 |
Número do documento |
|
fraudDetails/fraudProcessorID |
Não |
32 |
Envio do ProcessorID quando houver mais de um antifraude configurado na maxiPago! |
|
fraudDetails/captureOnLowRisk |
Não |
1 |
Permite realizar a captura de uma transação após aprovação (“Y” ou “N”) |
|
fraudDetails/voidOnHighRisk |
Não |
1 |
Permite cancelar (void) uma transação quando houver uma reprovação do antifraude via maxiPago! |
|
fraudDetails/fraudToken |
Sim |
150 |
Envio do SessionId da transação enviado no DeviceFingerprint na Kount ou ClearSale |
|
number |
Sim |
19 |
Número do cartão de crédito do cliente |
|
expMonth |
Sim |
2 |
Mês de vencimento do cartão com 2 dígitos |
|
expYear |
Sim |
4 |
Ano de vencimento do cartão com 4 dígitos |
|
cvvNumber |
Sim |
14 |
Código de segurança do cartão |
|
currencyCode |
Não |
3 |
Código da moeda da transação no formato ISO 4217 Válido somente para transações Chase Paymentech. |
|
chargeTotal |
Sim |
14.2 |
Valor do pedido |
|
shippingTotal |
Não |
14.2 |
Valor do frete que será cobrado. |
|
iataFee |
Não |
14.2 |
É um campo informativo (ou seja não é somado ao valor da autorização) que define o montante da Taxa de Embarque da transação que deve ser destinado ao pagamento à Infraero. No momento disponível para a Cielo nas bandeiras Visa e Mastercard. |
|
numberOfInstallments |
Não |
2 |
Número de parcelas da transação |
|
chargeInterest |
Não |
1 |
Define se o parcelamento é do tipo Loja ou Cartão Para transações à vista não enviar/enviar nulo. N = Sem juros (PADRÃO – parcelamento Loja) Y = Com juros (parcelamento Cartão) |
|
itemIndex |
Sim |
1 |
Itens: Enumerador do item de 1 a n |
|
itemProductCode |
Não |
50 |
Itens: Categoria do produto; Alfanumérico |
|
itemDescription |
Sim |
100 |
Itens: Descrição do Item; Alfanumérico |
|
itemQuantity |
Sim |
10 |
Itens: Quantidade deste item |
|
itemTotalAmount |
Sim |
19 |
Valor do Item. |
|
itemUnitCost |
Sim |
1 |
Valor do Item. |
|
hotel |
Sim |
200 |
Nome do Hotel |
|
city |
Sim |
64 |
Cidade da reserva realizada |
|
state |
Sim |
32 |
Estado (UF) da reserva realizada |
|
country |
Sim |
64 |
País de origem da reserva |
|
reservationDate |
Sim |
20 |
Data da reserva da hospedagem |
|
reservationExpirationDate |
Sim |
20 |
Data de expiração da reserva da hospedagem |
|
checkInDate |
Sim |
20 |
Data de entrada do cliente |
|
checkOutDate |
Sim |
20 |
Data de saída do cliente |
|
passenger/name |
Sim |
64 |
Nome do passageiro |
|
passenger/documentType |
Sim |
N/A |
Tipo de Documento. Utilize a lista abaixo: CPF RG CNPJ StateRegistration (não aplicado ao BR) MunicipalRegistration (não aplicado ao BR) Passport CTPS (Carteira de Trabalho – número PIS) VoterDocument (Título de Eleitor) |
|
passenger/documentValue |
Não |
N/A |
Valor do documento |
|
passenger/birthDate |
Não |
20 |
Data de nascimento do passageiro (AAAA-MM-DD) |
|
company |
Sim |
50 |
Companhia aérea utilizada (recomenda-se utilização da tabela IATA que pode ser encontrada na URL: www.iata.org/publications/pages/aircargo-tariff.aspx obrigatório caso a Tag seja enviada |
|
flightNumber |
Sim |
6 |
Número do vôo |
|
flightDate |
Sim |
20 |
Data do vôo (AAAA-MM-DDTHH:MM:SS) |
|
class |
Sim |
10 |
Classe de bônus para o bilhete emitido |
|
from |
Sim |
5 |
Origem do vôo (obrigatório o uso da tabela IATA de aeroportos www.iata.org/publications/pages/air-cargo-tariff.aspx) |
|
to
|
Sim |
5 |
Destino do vôo (obrigatório o uso da tabela IATA de aeroportos www.iata.org/publications/pages/air-cargo-tariff.aspx) |
|
departureDate |
Sim |
20 |
Data de embarque (AAAA-MM-DDTHH:MM:SS) |
|
arrivalDate |
Sim |
20 |
Data de chegada (AAAA-MM-DDTHH:MM:SS) |
Clearsale – Ticket Clearsale
A solução “Tickets” foi desenvolvida especificamente para a venda online de ingressos, em qualquer tipo de evento.
Clearsale – URL de envio dos dados
SANDBOX: https://testapi.maxipago.net/UniversalAPI/postXML
PRODUÇÃO: https://api.maxipago.net/UniversalAPI/postXML
Clearsale – Exemplo de chamada de autorização com Ticket Clearsale
<?xml version="1.0" encoding="UTF-8"?> <transaction-request> <version>3.1.1.15</version> <verification> <merchantId>store-id</merchantId> <merchantKey>secret-key</merchantKey> </verification> <order> <fraud> <processorID>1</processorID> <referenceNum>K20151109-03</referenceNum> <fraudCheck>Y</fraudCheck> <ipAddress>123.123.123.123</ipAddress> <billing> <id>2546582</id> <name>Fulano de Tal</name> <address>Av. Republica Livre, 230</address> <address2>16 Andar</address2> <district>Centro</district> <city>Sao Paulo</city> <state>SP</state> <postalcode>08021310</postalcode> <country>BR</country> <email>fulanodetal@email.com</email> <type>Individual</type> <gender>M</gender> <birthDate>1982-03-08</birthDate> <phones> <phone> <phoneType>Commercial</phoneType> <phoneCountryCode>55</phoneCountryCode> <phoneAreaCode>11</phoneAreaCode> <phoneNumber>55554444</phoneNumber> <phoneExtension>ramal 123</phoneExtension> </phone> <phone> <phoneType>Residential</phoneType> <phoneCountryCode>55</phoneCountryCode> <phoneAreaCode>11</phoneAreaCode> <phoneNumber>55554444</phoneNumber> <phoneExtension>ramal 345</phoneExtension> </phone> </phones> <documents> <document> <documentType>CPF</documentType> <documentValue>259228370-60</documentValue> </document> <document> <documentType>RG</documentType> <documentValue>12546785-2Y</documentValue> </document> </documents> </billing> <shipping> <id>OFFICE</id> <name>Fulana de Tal</name> <address>Rua de Teste, 123</address> <address2>16 Andar</address2> <district>Centro</district> <city>Sao Paulo</city> <state>SP</state> <postalcode>12345000</postalcode> <country>BR</country> <type>Individual</type> <gender>F</gender> <birthDate>1982-03-08</birthDate> <phones> <phone> <phoneType>Commercial</phoneType> <phoneCountryCode>55</phoneCountryCode> <phoneAreaCode>11</phoneAreaCode> <phoneNumber>55554444</phoneNumber> <phoneExtension>B101</phoneExtension> </phone> <phone> <phoneType>Residential</phoneType> <phoneCountryCode>55</phoneCountryCode> <phoneAreaCode>11</phoneAreaCode> <phoneNumber>55554444</phoneNumber> <phoneExtension>B101</phoneExtension> </phone> </phones> <documents> <document> <documentType>CPF</documentType> <documentValue>128856789-80</documentValue> </document> <document> <documentType>RG</documentType> <documentValue>123456789-60Z</documentValue> </document> </documents> </shipping> <fraudDetails> <fraudProcessorID>99</fraudProcessorID> <captureOnLowRisk>N</captureOnLowRisk> <voidOnHighRisk>N</voidOnHighRisk> <websiteId>MXP_DEV</websiteId> </fraudDetails> <tickets> <ticket_event> <convenienceFee>0.00</convenienceFee> <quantityFull>1</quantityFull> <quantityHalf>0</quantityHalf> <event> <id>ROCK15</id> <name>Rock in Rio 2015</name> <local>Rio de Janeiro</local> <date>2015-09-20 21:50:00</date> <quantityTicketSale>1050</quantityTicketSale> <quantityEventHouse>7</quantityEventHouse> </event> <people> <person> <name>John Rock One</name> <documentType>CPF</documentType> <documentValue>57558141710</documentValue> </person> </people> <categories> <category> <name>BASIC</name> <quantity>1</quantity> <unitAmount>10.00</unitAmount> </category> </categories> </ticket_event> </tickets> <payment> <chargeTotal>149.99</chargeTotal> <shippingTotal>10.00</shippingTotal> </payment> <itemList itemCount="3"> <item> <itemIndex>1</itemIndex> <itemProductCode>Product de Teste Um</itemProductCode> <itemDescription>Certificacao de Integracao 01</itemDescription> <itemQuantity>2</itemQuantity> <itemTotalAmount>30.00</itemTotalAmount> <itemUnitCost>15.00</itemUnitCost> </item> <item> <itemIndex>2</itemIndex> <itemProductCode>Produto de Teste Dois</itemProductCode> <itemDescription>Certificacao de Integracao 02</itemDescription> <itemQuantity>2</itemQuantity> <itemTotalAmount>10.00</itemTotalAmount> <itemUnitCost>5.00</itemUnitCost> </item> <item> <itemIndex>3</itemIndex> <itemProductCode>Produto de Teste Tres</itemProductCode> <itemDescription>Certificacao de Integracao 03</itemDescription> <itemQuantity>3</itemQuantity> <itemTotalAmount>99.99</itemTotalAmount> <itemUnitCost>33.33</itemUnitCost> </item> </itemList> </fraud> </order> </transaction-request>
Clearsale – Exemplo de retorno da chamada de autorização com sucesso do ticket Clearsale
<?xml version="1.0" encoding="UTF-8"?> <transaction-response> <authCode>123456</authCode> <orderID>0A011599:0157F782E170:EDA1:047AE51F</orderID> <referenceNum>CS-CASE-APPROVED-01</referenceNum> <transactionID>160882593</transactionID> <transactionTimestamp>1477326384</transactionTimestamp> <responseCode>0</responseCode> <responseMessage>1</responseMessage> <avsResponseCode>YYY</avsResponseCode> <cvvResponseCode>M</cvvResponseCode> <processorCode>A</processorCode> <processorMessage>APPROVED</processorMessage> <errorMessage/> <processorReferenceNumber>135792468</processorReferenceNumber> <creditCardCountry>US</creditCardCountry> <creditCardScheme>Visa</creditCardScheme> </transaction-response>
Clearsale – Exemplo de retorno da chamada de autorização com erro do ticket Clearsale
<?xml version="1.0" encoding="UTF-8"?> <transaction-response> <authCode/> <orderID/> <referenceNum/> <transactionID/> <transactionTimestamp>1477326390128</transactionTimestamp> <responseCode>1024</responseCode> <responseMessage>INVALID REQUEST</responseMessage> <avsResponseCode/> <cvvResponseCode/> <processorCode/> <processorMessage/> <errorMessage>The transaction has an expired credit card.</errorMessage> <creditCardScheme>Visa</creditCardScheme> </transaction-response>
Clearsale – Tabela de parâmetros
|
Nome |
Obrigatório |
Tamanho |
Descrição |
|
version |
Sim |
11 |
Versão da API |
|
merchantId |
Sim |
20 |
Id de Loja que identifica o estabelecimento |
|
merchantKey |
Sim |
80 |
Chave associada ao ID da loja |
|
referenceNum |
Sim |
128 |
Identificador do pedido no estabelecimento |
|
processorID |
Sim |
2 |
Código da Adquirente que irá processar a transação SIMULADOR DE TESTES = 1 REDE = 2 GETNET = 3 CIELO = 4 e.REDE = 5 ELAVON = 6 CHASEPAYMENTECH = 8 STONE = 9 |
|
fraudCheck |
Não |
1 |
Flag para enviar transação para verificação de fraude. Se deixado em branco a transação será verificada
Y ou vazio/nulo = Checar N = Não Checar
Este campo só funciona para clientes que possuem o serviço de antifraude contratado. |
|
ipAddress |
Não |
16 |
Endereço de IP do comprador |
|
billing/id |
Sim |
50 |
ID do consumidor na base do lojista |
|
billing/name |
Sim |
64 |
Nome do cliente (somente alfabético) |
|
billing/address |
Sim |
128 |
Logradouro de cobrança da transação (sem acentos e caracteres especiais) |
|
billing/address2 |
Não |
128 |
Complemento do Logradouro de cobrança da transação (sem acentos e caracteres especiais) |
|
billing/district |
Sim |
64 |
Bairro (sem acentos e caracteres especiais) |
|
billing/city |
Sim |
64 |
Cidade (sem acentos e caracteres especiais) |
|
billing/state |
Sim |
32 |
Estado (enviado com 2 dígitos) |
|
billing/postalcode |
Sim |
16 |
CEP de Cobrança |
|
billing/country |
Sim |
64 |
País (Abreviação de 2 dígitos) |
|
billing/email |
Sim |
128 |
Utilização obrigatória de “@” |
|
billing/type |
Sim |
50 |
Use “Individual” para CPF e “Legal entity” para CNPJ |
|
billing/gender |
Sim |
1 |
Sexo (“M” ou “F) |
|
billing/birthDate |
Sim |
12 |
Data de nascimento (AAAA-MM-DD) |
|
phone/phoneType |
Sim |
50 |
Utilize um dos dados abaixo: – Residential – Commercial – Mobile – Fax – Undefined – Message – Billing |
|
document/documentType |
Sim |
50 |
Tipo de Documento. Utilize a lista abaixo: CPF RG CNPJ StateRegistration (não aplicado ao BR) MunicipalRegistration (não aplicado ao BR) Passport CTPS (Carteira de Trabalho – número PIS) VoterDocument (Título de Eleitor) |
|
document/documentValue |
Sim |
50 |
Número do documento |
|
fraudDetails/fraudProcessorID |
Não |
32 |
Envio do ProcessorID quando houver mais de um antifraude configurado na maxiPago! |
|
fraudDetails/captureOnLowRisk |
Não |
1 |
Permite realizar a captura de uma transação após aprovação (“Y” ou “N”) |
|
fraudDetails/voidOnHighRisk |
Não |
1 |
Permite cancelar (void) uma transação quando houver uma reprovação do antifraude via maxiPago! |
|
fraudDetails/fraudToken |
Sim |
150 |
Envio do SessionId da transação enviado no DeviceFingerprint na Kount ou ClearSale |
|
number |
Sim |
19 |
Número do cartão de crédito do cliente |
|
expMonth |
Sim |
2 |
Mês de vencimento do cartão com 2 dígitos |
|
expYear |
Sim |
4 |
Ano de vencimento do cartão com 4 dígitos |
|
cvvNumber |
Sim |
14 |
Código de segurança do cartão |
|
currencyCode |
Não |
3 |
Código da moeda da transação no formato ISO 4217 Válido somente para transações Chase Paymentech. |
|
chargeTotal |
Sim |
14.2 |
Valor do pedido |
|
shippingTotal |
Não |
14.2 |
Valor do frete que será cobrado. |
|
iataFee |
Não |
14.2 |
É um campo informativo (ou seja não é somado ao valor da autorização) que define o montante da Taxa de Embarque da transação que deve ser destinado ao pagamento à Infraero. No momento disponível para a Cielo nas bandeiras Visa e Mastercard. |
|
numberOfInstallments |
Não |
2 |
Número de parcelas da transação |
|
chargeInterest |
Não |
1 |
Define se o parcelamento é do tipo Loja ou Cartão Para transações à vista não enviar/enviar nulo. N = Sem juros (PADRÃO – parcelamento Loja) Y = Com juros (parcelamento Cartão) |
|
itemIndex |
Sim |
1 |
Itens: Enumerador do item de 1 a n |
|
itemProductCode |
Não |
50 |
Itens: Categoria do produto; Alfanumérico |
|
itemDescription |
Sim |
100 |
Itens: Descrição do Item; Alfanumérico |
|
itemQuantity |
Sim |
10 |
Itens: Quantidade deste item |
|
itemTotalAmount |
Sim |
19 |
Valor do Item. |
|
itemUnitCost |
Sim |
1 |
Valor do Item. |
|
hotel |
Sim |
200 |
Nome do Hotel |
|
city |
Sim |
64 |
Cidade da reserva realizada |
|
state |
Sim |
32 |
Estado (UF) da reserva realizada |
|
country |
Sim |
64 |
País de origem da reserva |
|
reservationDate |
Sim |
20 |
Data da reserva da hospedagem |
|
reservationExpirationDate |
Sim |
20 |
Data de expiração da reserva da hospedagem |
|
checkInDate |
Sim |
20 |
Data de entrada do cliente |
|
checkOutDate |
Sim |
20 |
Data de saída do cliente |
|
passenger/name |
Sim |
64 |
Nome do passageiro |
|
passenger/documentType |
Sim |
N/A |
Tipo de Documento. Utilize a lista abaixo: CPF RG CNPJ StateRegistration (não aplicado ao BR) MunicipalRegistration (não aplicado ao BR) Passport CTPS (Carteira de Trabalho – número PIS) VoterDocument (Título de Eleitor) |
|
passenger/documentValue |
Não |
N/A |
Valor do documento |
|
passenger/birthDate |
Não |
20 |
Data de nascimento do passageiro (AAAA-MM-DD) |
|
company |
Sim |
50 |
Companhia aérea utilizada (recomenda-se utilização da tabela IATA que pode ser encontrada na URL: www.iata.org/publications/pages/aircargo-tariff.aspx obrigatório caso a Tag seja enviada |
|
flightNumber |
Sim |
6 |
Número do vôo |
|
flightDate |
Sim |
20 |
Data do vôo (AAAA-MM-DDTHH:MM:SS) |
|
class |
Sim |
10 |
Classe de bônus para o bilhete emitido |
|
from |
Sim |
5 |
Origem do vôo (obrigatório o uso da tabela IATA de aeroportos www.iata.org/publications/pages/air-cargo-tariff.aspx) |
|
to
|
Sim |
5 |
Destino do vôo (obrigatório o uso da tabela IATA de aeroportos www.iata.org/publications/pages/air-cargo-tariff.aspx) |
|
departureDate |
Sim |
20 |
Data de embarque (AAAA-MM-DDTHH:MM:SS) |
|
arrivalDate |
Sim |
20 |
Data de chegada (AAAA-MM-DDTHH:MM:SS) |
Clearsale – Reenvio de uma transação para análise
O método fraudResend pode ser utilizado para alterar qualquer dado de uma transação, exceto os dados de pagamento como dados de cartão e valores dos itens. Para a execução do mesmo é necessário o envio do OrderId para atrelar a transação a ser alterada. Mesmo que um OrderID seja uma transação de recorrência a alteração será refletida para o cadastro do comprador, porém não sobrescreve as capturas feitas em pagamentos no passado, ou seja, uma alteração cadastral ou em dados relacionados a um comprador será válida para a próxima Captura ou próxima Autorização de um determinado cliente.
Clearsale – URL de envio dos dados
SANDBOX: https://testapi.maxipago.net/UniversalAPI/postXML
PRODUÇÃO: https://api.maxipago.net/UniversalAPI/postXML
Clearsale – Exemplo de reenvio de uma transação para análise
<?xml version="1.0" encoding="UTF-8"?> <transaction-request> <version>3.1.1.15</version> <verification> <merchantId>store-id</merchantId> <merchantKey>secret-key</merchantKey> </verification> <order> <fraudResend> <orderID>C0A86315:0151642695C1:1EC8:2F12495A</orderID> <referenceNum>CS-CASE-APPROVED-DEC-02-01</referenceNum> <billing> <id>2546582</id> <name>Fulano Pedroso</name> <address>Av. Republica do Chile, 230</address> <address2>16 Andar</address2> <district>Braz de Pina</district> <city>Rio de Janeiro</city> <state>RJ</state> <postalcode>20031170</postalcode> <country>BR</country> <phone>2140099400</phone> <email>fulanodetal@email.com</email> <type>Individual</type> <gender>M</gender> <birthDate>1982-03-08</birthDate> <phones> <phone> <phoneType>Commercial</phoneType> <phoneCountryCode>55</phoneCountryCode> <phoneAreaCode>11</phoneAreaCode> <phoneNumber>55554444</phoneNumber> <phoneExtension>B101</phoneExtension> </phone> <phone> <phoneType>Residential</phoneType> <phoneCountryCode>55</phoneCountryCode> <phoneAreaCode>11</phoneAreaCode> <phoneNumber>55554444</phoneNumber> <phoneExtension>B101</phoneExtension> </phone> </phones> <documents> <document> <documentType>CPF</documentType> <documentValue>259228370-60X</documentValue> </document> <document> <documentType>RG</documentType> <documentValue>12546785-2Y</documentValue> </document> </documents> </billing> <shipping> <name>Fulano de Tal</name> <address>Rua de Teste, 123</address> <city>São Paulo</city> <state>SP</state> <district>Braz de Pina</district> <postalcode>12345000</postalcode> <country>BR</country> <id>5557</id> <type>Individual</type> <gender>F</gender> <phones> <phone> <phoneType>Commercial</phoneType> <phoneCountryCode>55</phoneCountryCode> <phoneAreaCode>11</phoneAreaCode> <phoneNumber>55554444</phoneNumber> <phoneExtension>101</phoneExtension> </phone> <phone> <phoneType>Residential</phoneType> <phoneCountryCode>55</phoneCountryCode> <phoneAreaCode>11</phoneAreaCode> <phoneNumber>55554444</phoneNumber> <phoneExtension>101</phoneExtension> </phone> </phones> <documents> <document> <documentType>CPF</documentType> <documentValue>123456789-60Z</documentValue> </document> <document> <documentType>CTPS</documentType> <documentValue>123456789-60Z</documentValue> </document> </documents> </shipping> <fraudDetails> <fraudProcessorID>97</fraudProcessorID> <captureOnLowRisk>N</captureOnLowRisk> <voidOnHighRisk>N</voidOnHighRisk> <fraudToken>q1234564987981alksf43549138</fraudToken> </fraudDetails> <hotelReservations> <hotelReservation> <hotel>Hilton Hotel</hotel> <city>Sao Paulo</city> <state>SP</state> <country>BR</country> <reservationDate>2015-09-03 17:50:00</reservationDate> <reservationExpirationDate>2015-11-20 09:00:00</reservationExpirationDate> <checkInDate>2015-12-20 13:00:00</checkInDate> <checkOutDate>2016-01-05 18:00:00</checkOutDate> </hotelReservation> </hotelReservations> <airTravelInformation> <passengers> <passenger> <name>Pax Hum Test</name> <frequentFlyerCard>444555888-1</frequentFlyerCard> <documentType>CPF</documentType> <documentValue>123.456.789-01</documentValue> <birthDate>1982-03-08</birthDate> </passenger> <passenger> <name>Pax Dois Test</name> <frequentFlyerCard>444555888-2</frequentFlyerCard> <documentType>CPF</documentType> <documentValue>124.457.780-01</documentValue> <birthDate>1983-08-03</birthDate> </passenger> </passengers> <connections> <connection> <company>TAM</company> <flightNumber>8956</flightNumber> <flightDate>2015-12-20 10:00:00</flightDate> <class>Business</class> <from>GRU</from> <to>EZE</to> <departureDate>2015-12-20 10:00:00</departureDate> <arrivalDate>2015-12-20 11:25:00</arrivalDate> </connection> <connection> <company>TAM</company> <flightNumber>4946</flightNumber> <flightDate>2016-01-05 21:15:00</flightDate> <class>Business</class> <from>EZE</from> <to>GRU</to> <departureDate>2016-01-05 21:15:00</departureDate> <arrivalDate>2016-01-05 22:35:00</arrivalDate> </connection> </connections> </airTravelInformation> </fraudResend> </order> </transaction-request>
Respostas de Fraude
A resposta da avaliação de fraude é retornada junto com a resposta da transação do cartão de crédito.
O valor do campo responseCode indicará o status da transação e o campo fraudScore trará o nível de risco para a transação, sendo 0 a mais segura e 99 a mais arriscada.
|
Valor |
Descrição |
Ação |
|
0 |
Transação APROVADA |
Nenhuma, pedido Aprovado |
|
1 |
Transação NEGADA pela Adquirente |
Nenhuma, pedido Negado |
|
2 |
Transação NEGADA: Transação DUPLICADA ou alto risco de FRAUDE |
Nenhuma, pedido Negado |
|
5 |
Transação EM REVISÃO: análise de FRAUDE |
Revisar pedido e executar ação manual no Portal: APROVAR ou NEGAR |
|
1024 |
Erro nos parâmetros enviados pelo lojista |
Revisar requisição |
|
2048 |
Erro interno na maxiPago! |
Contatar Suporte maxiPago! |
