Page tree
Skip to end of metadata
Go to start of metadata

Field

Description

Mandatory

Type

Example

Condition

ref

Order reference. This reference must be unique because it is used for control in duplicate request.
The \ character is forbidden.

Yes

AN50

12345678


origin

Type of order with the values : 

MO for mail order;
TO for telephon order;
Empty for all other cases.

No

AN3



country

Code of the country in which the order was done, see the list

Yes

AN2

FR


taxes

The amount of tax added to the order in the smallest currency unit
An amount of 1 € corresponds to 100

No

N12

100


amount

The amount of order in smallest unit of currency.

From version 28 of the API, this field must contain the amount to be authenticated.
An amount of 60 € corresponds to 6000

Yes

N12

6000

(warning)  From version 28  of the API, this field must contain the amount to be authenticated  (3DSV2)

currency

Currency code used for order. The ISO code :

978: euros 
840: US dollars

See complete list in  List of currencies

Yes

N3

978

date

The merchant order date.  Format : dd / mm / yyyy HH24: MI

Yes

AN16

07/04/2016 11:00

details

Information about the ordered items. The order details is limited to 100 items.

No

List of Objects 'OrderDetails'



deliveryTime

Delivery time : Values for deliveryTime

No

N

1


deliveryMode

Delivery method : Values for deliveryMode

No

N

4


deliveryChargeAmount of delivery charges in smallest unit of currency, example 250 for 2.50 eurosNoN
version 18 ou higher 
deliveryExpectedDate

Expected delivery date must be greater than the current date. Format: dd/mm/yyyy

Nodatetime07/04/2016Posted to Limonetik
deliveryExpectedDelayExpected delivery time (in days)NoN210Posted to Limonetik
discountAmountAmount of the discount for this order (in the same currency than the order)NoN12

version 21 or higher 

OTAPackageTypeType of package (flight only, journey+accomodation, …). See the table of values Codes - OTAPackageTypeNoN2

version 21 or higher 

OTADestinationCountryCountry code of the destination, in ISO 3166-1 format. See the table of values Codes - countryNoAN2

version 21 or higher 

bookingReferenceBooking reference or Id of the travel fileNoAN100

version 21 or higher 

orderDetailUsed only for origin = MO or TO. NoAN4

version 21 or higher 

orderExtended

More detail information about the order (for frictionless) : .

  • giftCardAmount:  indicates the giftcard amount  
  • giftCardCount : indicates the number of giftcard
  • reorderIndicator : indicates whether the cardholder is reordering previously purchased merchandise (Scoring CB) : 

         01 = First time ordered 
         02 = Reordered

NoAN
 Exemple..
{
"deliveryProvider": "deliveryProvider",
"riskLevel": "3",
"giftCardAmount": "4000",
"giftCardCurrency": "978",
"giftCardCount": "2",
"reorderIndicator": "01"
}

version 21 or higher (3DSV2)

orderOTA

Online Travel Agency information.


NoAN
 Exemple..
{
  "bookingDate": "2018-12-05",
  "agencyCode": "6565",
  "agencyName": "My Agency",
  "travelPurpose": "1",
  "countryDestination": "ANG",
  "transport": {  },
  "carRental": {...},
  "accomodation": {...}
}

transport : 

{
  "transportMode": "1",
  "travelerList": [...],
  "legList": [...]
}

travelersList :

 {
    "lastName": "France",
    "firstName": "Oliver",
    "birthDate": "1970-01-01",
    "legalDocumentType": "1",
    "legalDocument": "passeportId",
    "loyaltyMemberId": "123453453",
    "loyaltyMemberType": "4"
  },
  {
    "lastName": "France",
    "firstName": "Oliver",
    "birthDate": "1970-01-01",
    "legalDocumentType": "1",
    "legalDocument": "passeportId",
    "loyaltyMemberId": "4537884",
    "loyaltyMemberType": "4"
  }
legsList : 
  {
    "segment": "O",
    "ticketNumber": "T98374556",
    "ticketClass": "Economy",
    "isTicketRestricted": "N",
    "hasTicketInsurance": "N",
    "airlineCode": "LFT",
    "airlineName": "Lufthansa",
    "departureDate": "2019-01-24",
    "departureAirport": "MRS",
    "arrivalDate": "2019-01-25",
    "arrivalAirport": "SFO"
  },
  {
    "segment": "T1",
    "ticketNumber": "T98774556",
    "ticketClass": "Economy",
    "isTicketRestricted": "N",
    "hasTicketInsurance": "N",
    "airlineCode": "LFT",
    "airlineName": "Lufthansa",
    "departureDate": "2019-01-24",
    "departureAirport": "MRS",
    "arrivalDate": "2019-01-25",
    "arrivalAirport": "SFO"
  }
]

version 21 or higher