Addendum parameters in the Gate API

This section describes the addendum data parameters of the itinerary that are submitted to the ECommPay payment platform along with the payment request details. You can use these parameters in messages you send to Gate. For each parameter, the following information is provided:

  • Name — name of the object or parameter;
  • Type — type of parameter;
  • Description — the itinerary information the parameter or object contains as well as parameter format and length or allowed values, if applicable.

All the amounts are denominated in the payment currency by using the minor currency units with no decimal point. For example, 100 USD is submitted as "10000".

Table 1. Addendum objects and parameters
Name Description tree

lodging
object, optional

This is a root object that contains general booking parameters and several child objects containing parameters of specific booking components, for example room properties or charge properties. 1

customer_service_toll_free_number
string, required

The customer service phone number used to resolve cardholder questions and disputes.

Alphanumeric, maximum 17 characters.

1-1 1

check_in_date
string, required

Cardholder check-in date in the dd-mm-yyyy format. 1-2 1

check_out_date
string, required

Cardholder check-out date in the dd-mm-yyyy format. 1-3 1

folio_number
string, required

The card acceptor’s internal invoice or billing ID reference number.

Alphanumeric, maximum 25 characters.

1-4 1

room
object, required

The object that contains the information about the room properties. The charges object is a child object of the lodgingobject. 2

tax
integer, optional

Total tax amount for the room.

Numeric, maximum 12 digits.

2-1 2

rate
integer, optional

The daily room charges exclusive of taxes and fees.

Numeric, maximum 12 digits.

2-2 2

number_of_nights
integer, optional

The total number of nights for which a room was contracted during a lodging stay.

Numeric, maximum two digits.

2-3 2

fire_safety_act_indicator
boolean, required

Boolean value indicating whether the facility complies with the Motel Fire Safety Act of 1990 (PL101-391) or similar legislation. 2-4 2

guest_name
string, optional

Customer name.

Alphanumeric, maximum 40 characters.

2-5 2

guest_number
string, optional

The number assigned to the lodging customer.

Alphanumeric, maximum 25 characters.

2-5 2

billing_adjustment
string, optional

Any additional charges incurred after the cardholder departure.

Alphanumeric, maximum 12 characters.

2-7 2

property_phone_number
string, optional

Specific lodging property location by its local phone number.

Alphanumeric, maximum 17 characters.

2-8 2

no_show_indicator
string, optional

Boolean value indicating whether the customer did not show up after making a reservation for a lodging.

Default value: false.

2-9 2

prepaid_expenses
integer, optional

The amount of deposit or other prepaid amounts for the lodging stay.

Numeric, maximum 12 digits.

2-10 2

total_tax
integer, optional

The amount of all the taxes associated with the lodging. Applicable only to the Visa, Visa Electron and Maestro cards. Not applicable for Mastercard.

Numeric, maximum 12 digits.

2-11 2

charges
object, optional

The object that contains the information about all the charges for hotel services. The charges object is a child object of the lodging object. 3

room_service
integer, optional

Room service charges.

Numeric, maximum 12 digits

3-1 3

bar_or_lounge
integer, optional

The amount of the lounge or bar charges.

Numeric, maximum 12 digits

3-2 3

transportation
integer, optional

The amount of the transportation charges.

Numeric, maximum 12 digits

3-3 3

gratuity
integer, optional

The amount of the gratuity charges.

Numeric, maximum 12 digits

3-4 3

conference_room
integer, optional

The amount of the charges associated with conference room use.

Numeric, maximum 12 digits.

3-5 3

audio_or_visual
integer, optional

The amount of the audiovisual equipment charges.

Numeric, maximum 12 digits.

3-6 3

banquet
integer, optional

The amount of the banquet charges.

Numeric, maximum 12 digits.

3-1 3

internet_access
integer, optional

The amount of the Internet access charges.

Numeric, maximum 12 digits

3-7 3

early_departure
integer, optional

The amount charged because of early departure.

Numeric, maximum 12 digits

3-1 3

phone
integer, optional

The total amount of charges for all phone calls.

Numeric, maximum 12 digits

3-8 3

restaurant
integer, optional

The total amount of all restaurant charges.

Numeric, maximum 12 digits

3-9 3

minibar
integer, optional

The total amount of in-room “mini-bar” service charges.

Numeric, maximum 12 digits

3-10 3

gift_shop
integer, optional

The total amount of all gift shop and specialty shop charges.

Numeric, maximum 12 digits

3-11 3

laundry_or_cleaning
integer, optional

The total amount of cleaning charges.

Numeric, maximum 12 digits

3-12 3

valet
integer, optional

The charges associated with the use of valet services.

Numeric, maximum 12 digits

3-13 3

movie
integer, optional

The amount charged for in-room movies.

Numeric, maximum 12 digits.

3-14 3

business_center
integer, optional

The amount charged for business center use and supplies.

Numeric, maximum 12 digits.

3-15 3

health_club
integer, optional

The amount charged for health club use and supplies.

Numeric, maximum 12 digits.

3-16 3

Related links