API Docs

Integration Flow

The diagrams below represent the communication flow between the client and ClearSale systems.


Diagram 1 - Process flow It is important to note that the process defined as Purchase Conclusion refers to the order status within the e-commerce store due to a decision returned by ClearSale. Whether the purchase is deceitful or not depends on the status according to the Status List.

integrationflow diagram 1


Diagram 2 – Request Sequence

integrationflow diagram 2

Methods

Authentication

All requests submitted to the ClearSale API must be authorized by an authenticated user. You will need an ApiKey, Client ID and Client Secret. If the user approves, then ClearSale provides your application with an access token.

Order

Send

This will send the orders to be analyze by ClearSale.

Signature: ResponseSend Send(RequestSend Auth)

EndPoint: https://integration.clearsale.com.br/api/order/send
SandBox: https://sandbox.clearsale.com.br/api/order/send

Status Active Return

The status active return is another available option to receive the status orders whose status was AMA or NVO, i.e., orders that were not in a final status.

As soon as a decision is made regarding an order (either approved or denied), the system can be configured to actively send (post) the new status to an endpoint. Important: this update only occurs if the order was manually analyzed.

The endpoint should be implemented to receive the object OrderStatus via POST in JSON format (Content type: application/json).

Error Handling

The ClearSale Integration API use HTTP response codes to indicate failure of request.
The responses include a message (ErrorMessage) detailing the nature of the error.

Http Code Description
400 An error that resulted from the provided information.
403 Invalid or Expired Token
500 Internal Error

Fingerprint

Mandatory Fingerprint Implementation

Objective

The purpose of using FingerPrinting technology is to enhance the fraud analysis capabilities.

This section details the required changes on the client website and web server for optimal product performance.

Profiling Script

Profiling script is responsible for loading the invisible objects responsible for gathering the profiling variables of the equipment used to browse the website. These objects will not change the appearance of the page where they are loaded.

It is recommended to insert this code in the checkout page or equivalent, just before the </body> tag.

According to the instructions on the code below, it is necessary to replaAccording to the instructions in the code below, it is necessary to replace the value UNIQUE_SESSION_ID for the unique session ID generated by the server. This session id must by alphanumeric (CHAR type) and have 128 bytes. The valid characters are numbers and letters, either uppercase or lowercase, underscore and hyphen ([a-z], [A-Z], [0-9], _, -).


				<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', 'ClientID'); 
				csdp('sessionid', 'UNIQUE_SESSION_ID'); 
				</script>
				

Mapper

Mandatory Mapper Implementation

Objective

ClearSale's Mapper is a script developed in JavaScript, which is responsible for monitoring the environment and interactions, recognizing navigation behavior patterns.

