Industry-Specific Fields for Amex Direct

American Express supports optional, industry-specific fields on transactions. If you use an American Express Direct processor connection in your gateway, you can send this optional data for both the Lodging and Travel/Cruise industries, as defined by American Express. Information for only one industry type may be sent per transaction.

Travel/cruise industry parametersAnchorIcon

The following parameters may be sent with the travel/cruise industry type: Travel package
(required) Specifies whether the travel package includes a flight reservation, car rental, both flight and car, or neither. Must be one of the following four values: flight , car , flight_and_car , otherDeparture date
(optional) Date of departure, in the format 2000-12-15Lodging check-in date
(optional) Date of lodging check in in the format 2000-12-15Lodging check-out date
(optional) Date of lodging check out, in the format 2000-12-15Lodging name
(optional) Name of the lodging, with a maximum of 20 characters

ExampleAnchorIcon

  1. Ruby
result = gateway.transaction.sale(
    :amount => "100.00",
    :credit_card => {
        :number => "4111111111111111",
        :expiration_date => "05/2022"
    },
    :industry => {
        :industry_type => Braintree::Transaction::IndustryType::TravelAndCruise,
        :data => {
            :travel_package => "flight",
            :departure_date => "2000-07-22",
            :lodging_check_in_date => "2000-07-22",
            :lodging_check_out_date => "2000-07-25",
            :lodging_name => "Royal Caribbean"
        }
    }
)

Lodging industry parametersAnchorIcon

The following parameters may be sent with the lodging industry type: Folio number
(required) Folio number assigned to the itemized statement assigned to this stay. Alphanumeric with a maximum of 12 charactersCheck in date
(required) Date of lodging check in, in the format 2000-12-15Check out date
(required) Date of lodging check out, in the format 2000-12-15Room rate
(optional) The daily room rate, in the same format as the transaction amount. This field is optional

ExampleAnchorIcon

  1. Ruby
result = gateway.transaction.sale(
    :amount => "100.00",
    :credit_card => {
        :number => "4111111111111111",
        :expiration_date => "05/2022"
    },
    :industry => {
        :industry_type => Braintree::Transaction::IndustryType::Lodging,
        :data => {
            :folio_number => "ABC123",
            :check_in_date => "2000-12-22",
            :check_out_date => "2000-12-25",
            :room_rate => "10.00"
        }
    }
)