Retrieves card types compatible with the currency and locale specified in the currencyCode and locale common parameters, respectively. All card types returned in the response are valid for bookings under the provided parameters.

This request is typically used to create lists of payment options for a customer's preferred currency when booking.

Review valid card types for more details on payment cards and validation.

Request Formats
XML/REST URL: GET http://api.ean.com/ean-services/rs/hotel/v3/paymentInfo?
XML Parent Element: <HotelPaymentRequest>


Request Parameters

Service-Specific URL Parameter Requirements
Name Value Required Description
apiExperience string yes

Use this attribute to identify the origin of your request. Choose an applicable value from the set provided below for each request you send.

Values:
PARTNER_CALL_CENTER - request from an agent in your call center
PARTNER_WEBSITE - request from a customer-facing website
PARTNER_MOBILE_WEB - request from a mobile-formatted website
PARTNER_MOBILE_APP - request from a mobile app
PARTNER_BOT_CACHE - request from a cache bot
PARTNER_BOT_REPORTING - request from a reporting bot
PARTNER_AFFILIATE - request from an API/platform that serves your own affiliate base

currencyCode string yes The currency code for which payment information is needed
locale string yes

The locale for which payment information is needed


Currency code, locale, rate type and supplier type must be populated dynamically for every request. Hardcoding any of these values may cause incorrect payment types to return.



Base Parameters
Name Value Required Description
hotelId string yes The hotelId for the property.
supplierType string yes

The supplier type for which payment information is needed.
Send a value of E (for Expedia Collect) unless otherwise instructed by support.

rateType string yes The rate type from the hotel's room availability response for which payment information is needed.
Permitted values:
  • MerchantStandard
  • MerchantPackage
  • DirectAgency


Response Content
Parent Element: HotelPaymentResponse

The parent element has the attributes size, to indicate the number of options returned, and currencyCode, to confirm the currency code specified in the request. The parent element contains PaymentType, containing individual payment options.
Name Value Description
PaymentType object Under XML, contains the code and name for a single payment type. Under REST, a single instance containing a serialized array of all payment types will return.
PaymentType.code string The two-digit code for the card. For use with the creditCardType booking request element.
PaymentType.name string The descriptive name for the card (suitable for display).
PaymentType.thirdPartyVerificationType string Describes the card verification mechanism.
PaymentType.mandatoryDisplayText string

Returns a complete-sentence string describing where the country where the payment will be processed (see examples below). Check for this field for all card types. Do not hard-code values for this field.

PaymentType.processorCountryCode string

Returns a two-digit country code confirming the payment processing country indicated by the mandatoryDisplayText string.

Example XML Request:

http://api.ean.com/ean-services/rs/hotel/v3/paymentInfo?
minorRev=[current minorRev #]
&cid=XXXXX
&sig=########
&apiKey=[xxx-yourOwnKey-xxx]
&customerUserAgent=[xxx]
&customerIpAddress=[xxx]
&customerSessionId=[xxx]
&locale=en_US
&currencyCode=USD
&xml=
<HotelPaymentRequest>
<hotelId>122212</hotelId>
<supplierType>E</supplierType>
<rateType>MerchantStandard</rateType>
</HotelPaymentRequest>

Example XML payment type response:

<ns2:HotelPaymentResponse xmlns:ns2="http://v3.hotel.wsapi.ean.com/" size="6" currencyCode="USD">
<customerSessionId>bdb5eab4-1eff-4874-8389-5105e6ea2bfd</customerSessionId>
<PaymentType>
<code>AX</code>
<name>American Express</name>
</PaymentType>
<PaymentType>
<code>DC</code>
<name>DINERS CLUB INTERNATIONAL</name>
</PaymentType>
<PaymentType>
<code>DS</code>
<name>Discover</name>
</PaymentType>
<PaymentType>
<code>JC</code>
<name>JCB</name>
</PaymentType>
<PaymentType>
<code>CA</code>
<name>Master Card</name> <thirdPartyVerificationType>3DS</thirdPartyVerificationType>
<mandatoryDisplayText>This payment will be processed in the United States.</mandatoryDisplayText>
</PaymentType>
<PaymentType>
<code>VI</code>
<name>Visa</name> <thirdPartyVerificationType>3DS</thirdPartyVerificationType>
<mandatoryDisplayText>This payment will be processed in the United States.</mandatoryDisplayText>
</PaymentType>
</ns2:HotelPaymentResponse>

 

Example REST payment type request:

http://api.ean.com/ean-services/rs/hotel/v3/paymentInfo?
minorRev=[current minorRev #]
&cid=XXXXX
&sig=########
&apiKey=[xxx-yourOwnKey-xxx]
&customerUserAgent=[xxx]
&customerIpAddress=[xxx]
&customerSessionId=[xxx]
&locale=en_US
&currencyCode=USD
&hotelId=122212
&supplierType=E
&rateType=MerchantStandard

Example JSON payment type response:

{
"HotelPaymentResponse": {
"@size": "6",
"@currencyCode": "USD",
"customerSessionId": "1c3bbc85-09bd-414f-9215-96c51cbf87b7",
"PaymentType": [
{
"code": "AX",
"name": "American Express"
}, {
"code": "DC",
"name": "DINERS CLUB INTERNATIONAL"
}, {
"code": "DS",
"name": "Discover"
}, {
"code": "JC",
"name": "JCB"
}, {
"code": "CA",
"name": "Master Card", "thirdPartyVerificationType": "3DS",
"mandatoryDisplayText": "This payment will be processed in the United States."
}, {
"code": "VI", "thirdPartyVerificationType": "3DS",
"name": "Visa",
"mandatoryDisplayText": "This payment will be processed in the United States."
}
]
}
}