Script Deployment

  • The script must be included on each page where there are visits.
  • The script must be included just before </body> tag.


	<script>
	(function (a, b, c, d, e, f, g) {
		a['CsdmObject'] = 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/m/cs.js', 'csdm');
	csdm('app', 'APP_ID'); 
	</script>
	

Page Identification

For a better monitoring, navigation and analysis, it is important to be able to identify some pages, this increases our accuracy. Thus whenever possible, we strongly recommend using List of page types whenever possible.

The use of a <meta> tag inserted into the header of your html document is the simplest, and is the recommended way to identify pages. Below is an example of how to implement this homepage identification.


	<meta name="cs:page" content="home">
	

Below is an example of how to identify a page that allows details (List of page details).


	<meta name="cs:page" content="product">
	<meta name="cs:description" content="name=name of my product, sku=123456">
	

Where meta tags cannot be used for some technical reason or asynchronous calls (such as AJAX), we suggest using the manual mode of transmission. To use this mode you need to add one more line in the main script. Below is a complete example.


	<script>
	(function (a, b, c, d, e, f, g) {
		a['CsdmObject'] = 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/m/cs.js', 'csdm');

	csdm('app', 'APP_ID');
                                csdm('mode', 'manual'); 
	</script>
	

When the manual mode is enabled, information must be relayed to us using the methods bellow.


	<script type="text/javascript">
	// No identification send. 
	csdm('send'); 
	// Page identified send.
	csdm('send', 'home'); 
	// Page identified with details send.
	csdm('send', 'search', 'key-words=Celular 16GB, page-number=2'); 
	</script>
		
	

Appendix: Tables and Descriptions

RequestAuth

Name Description Type Size Required
Login Credentials Y

    {
        Login: {
            Apikey: “”,
            ClientID: “”,
            ClientSecret: “”
        }
    }
                            

ResponseAuth

Name Description Type Size Required
Token Access token AuthToken Y

    {
        Token: {
            Value: “”,
            ExpirationDate: “”
        }
    }
                            

RequestSend

Name Description Type Size Required
ApiKey   string   Y
LoginToken   string   Y
Orders   Order[]   Y
AnalysisLocation Location of Analysis ( “BRA” to Brazil and “USA” to United States) string   Y

    {
	    ApiKey: apiKey,
	    LoginToken: loginToken,
	    Orders: [
		    {
			    ID: "OS_1",
			    Date: "2015-01-15T18:25:43.511Z",
			    Email: "Testing@clearsale.com.br",
			    TotalItems: 100,
			    TotalOrder: 150,
			    TotalShipping: 50,
			    IP: "127.0.0.1",
			    Currency: "USD",
			    Payments :
			    [
				    {
					    Date: date,
					    Type: 2,
					    CardNumber: "4051814917994224",
					    CardHolderName: "TESTE T TESTE",
					    CardExpirationDate: "08/15",
					    Amount: 150,
					    PaymentTypeID: 1,
					    CardType: 1,
					    CardBin: "4051"
				    }
			    ],
			    BillingData :
			    {
				    ID: 45,
				    Type: 1,
				    BirthDate: date,
				    Gender: "M",
				    Name: "teste",
				    Email: "teste@teste.com",
				    Address :
				    {
					    Street: "Street Test",
					    City: "City Test",
					    State: "TS",
					    Comp: "2nd floor",
					    ZipCode: "01224020",
					    County: "Galway",
					    Number: "13"
				    },
				    Phones: [
					    {
						    Type: 1,
						    CountryCode: 55,
						    AreaCode: 11,
						    Number: "327811888"
					    }
				    ]
			    },
			    ShippingData :
			    {
				    ID: 45,
				    Type: 1,
				    Name: "teste",
				    Gender: "M",
				    Email: "teste@teste.com",
				    BirthDate: date,
				    Address :
				    {
					    Street: "teste",
					    City: "teste",
					    State: "CA",
					    Comp: "ap 703",
					    ZipCode: "01224020",
					    County: "teste",
					    Number: "12"
				    },
				    Phones: [
					    {
						    Type: 1,
						    CountryCode: "55",
						    AreaCode: "13",
						    Number: "32842656"
					    }
				    ]
			    },
			    Items: [
				    {
					    ProductId: 10,
					    ProductTitle: "Test 1",
					    Price: 50,
					    Category: "Toys",
					    Quantity: 1
				    },
				    {
					    ProductId: 11,
					    ProductTitle: "Test 2",
					    Price: 50,
					    Category: "Toys",
					    Quantity: 1
				    }
			    ],
			    SessionID: ""
		    }
	    ],
	    AnalysisLocation: "BRA",
	    Reanalysis: false
    }
                            

ResponseSend

Name Description Type Size Required
Orders   OrderStatus[]   Y
TransactionID   String   Y

    {
        Orders: [
            {
                ID: “”,
                Status:””,
                Score:””
            }
        ],
        TransactionID:"BRA"
    }
                            

RequestGet

Name Description Type Size Required
ApiKey   String   Y
LoginToken   String   Y
Orders   String[]   Y
AnalysisLocation   String   Y

    {
        ApiKey: “”,
        LoginToken: “”,
        Orders: [“”],
        AnalysisLocation:“”
    }
                            

ResponseGet

Name Description Type Size Required
Orders OrderStatus[] Y

    {
        Orders: [
            {
                ID: “”,
                Status:””,
                Score:””
            }
        ]
    }
                            

Credentials

Name Description Type Size Required
ApiKey   String   Y
ClientID   String   Y
ClientSecret   String   Y

    {
        Apikey: “”,
        ClientID: “”,
        ClientSecret: “”
    }
                            

AuthToken

Name Description Type Size Required
Value Token Value String   Y
ExpirationDate Token Expiration Date String   Y

    {
        Value: “”,
        ExpirationDate: “”
    }
                            

Order

Name Description Type Size Mandatory
ID Order Identification Code String 50 Y
Date Order Date DateTime (yyyy-mm-ddThh:mm:ss)   Y
Email Order e-Mail String 150 Y
TotalShipping Shipping Value Decimal (20,4) N
TotalItems Sum of Items Values Decimal (20,4) Y
TotalOrder Order total Value Decimal (20,4) Y
IP Order originating IP address String 50 Y
Obs Order comments String 8000 N
Currency Order currency String (Currency Codes)    
Status Order Status (see Incoming Status List*) String 3 N (if not set, default is New)
Payments Payment Data Payment[]   Y
ShippingData Shipping Data Person   Y
BillingData Billing Data Person   Y
Items Order Items Item[]   Y
CustomFields Custom Fields CustomFields[]   N
Reanalysis Indication whether this is an update to an existing order Boolean   N
Origin Order source String 150 Y

    {
	    ID: "OS_1",
	    Date: "2015-01-15T18:25:43.511Z",
	    Email: "Testing@clearsale.com.br",
	    TotalItems: 100,
	    TotalOrder: 150,
	    TotalShipping: 50,
	    IP: "127.0.0.1",
	    Currency: "USD",
	    Payments :
	    [
		    {
			    Date: date,
			    Type: 2,
			    CardNumber: "4051814917994224",
			    CardHolderName: "TESTE T TESTE",
			    CardExpirationDate: "08/15",
			    Amount: 150,
			    PaymentTypeID: 1,
			    CardType: 1,
			    CardBin: "4051"
		    }
	    ],
	    BillingData :
	    {
		    ID: 45,
		    Type: 1,
		    BirthDate: date,
		    Gender: "M",
		    Name: "teste",
		    Email: "teste@teste.com",
		    Address :
		    {
			    Street: "Street Test",
			    City: "City Test",
			    State: "TS",
			    Comp: "2nd floor",
			    ZipCode: "01224020",
			    County: "Galway",
			    Number: "13"
		    },
		    Phones: [
			    {
				    Type: 1,
				    CountryCode: 55,
				    AreaCode: 11,
				    Number: "327811888"
			    }
		    ]
	    },
	    ShippingData :
	    {
		    ID: 45,
		    Type: 1,
		    Name: "teste",
		    Gender: "M",
		    Email: "teste@teste.com",
		    BirthDate: date,
		    Address :
		    {
			    Street: "teste",
			    City: "teste",
			    State: "CA",
			    Comp: "ap 703",
			    ZipCode: "01224020",
			    County: "teste",
			    Number: "12"
		    },
		    Phones: [
			    {
				    Type: 1,
				    CountryCode: "55",
				    AreaCode: "13",
				    Number: "32842656"
			    }
		    ]
	    },
	    Items: [
		    {
			    ProductId: 10,
			    ProductTitle: "Test 1",
			    Price: 50,
			    Category: "Toys",
			    Quantity: 1
		    },
		    {
			    ProductId: 11,
			    ProductTitle: "Test 2",
			    Price: 50,
			    Category: "Toys",
			    Quantity: 1
		    }
	    ],
	    SessionID: ""
    }
                            

OrderStatus

Name Description Type Size Required
ID Order ID String   Y
Status Status of the order (status list) String   Y
Score Order fraud score    

    {
        ID: 11,
        Status: "APA",
        Score: 50.05,
    }
                            

Person

Name Description Type Size Mandatory
ID Customer Id String 50 Y
Type Person or Company (see Person or Company) Integer   Y
Name Customer Name String 500 Y
BirthDate BirthDate DateTime (yyyy-mm-ddThh:mm:ss)   N
Email Customer Email String 150 N
Gender Gender (see Gender) String 1 N
Address Address   Y
Phones Phone[]   Y

    {
	    ID: 45,
	    Type: 1,
	    Name: "teste",
	    Gender: "M",
	    Email: "teste@teste.com",
	    BirthDate: date,
	    Address:
	    {
		    Street: "teste",
		    City: "teste",
		    State: "CA",
		    Comp: "ap 703",
		    ZipCode: "01224020",
		    County: "teste",
		    Number: "12"
	    },
	    Phones: [
		    {
			    Type: 1,
			    CountryCode: "55",
			    AreaCode: "13",
			    Number: "32842656"
		    }
	    ]
    }
                            

Payment

Name Description Type Size Mandatory
Date Payment Date DateTime (yyyy-mm-ddThh:mm:ss)   Y
Amount Payment Value Numeric (20,4) Y
Type Payment Type (see Payment Method) Integer   Y
QtyInstallments Number of Installments Integer   N
CardNumber Credit Card Number String 200 N
CardBin Credit Card BIN (first 6 digits) String 6 N
CardEndNumber Last 4 digits of the credit card number String 4 N
CardType Credit Card (see Credit Card Type) Integer   N
CardExpirationDate Expiration Date String 50 N
CardHolderName Credit Card Holder String 150 N
Address Credit Card Billing Address Street (No Abbreviations) String 200 N
Nsu Unique Sequence Number – Credit Card Receipt Number String 50 N
Currency Currency Code (see Currency Codes) Integer 4 N

    { 
        Date: date,
        Type: 2,
        CardNumber: "4051814917994224",
        CardHolderName: "TESTE T TESTE",
        CardExpirationDate: "08/15",
        Amount: 150,
        PaymentTypeID: 1,
        CardType: 1,
        CardBin: "4051"
    }
                            

Item

Name Description Type Size Mandatory
ID Product ID String 50 Y
Name Product Name String 150 Y
ItemValue Unit Price Numeric (20,4) Y
Qty Quantity Purchased Integer   Y
Gift Gift Integer   N
CategoryID Product Category ID Integer   N
CategoryName Product Category Name String 200 N


{
        "ID": "SKU_ID",
        "Name": "",
        "ItemValue": 0.10,
        "Qty": 1,
        "Gift": 0,
        "CategoryID": 3,
        "CategoryName": ""
    }
                            

CustomFields

Name Description Type Size Mandatory
Type Number indicating the payment sequence Integer   N
Name Payment Date DateTime (yyyy-mm-ddThh:mm:ss)   Y
Value Payment Value Numeric (20,4) Y

    {
        Type: 1,
        Name: "",
        Value: ""
    }
                            

Address

Name Description Type Size Mandatory
AddressLine1 Address Line 1 (No abbreviations) String 250 N
AddressLine2 Address Line 2 (No abbreviations) String 250 N
City City (No abbreviations) String 150 Y
State State String 2 Y
Country Country (No abbreviations) String 150 N
ZipCode Zip Code String 10 Y

    {
        AddressLine1: "",
        AddressLine2: "",
        City: "",
        State: "",
        Country: "",
        ZipCode: ""
    }
                            

Phone

Name Description Type Size Mandatory
Type Telephone Type (see Telephone Type) Integer 1 Y
CountryCode Country Code Numeric 3 N
AreaCode Area Code Numeric 3 Y
Number Telephone Number Numeric 10 Y

    {
        Type: 1,
        CountryCode: 1,
        AreaCode: 1,
        Number: ""
    }
                            

ErrorMessage

Name Description Type Size Mandatory
Message Overview Message Integer 256 Y
MoedlState Message Details String[,]   N

    {
	    "Message": "The request is invalid.",
	    "ModelState":
	    {
		    "request.Orders[0]": ["An error has occurred."],
		    "request.Orders[0].Email": ["The Email field is not a valid e-mail address."]
	    }
    }
                            

Telephone Type

Code Description
0Undefined
1Home Phone
2Work Phone
3Messages
4Billing Phone
5Temporary Phone
6Mobile Phone

Person or Company

Code Description
1Person
2Company

Gender

Code Description
MMale
FFemale

Payment Method

Code Description
1Credit Card
2Payment Slip
3Banking Debt
6Electronic Funds Transfer
8Check
9Cash
10Financing
11Invoice
12Coupon
14Other

Credit Card Type

Code Description
1Diners
2MasterCard
3Visa
4Others
5American Express
6HiperCard
7Aura

Identification Document Type

Code Description
1CPF
2CNPJ
3RG
4IE
5Passport
6CTPS
7Voter ID Card

Status List

Code Description
APAAutomatic Approval – the order was automatically approved according to the rules defined.
APMManual Approval – the order was manually approved by a risk analyst
RPMDenied without prejudice – Order was denied with no indication of fraud. Usually due to impossibility of contact or invalid document.
AMAManual Analysis – the order was sent to a manual analysis queue.
ERRError – An error occurred during the integration. It is necessary to analyze the XML and resend after fixing it.
NVONew Order – the order was imported successfully and was not yet classified.
SUSFraud Suspicion – the order was denied due to a suspicion of fraud, usually based on contact with the customer or behavior registered in the ClearSale database.
CANCustomer asked for cancellation– the customer asked an analyst to cancel the purchase
FRDConfirmed Fraud – The order was analyzed and, following contact made, the credit card company confirmed fraud or the owner of the credit card denied awareness of the purchase
RPAAutomatically Denied – the order was denied according to a pre-defined rule (not recommended)
RPPDenied by Policy – The order was denied due to a policy defined by ClearSale or the client

Incoming Status List*


*Attention: If an order is sent with a status, the order will be saved as history and will not be analyzed by ClearSale. Only orders with status 0 (NVO) or with no status will by analyzed

Status Description
NVONew
APMApproved
CANCancelled by Client
RPMDenied

Currency Codes

Currency Alphabetic Code Numeric Code
AfghaniAFN971
EuroEUR978
LekALL8
Algerian DinarDZD12
US DollarUSD840
EuroEUR978
KwanzaAOA973
East Caribbean DollarXCD951
No universal currency  
East Caribbean DollarXCD951
Argentine PesoARS32
Armenian DramAMD51
Aruban FlorinAWG533
Australian DollarAUD36
EuroEUR978
Azerbaijanian ManatAZN944
Bahamian DollarBSD44
Bahraini DinarBHD48
TakaBDT50
Barbados DollarBBD52
Belarussian RubleBYR974
EuroEUR978
Belize DollarBZD84
CFA Franc BCEAOXOF952
Bermudian DollarBMD60
NgultrumBTN64
Indian RupeeINR356
BolivianoBOB68
MvdolBOV984
US DollarUSD840
Convertible MarkBAM977
PulaBWP72
Norwegian KroneNOK578
Brazilian RealBRL986
US DollarUSD840
Brunei DollarBND96
Bulgarian LevBGN975
CFA Franc BCEAOXOF952
Burundi FrancBIF108
RielKHR116
CFA Franc BEACXAF950
Canadian DollarCAD124
Cape Verde EscudoCVE132
Cayman Islands DollarKYD136
CFA Franc BEACXAF950
CFA Franc BEACXAF950
Unidades de fomentoCLF990
Chilean PesoCLP152
Yuan RenminbiCNY156
Australian DollarAUD36
Australian DollarAUD36
Colombian PesoCOP170
Unidad de Valor RealCOU970
Comoro FrancKMF174
CFA Franc BEACXAF950
Congolese FrancCDF976
New Zealand DollarNZD554
Costa Rican ColonCRC188
CFA Franc BCEAOXOF952
Croatian KunaHRK191
Peso ConvertibleCUC931
Cuban PesoCUP192
Netherlands Antillean GuilderANG532
EuroEUR978
Czech KorunaCZK203
Danish KroneDKK208
Djibouti FrancDJF262
East Caribbean DollarXCD951
Dominican PesoDOP214
US DollarUSD840
Egyptian PoundEGP818
El Salvador ColonSVC222
US DollarUSD840
CFA Franc BEACXAF950
NakfaERN232
EuroEUR978
Ethiopian BirrETB230
EuroEUR978
Falkland Islands PoundFKP238
Danish KroneDKK208
Fiji DollarFJD242
EuroEUR978
EuroEUR978
EuroEUR978
CFP FrancXPF953
EuroEUR978
CFA Franc BEACXAF950
DalasiGMD270
LariGEL981
EuroEUR978
Ghana CediGHS936
Gibraltar PoundGIP292
EuroEUR978
Danish KroneDKK208
East Caribbean DollarXCD951
EuroEUR978
US DollarUSD840
QuetzalGTQ320
Pound SterlingGBP826
Guinea FrancGNF324
CFA Franc BCEAOXOF952
Guyana DollarGYD328
GourdeHTG332
US DollarUSD840
Australian DollarAUD36
EuroEUR978
LempiraHNL340
Hong Kong DollarHKD344
ForintHUF348
Iceland KronaISK352
Indian RupeeINR356
RupiahIDR360
SDR (Special Drawing Right)XDR960
Iranian RialIRR364
Iraqi DinarIQD368
EuroEUR978
Pound SterlingGBP826
New Israeli SheqelILS376
EuroEUR978
Jamaican DollarJMD388
YenJPY392
Pound SterlingGBP826
Jordanian DinarJOD400
TengeKZT398
Kenyan ShillingKES404
Australian DollarAUD36
North Korean WonKPW408
WonKRW410
Kuwaiti DinarKWD414
SomKGS417
KipLAK418
Latvian LatsLVL428
Lebanese PoundLBP422
LotiLSL426
RandZAR710
Liberian DollarLRD430
Libyan DinarLYD434
Swiss FrancCHF756
Lithuanian LitasLTL440
EuroEUR978
PatacaMOP446
DenarMKD807
Malagasy AriaryMGA969
KwachaMWK454
Malaysian RinggitMYR458
RufiyaaMVR462
CFA Franc BCEAOXOF952
EuroEUR978
US DollarUSD840
EuroEUR978
OuguiyaMRO478
Mauritius RupeeMUR480
EuroEUR978
ADB Unit of AccountXUA965
Mexican PesoMXN484
Mexican Unidad de Inversion (UDI)MXV979
US DollarUSD840
Moldovan LeuMDL498
EuroEUR978
TugrikMNT496
EuroEUR978
East Caribbean DollarXCD951
Moroccan DirhamMAD504
Mozambique MeticalMZN943
KyatMMK104
Namibia DollarNAD516
RandZAR710
Australian DollarAUD36
Nepalese RupeeNPR524
EuroEUR978
CFP FrancXPF953
New Zealand DollarNZD554
Cordoba OroNIO558
CFA Franc BCEAOXOF952
NairaNGN566
New Zealand DollarNZD554
Australian DollarAUD36
US DollarUSD840
Norwegian KroneNOK578
Rial OmaniOMR512
Pakistan RupeePKR586
US DollarUSD840
No universal currency  
BalboaPAB590
US DollarUSD840
KinaPGK598
GuaraniPYG600
Nuevo SolPEN604
Philippine PesoPHP608
New Zealand DollarNZD554
ZlotyPLN985
EuroEUR978
US DollarUSD840
Qatari RialQAR634
EuroEUR978
New Romanian LeuRON946
Russian RubleRUB643
Rwanda FrancRWF646
EuroEUR978
Saint Helena PoundSHP654
East Caribbean DollarXCD951
East Caribbean DollarXCD951
EuroEUR978
EuroEUR978
East Caribbean DollarXCD951
TalaWST882
EuroEUR978
DobraSTD678
Saudi RiyalSAR682
CFA Franc BCEAOXOF952
Serbian DinarRSD941
Seychelles RupeeSCR690
LeoneSLL694
Singapore DollarSGD702
Netherlands Antillean GuilderANG532
SucreXSU994
EuroEUR978
EuroEUR978
Solomon Islands DollarSBD90
Somali ShillingSOS706
RandZAR710
No universal currency  
South Sudanese PoundSSP728
EuroEUR978
Sri Lanka RupeeLKR144
Sudanese PoundSDG938
Surinam DollarSRD968
Norwegian KroneNOK578
LilangeniSZL748
Swedish KronaSEK752
WIR EuroCHE947
Swiss FrancCHF756
WIR FrancCHW948
Syrian PoundSYP760
New Taiwan DollarTWD901
SomoniTJS972
Tanzanian ShillingTZS834
BahtTHB764
US DollarUSD840
CFA Franc BCEAOXOF952
New Zealand DollarNZD554
Pa’angaTOP776
Trinidad and Tobago DollarTTD780
Tunisian DinarTND788
Turkish LiraTRY949
Turkmenistan New ManatTMT934
US DollarUSD840
Australian DollarAUD36
Uganda ShillingUGX800
HryvniaUAH980
UAE DirhamAED784
Pound SterlingGBP826
US DollarUSD840
US Dollar (Next day)USN997
US Dollar (Same day)USS998
US DollarUSD840
Uruguay Peso en Unidades Indexadas (URUIURUI)UYI940
Peso UruguayoUYU858
Uzbekistan SumUZS860
VatuVUV548
EuroEUR978
Bolivar FuerteVEF937
DongVND704
US DollarUSD840
US DollarUSD840
CFP FrancXPF953
Moroccan DirhamMAD504
Yemeni RialYER886
Zambian KwachaZMK894
Zimbabwe DollarZWL932
Bond Markets Unit European Composite Unit (EURCO)XBA955
Bond Markets Unit European Monetary Unit (E.M.U.-6)XBB956
Bond Markets Unit European Unit of Account 9 (E.U.A.-9)XBC957
Bond Markets Unit European Unit of Account 17 (E.U.A.-17)XBD958
UIC-FrancXFUNil
Codes specifically reserved for testing purposesXTS963
The codes assigned for transactions where no currency is involvedXXX999
GoldXAU959
PalladiumXPD964
PlatinumXPT962
SilverXAG961

List Types

ID Description
1Undefined
2Baby Shower
3Wedding List
4Wish list
5Anniversary/Birthday List
6Bridal Shower

List of Page Types

Code Description
home The initial or main web page of a website.
categoryPage with a list of products in a given category.
searchSearch results page.
productProduct description page.
cartShopping Cart Page
create-accountCreating account page
edit-accountEditing account page
password-resetPassword reset page
login-failLogin failed
contact-usContact Page
checkoutCheckout Page
purchase-confirmationPurchase Confirmation

List of Page Details

Code Keyword Description
productnameProduct Name
skuProduct SKU
searchkey-wordsSearch keywords
page-numberSearch page number.
fromThe origin of a flight ticket search.
toThe destination of a flight ticket search.
departureDeparture date for a flight ticket search
returnReturn date from a flight ticket search.
purchase-confirmationcodePurchase ID
payment-typePayment method (credit-card, debit-card, deposit,bank transfer, paypal, other)