Using addendum with itinerary data

Overview

Gate allows you to include so-called financial details addendum in your payment request you submit to the payment platform. The addendum data is widely used in travel industry and contains detailed booking and itinerary information such as booking number, hotel guest name(s) and check-in and check-out dates. The addendum data are submitted into the payment platform along with the payment request details. Usage of addendum data allows payment providers to make payments more secure and offer more competitive rates to merchants.

Payments with addendum data follow the general processing routine except for some specific requirements:

  • Not all MCCs are applicable Addendum data is used only in travel industry; that is why only merchants with the following MCC codes can initiate payments with hotel booking data: 3501–3999 and 7011.
  • Addendum data must always be included in the initial checkout request Any checkout that involves transmission of addendum data must start with a request that contains addendum data. Though, you may omit addendum data in any other requests you send to you payment provider. If you fail to send addendum data in the initial request, and then attempt to use addendum data in any of the subsequent messages, payment platform will refuse to process your request and will return an error message.

Addendum data may be used only in operations that use Visa and Mastercard cards.

All the booking itinerary information is included in a lodging object. The lodging object contains the general booking information while the information about hotel room and charges are included in its child objects room and charges object respectively.

Figure 1. Example of a JSON object lodging with hotel booking details
{
 "lodging": {
  "customer_service_toll_free_number": "18005553535", // Customer service phone 
  "guest_name": "John Smith",        // Guest name
  "check_in_date": "10-12-2019",     // Checkin date
  "check_out_date": "22-12-2019",    // Checkout date
  "folio_number": "56265655ABC",     // Booking ID
  "fire_safety_act_indicator": true, // Fire safety compliance indicator
  "room": {            // Object with the room details
  "rate": 12,                 // Daily room rate
  "number_of_nights": "12"    // Booked nights number
  },
  "charges": {            // Object with the charges details
  "transportation": 1200,       // Transportation charges
  "internet_access": 4500       //  Internet access charges
  }
 }
}

For more information about the lodging object parameters and child objects, see Addendum parameters in the Gate API and the specification of the Gate API at API.

Related links