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. PHP
$result = $gateway->transaction()->sale([
    'amount' => '100.00',
    'creditCard' => [
        'number' => '4111111111111111',
        'expirationDate' => '05/12'
    ],
    'industry' => [
        'industryType' => Braintree::Transaction::TRAVEL_AND_CRUISE_INDUSTRY,
        'data' => [
            'travelPackage' => 'flight',
            'departureDate' => '2000-07-22',
            'lodgingCheckInDate' => '2000-07-22',
            'lodgingCheckOutDate' => '2000-07-25',
            'lodgingName' => '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. PHP
$result = $gateway->transaction()->sale([
    'amount' => '100.00',
    'creditCard' => [
        'number' => '4111111111111111',
        'expirationDate' => '05/12'
    ],
    'industry' => [
        'industryType' => Braintree::Transaction::LODGING_INDUSTRY,
        'data' => [
            'folioNumber' => 'ABC123',
            'checkInDate' => '2000-12-22',
            'checkOutDate' => '2000-12-25',
            'roomRate' => '10.00'
        ]
    ]
]);