Model: postAuthTravel

1 min

Model Parameters

postAuthTravel
Example
```
{
  "transactionID": "ABC123456",
  "transactionDateTime": "2022-03-11T17:07:24-07:00",
  "eventSource": "web",
  "accountID": "12363454566",
  "isGuestCheckout": false,
  "isAgenticCheckout": false,
  "paymentAmount": 1082.91,
  "taxAmount": 1.23,
  "deliveryAmount": 5.99,
  "currencyCode": "USD",
  "success": true,
  "ipAddress": "10.12.12.123",
  "emailAddress": "[email protected]",
  "authenticationMethod": "magicLink",
  "failureCode": "authFailed",
  "brand": "acme",
  "phoneNumber": "3125555555",
  "latitude": 33.836,
  "longitude": -117.914,
  "accountStatus": "dormant",
  "firstName": "Jane",
  "middleName": "Marie",
  "lastName": "Doe",
  "purchaseType": "services",
  "isPaymentOptimization": false,
  "is3DS": false,
  "account": {
    "isEnrolledInLoyaltyProgram": true,
    "loyaltyNumber": "Id1234",
    "accountLocale": "en-US",
    "accountLevel": "Gold",
    "accountType": "family"
  },
  "payment": {
    "salesRepID": "SR#46k90",
    "referralCode": "API 210315",
    "isGift": false,
    "orderMessage": "Enjoy the gift",
    "isPaymentInInstallments": false,
    "isPaymentRecurring": false
  },
  "addresses": [
    {
      "addressType": "billing",
      "addressID": "23l4jk23klj23",
      "firstName": "Jane",
      "lastName": "Doe",
      "phone": "3125555555",
      "phoneCountryCode": "001",
      "address1": "1863 Main Street",
      "city": "Chicago",
      "region": "IL",
      "postCode": "60601",
      "country": "US"
    }
  ],
  "paymentMethods": [
    {
      "paymentType": "creditCard",
      "paymentMethodID": "2ljr9vxsdfew",
      "paymentMethodAmount": 1082.91,
      "expirationMonth": "11",
      "expirationYear": "2027",
      "nameOnCreditCard": "Jane Doe",
      "cardBin": "345678",
      "cardLastFour": "1111",
      "avsResult": "matched",
      "cvvResult": "matched",
      "cardAuthorizationCode": "A1B2C3",
      "cardAuthorizationDateTime": "2022-03-11T17:07:25-07:00",
      "sca3DSFlow": "frictionless",
      "sca3DSVersion": "2.2.0",
      "eciIndicator": "successful",
      "isSCASoftDecline": false,
      "sca3DSChallengeRequestType": "02",
      "sca3DSTransactionStatus": "Y",
      "scaAuthorizationStatus": "approve"
    }
  ],
  "flightInformation": {
    "pnr": "ABC123",
    "flightType": "round-trip",
    "initialDepartingAirport": "ORD",
    "finalArrivalAirport": "LAX",
    "numberOfPassengers": 1
  },
  "lodgingInformation": {
    "lodgingDetails": [
      {
        "lodgingName": "The Landmark London",
        "lodgingPropertyID": "LDMRK001",
        "lodgingChainName": "Independent",
        "lodgingAmount": 350,
        "lodgingAmountCurrencyCode": "GBP",
        "lodgingRoomOccupancy": 2,
        "lodgingBedType": "King",
        "lodgingRoomType": "Deluxe",
        "lodgingCheckInDateTime": "2022-04-16T15:00:00+01:00",
        "lodgingCheckOutDateTime": "2022-04-20T11:00:00+01:00",
        "lodgingAddressID": "23l4jk23klj24"
      }
    ],
    "guests": [
      {
        "guestFirstName": "Jane",
        "guestMiddleName": "Marie",
        "guestLastName": "Doe"
      }
    ]
  },
  "carRentalInformation": {
    "carRentalDetails": [
      {
        "carRentalBrand": "Hertz",
        "carRentalAmount": 210,
        "carRentalCurrencyCode": "GBP",
        "rentalType": "daily",
        "rentalClass": "compact",
        "pickupAddressID": "23l4jk23klj25",
        "pickUpDateTime": "2022-04-16T16:00:00+01:00",
        "returnAddressID": "23l4jk23klj26",
        "returnDateTime": "2022-04-20T10:00:00+01:00"
      }
    ]
  },
  "cruiseInformation": {
    "cruiseDetails": [
      {
        "cruiseBrand": "Royal Caribbean",
        "cruiseAmount": 1500,
        "cruiseCurrencyCode": "USD",
        "cruiseDepartureAddressID": "23l4jk23klj27",
        "cruiseInitialStartDateTime": "2022-06-01T16:00:00-04:00",
        "cruiseReturnAddressID": "23l4jk23klj27",
        "cruiseFinalReturnDateTime": "2022-06-08T09:00:00-04:00"
      }
    ]
  },
  "activityInformation": {
    "activityDetails": [
      {
        "activitySupplier": "London Eye",
        "activityName": "Thames River Cruise",
        "activityAmount": 45,
        "activityAmountCurrencyCode": "GBP",
        "activityAddressID": "23l4jk23klj28",
        "activityStartDateTime": "2022-04-17T14:00:00+01:00"
      }
    ]
  },
  "agencyInformation": {
    "agencyDetails": [
      {
        "agencyCode": "01234ABC",
        "agencyName": "Acme Travel Inc",
        "agencyConfirmationNumber": "ABC123",
        "agencyCountryCode": "US"
      }
    ]
  },
  "insuranceInformation": {
    "insuranceDetails": [
      {
        "insuranceType": "travel",
        "insuranceCity": "Chicago",
        "insuranceCountryCode": "US",
        "insuranceTotalAmount": 399.04,
        "insuranceCurrencyCode": "USD"
      }
    ]
  }
}
```
- objecttransactionCommon
  - transactionIDstringrequired
    Example
    ABC123456
    Description
    [Required] Unique transaction identifier (max 40 chars).
    Max Length
    40
  - transactionDateTimestring<date-time>required
    Example
    2022-03-11T17:07:24-07:00
    Description
    [Required] ISO 8601 timestamp of when the transaction occurred.
    Format
    date-time
  - eventSourcestring<agentPhone | agentStore | affiliate | kiosk | mobileApp | other | web>required
    Example
    web
    Description
    [Required] Originating channel; one of: agentPhone, agentStore, affiliate, kiosk, mobileApp, other, web.
    Allowed
    agentPhoneagentStoreaffiliatekioskmobileAppotherweb
  - accountIDstring
    Example
    12363454566
    Description
    [Conditional] Merchant internal account identifier; required when isGuestCheckout is "false".
  - isGuestCheckoutbooleanrequired
    Description
    [Required] Whether the customer checked out without an account ("true"/"false").
  - isAgenticCheckoutboolean
    Description
    [Optional] String "true"/"false" also accepted.
  - paymentAmountnumberrequired
    Example
    1082.91
    Description
    [Required] Total payment amount including tax and delivery; zero or positive, up to 2 decimal places.
    Minimum
    0
  - taxAmountnumberrequired
    Example
    1.23
    Description
    [Required] Tax portion of the payment amount; zero or positive, up to 2 decimal places.
    Minimum
    0
  - deliveryAmountnumberrequired
    Example
    5.99
    Description
    [Required] Delivery/shipping cost; zero or positive, up to 2 decimal places.
    Minimum
    0
  - currencyCodestringrequired
    Example
    USD
    Description
    [Required] ISO 4217 three-letter currency code for the transaction.
  - successbooleanrequired
    Description
    [Required] Outcome of the transaction attempt ("true"/"false").
  - ipAddressstring
    Example
    10.12.12.123
    Description
    [Conditional] Client IP address; required when eventSource is mobileApp or web.
  - userAgentstring
    Example
    Mozilla/5.0 (Macintosh; Intel Mac OS X 10.14; rv:72.0) Gecko/20100101 Firefox/72.0
    Description
    [Conditional] Browser User-Agent string (max 250 chars); required when eventSource is web.
    Max Length
    250
  - deviceTransactionIDstring
    Example
    e1a1aade06e2557f34036eeb06173faf1fa05c64959383
    Description
    [Optional] Session token generated by the device data collection script.
  - devicePayloadstring
    Example
    afklasdjlasdjl3l23j23423klj
    Description
    [Optional] Raw payload from the device fingerprinting library.
  - ubaIDstring
    Example
    3143e969395de649c48c1c9f3e363a3e7ae7
    Description
    [Optional] UBA behavioral analytics session ID (max 100 chars).
    Max Length
    100
  - ubaEventsstring
    Example
    lasjdlkfdsljelkrrjwl3kl324j32k432
    Description
    [Optional] Serialized stream of UBA behavioral events captured during the session.
  - emailAddressstringrequired
    Example
    [email protected]
    Description
    [Required] Customer email address; must be a valid email format.
  - authenticationMethodstring<appAuthenticator | appPush | other | password | passkey | magicLink | SMS>
    Example
    magicLink
    Description
    [Optional] Method used to authenticate the customer; one of: appAuthenticator, appPush, magicLink, other, passkey, password, SMS.
    Allowed
    appAuthenticatorappPushotherpasswordpasskeymagicLinkSMS
  - failureCodestring<authFailed | exportCompliance | other>
    Example
    authFailed
    Description
    [Conditional] Reason the transaction was unsuccessful; one of: authFailed, exportCompliance, other. Required when success is "false".
    Allowed
    authFailedexportComplianceother
  - brandstring
    Example
    acme
    Description
    [Optional] Merchant sub-brand for multi-brand deployments (max 50 chars).
    Max Length
    50
  - phoneNumberstring
    Example
    3125555555
    Description
    [Optional] Customer billing phone number (max 25 chars).
    Max Length
    25
  - latitudenumber
    Example
    33.836
    Description
    [Optional] Geographic latitude of the transaction origin.
  - longitudenumber
    Example
    -117.914
    Description
    [Optional] Geographic longitude of the transaction origin.
  - accountStatusstring<active | dormant | suspended | terminated | trial | other>
    Example
    dormant
    Description
    [Optional] Current lifecycle status of the account; one of: active, dormant, suspended, terminated, trial, other.
    Allowed
    activedormantsuspendedterminatedtrialother
  - firstNamestring
    Example
    Jane
    Description
    [Optional] Customer billing first name.
  - middleNamestring
    Example
    Marie
    Description
    [Optional] Customer billing middle name.
  - lastNamestring
    Example
    Doe
    Description
    [Optional] Customer billing last name.
  - purchaseTypestring<physicalItems | digitalItems | services | other>required
    Example
    physicalItems
    Description
    [Required] Nature of the items in this order; one of: physicalItems, digitalItems, services, other.
    Allowed
    physicalItemsdigitalItemsservicesother
  - listingIDstring
    Example
    abcd1234
    Description
    [Optional] Marketplace listing identifier (max 50 chars).
    Max Length
    50
  - isPaymentOptimizationboolean
    Description
    [Optional] Whether payment optimization is enabled ("true"/"false").
  - is3DSboolean
    Description
    [Optional] Whether 3D Secure authentication was applied ("true"/"false").
- objecttravelExtension
  - flightInformationflightInformation
    Description
    Nested object containing flight itinerary, segment, and passenger information.
    - pnrstring
      Example
      ABC123
      Description
      [Optional] Passenger name record for the itinerary.
    - flightTypestring<one-way | round-trip | multi-city>
      Example
      round-trip
      Description
      [Optional] Type of flight itinerary.
      Allowed
      one-wayround-tripmulti-city
    - isThirdPartyBookingboolean
      Description
      [Optional] Indicates whether the booking was made through a third party ("true"/"false" also accepted).
    - fareBasisCodestring
      Example
      YLOWUS
      Description
      [Optional] Alphanumeric code used by the airline to identify fare type.
    - otaIdentificationNumberstring
      Example
      OTA12345
      Description
      [Optional] Online travel agency identification number.
    - otaNamestring
      Example
      Expedia
      Description
      [Optional] Online travel agency name.
    - initialDepartingAirportstring
      Example
      ORD
      Description
      [Optional] Initial departing airport IATA code.
    - finalArrivalAirportstring
      Example
      LAX
      Description
      [Optional] Final arrival airport IATA code.
    - numberOfPassengersinteger
      Example
      2
      Description
      [Optional] Number of passengers on the itinerary; integer < 4 digits.
      Minimum
      0
    - segmentsflightSegment[]
      Description
      [Optional] Flight segments included in the itinerary.
      - routeInfostring
        Example
        ORD-LAX
        Description
        [Optional] Route information for the flight segment.
      - airlineNamestring
        Example
        American Airlines
        Description
        [Optional] Airline name for the flight segment.
      - operatingAirlinestring
        Example
        American Airlines
        Description
        [Optional] Operating airline for the flight segment.
      - flightNumberstring
        Example
        AA1234
        Description
        [Optional] Flight number for the segment.
      - ticketClassstring<economy | premium | business | first>
        Example
        economy
        Description
        [Optional] Ticket class for the segment.
        Allowed
        economypremiumbusinessfirst
      - fareClassstring
        Example
        Y
        Description
        [Optional] Fare class for the segment.
      - specialFareTypestring<bereavement | corporate | employee | infant | military | senior | student | unaccompaniedMinor | other>
        Example
        corporate
        Description
        [Optional] Special fare category applied to the segment.
        Allowed
        bereavementcorporateemployeeinfantmilitaryseniorstudentunaccompaniedMinorother
      - isAwardTicketboolean
        Description
        [Optional] Indicates whether the segment was booked using an award ticket; string "true"/"false" also accepted.
      - departureDateTimestring<date-time>
        Example
        2022-03-11T08:00:00-06:00
        Description
        [Optional] Departure date and time for the segment; ISO 8601 / RFC 3339.
        Format
        date-time
      - departureAirportCodestring
        Example
        ORD
        Description
        [Optional] Departure airport IATA code.
      - arrivalDateTimestring<date-time>
        Example
        2022-03-11T11:00:00-07:00
        Description
        [Optional] Arrival date and time for the segment; ISO 8601 / RFC 3339.
        Format
        date-time
      - arrivalAirportCodestring
        Example
        LAX
        Description
        [Optional] Arrival airport IATA code.
      - isFinalDestinationboolean
        Example
        true
        Description
        [Optional] Indicates whether this segment ends at the final destination ("true"/"false" also accepted).
    - passengersflightPassenger[]
      Description
      [Optional] Passengers included in the itinerary.
      - passengerIDstring
        Example
        PAX001
        Description
        [Optional] Merchant-assigned identifier for the passenger.
      - ticketNumberstring
        Example
        12345678901
        Description
        [Optional] Ticket number assigned to the passenger.
      - passengerDateOfBirthstring<date>
        Example
        1985-11-15
        Description
        [Optional] Passenger date of birth in ISO 8601 date format (YYYY-MM-DD).
        Format
        date
      - passengerGenderstring<F | M | U | O>
        Example
        F
        Description
        [Optional] Passenger gender code.
        Allowed
        FMUO
      - passengerAdultOrChildstring<adult | child | infant>
        Example
        adult
        Description
        [Optional] Passenger age category.
        Allowed
        adultchildinfant
      - passengerTitlestring
        Example
        Ms
        Description
        [Optional] Passenger title.
      - passengerFirstNamestring
        Example
        Jane
        Description
        [Optional] Passenger first name; maximum 40 characters.
        Max Length
        40
      - passengerMiddleNamestring
        Example
        Marie
        Description
        [Optional] Passenger middle name; maximum 20 characters.
        Max Length
        20
      - passengerLastNamestring
        Example
        Doe
        Description
        [Optional] Passenger last name; maximum 40 characters.
        Max Length
        40
      - passengerFullNamestring
        Example
        Jane Marie Doe
        Description
        [Optional] Passenger full name.
      - passengerPhonestring
        Example
        3125555555
        Description
        [Optional] Passenger phone number.
      - passengerPhoneCountryCodestring
        Example
        1
        Description
        [Optional] Passenger phone country code; numeric country code without + prefix.
      - passengerEmailAddressstring
        Example
        [email protected]
        Description
        [Optional] Passenger email address.
      - passengerCheckedBaggageCountinteger
        Example
        1
        Description
        [Optional] Number of checked bags for the passenger.
        Minimum
        0
      - passengerLoyaltyNumberstring
        Example
        AA123456
        Description
        [Optional] Passenger loyalty membership number.
      - passengerLoyaltySinceDatestring<date>
        Example
        2015-06-01
        Description
        [Optional] Date the passenger loyalty membership began, in ISO 8601 date format (YYYY-MM-DD).
        Format
        date
      - passengerLoyaltyLevelstring
        Example
        Gold
        Description
        [Optional] Passenger loyalty tier level.
      - passengerPassportNumberstring
        Example
        A12345678
        Description
        [Optional] Passenger passport number.
      - passengerPassportCountryCodestring
        Example
        US
        Description
        [Optional] Passenger passport country code; ISO 3166-1 alpha-2.
      - passengerPassportExpirationDatestring<date>
        Example
        2030-06-01
        Description
        [Optional] Passenger passport expiration date in ISO 8601 date format (YYYY-MM-DD).
        Format
        date
  - lodgingInformationlodgingInformation
    Description
    Travel lodging information object
    - lodgingDetailslodgingDetail[]
      Description
      One lodging reservation within lodgingInformation.lodgingDetails[]
      - lodgingNamestring
        Example
        The Landmark London
        Description
        [Optional] Name of the lodging property.
      - lodgingPropertyIDstring
        Example
        LDMRK001
        Description
        [Optional] Merchant-assigned identifier for the lodging property.
      - lodgingChainNamestring
        Example
        Independent
        Description
        [Optional] Name of the lodging chain, if applicable.
      - lodgingAmountnumber
        Example
        350
        Description
        [Optional] Total amount charged for the lodging reservation; zero or positive.
        Minimum
        0
      - lodgingAmountCurrencyCodestring
        Example
        GBP
        Description
        [Optional] ISO 4217 currency code for the lodging amount.
      - lodgingRoomOccupancyinteger
        Example
        2
        Description
        [Optional] Number of guests occupying the room.
        Minimum
        0
      - lodgingBedTypestring
        Example
        King
        Description
        [Optional] Bed type for the room.
      - lodgingRoomTypestring
        Example
        Deluxe
        Description
        [Optional] Room type or category.
      - lodgingCommentsstring
        Example
        Non-smoking room requested
        Description
        [Optional] Free-text comments or special requests for the reservation.
      - lodgingCheckInDateTimestring<date-time>
        Example
        2022-04-16T15:00:00+01:00
        Description
        [Optional] ISO 8601 timestamp of the scheduled check-in.
        Format
        date-time
      - lodgingCheckOutDateTimestring<date-time>
        Example
        2022-04-20T11:00:00+01:00
        Description
        [Optional] ISO 8601 timestamp of the scheduled check-out.
        Format
        date-time
      - lodgingAddressIDstring
        Example
        23l4jk23klj24
        Description
        [Optional] Reference to the address record for the lodging property.
    - guestslodgingGuest[]
      Description
      One guest within lodgingInformation.guests[]
      - guestFirstNamestring
        Example
        Jane
        Description
        [Optional] First name of the lodging guest.
      - guestMiddleNamestring
        Example
        Marie
        Description
        [Optional] Middle name of the lodging guest.
      - guestLastNamestring
        Example
        Doe
        Description
        [Optional] Last name of the lodging guest.
  - carRentalInformationcarRentalInformation
    Description
    Travel car rental information object
    - carRentalDetailscarRentalDetail[]
      Description
      One car rental reservation within carRentalInformation.carRentalDetails[]
      - carRentalBrandstring
        Example
        Hertz
        Description
        [Optional] Car rental company brand.
      - carRentalAmountnumber
        Example
        210
        Description
        [Optional] Total amount charged for the car rental; zero or positive.
        Minimum
        0
      - carRentalCurrencyCodestring
        Example
        GBP
        Description
        [Optional] ISO 4217 currency code for the car rental amount.
      - rentalTypestring
        Example
        daily
        Description
        [Optional] Rental duration type (e.g., daily, weekly).
      - rentalClassstring
        Example
        compact
        Description
        [Optional] Rental vehicle class (e.g., compact, midsize).
      - pickupAddressIDstring
        Example
        23l4jk23klj25
        Description
        [Optional] Reference to the address record for the pickup location.
      - pickUpDateTimestring<date-time>
        Example
        2022-04-16T16:00:00+01:00
        Description
        [Optional] ISO 8601 timestamp of the scheduled pickup.
        Format
        date-time
      - returnAddressIDstring
        Example
        23l4jk23klj26
        Description
        [Optional] Reference to the address record for the return location.
      - returnDateTimestring<date-time>
        Example
        2022-04-20T10:00:00+01:00
        Description
        [Optional] ISO 8601 timestamp of the scheduled return.
        Format
        date-time
  - cruiseInformationcruiseInformation
    Description
    Travel cruise information object
    - cruiseDetailscruiseDetail[]
      Description
      One cruise reservation within cruiseInformation.cruiseDetails[]
      - cruiseBrandstring
        Example
        Royal Caribbean
        Description
        [Optional] Cruise line brand.
      - cruiseAmountnumber
        Example
        1500
        Description
        [Optional] Total amount charged for the cruise; zero or positive.
        Minimum
        0
      - cruiseCurrencyCodestring
        Example
        USD
        Description
        [Optional] ISO 4217 currency code for the cruise amount.
      - cruiseDepartureAddressIDstring
        Example
        23l4jk23klj27
        Description
        [Optional] Reference to the address record for the departure port.
      - cruiseInitialStartDateTimestring<date-time>
        Example
        2022-06-01T16:00:00-04:00
        Description
        [Optional] ISO 8601 timestamp of the cruise departure.
        Format
        date-time
      - cruiseReturnAddressIDstring
        Example
        23l4jk23klj27
        Description
        [Optional] Reference to the address record for the return port.
      - cruiseFinalReturnDateTimestring<date-time>
        Example
        2022-06-08T09:00:00-04:00
        Description
        [Optional] ISO 8601 timestamp of the cruise return.
        Format
        date-time
  - activityInformationactivityInformation
    Description
    Travel activity information object
    - activityDetailsactivityDetail[]
      Description
      One activity reservation within activityInformation.activityDetails[]
      - activitySupplierstring
        Example
        London Eye
        Description
        [Optional] Supplier or operator of the activity.
      - activityNamestring
        Example
        Thames River Cruise
        Description
        [Optional] Name of the activity.
      - activityAmountnumber
        Example
        45
        Description
        [Optional] Total amount charged for the activity; zero or positive.
        Minimum
        0
      - activityAmountCurrencyCodestring
        Example
        GBP
        Description
        [Optional] ISO 4217 currency code for the activity amount.
      - activityAddressIDstring
        Example
        23l4jk23klj28
        Description
        [Optional] Reference to the address record for the activity location.
      - activityStartDateTimestring<date-time>
        Example
        2022-04-17T14:00:00+01:00
        Description
        [Optional] ISO 8601 timestamp of when the activity begins.
        Format
        date-time
- object
  - accountaccount
    - isEnrolledInLoyaltyProgramboolean
      Example
      true
      Description
      [Optional] Whether the account holds a loyalty membership ("true"/"false").
    - loyaltyNumberstring
      Example
      Id1234
      Description
      [Optional] Customer's loyalty program membership number.
    - accountLocalestring
      Example
      en-US
      Description
      [Optional] Account locale/language preference (e.g., "en-US").
    - accountLevelstring
      Example
      Gold
      Description
      [Optional] Customer tier within the loyalty or membership program (e.g., "Gold").
    - accountTypestring<individual | business | family | other>
      Example
      family
      Description
      [Optional] Account category; one of: individual, business, family, other.
      Allowed
      individualbusinessfamilyother
    - accountRegistrationDateTimestring<date-time>
      Example
      2020-11-22T17:07:24-07:00
      Description
      [Optional] ISO 8601 timestamp of when the account was created.
      Format
      date-time
    - accountEmailUpdatedDateTimestring<date-time>
      Example
      2020-08-28T19:00:00-04:00
      Description
      [Optional] ISO 8601 timestamp of the last email address change on the account.
      Format
      date-time
    - accountPasswordUpdatedDateTimestring<date-time>
      Example
      2021-06-15T10:30:00-07:00
      Description
      [Optional] ISO 8601 timestamp of the last password change on the account.
      Format
      date-time
    - dateOfBirthstring<date>
      Example
      1985-11-15
      Description
      [Optional] Customer's date of birth in ISO 8601 date format (YYYY-MM-DD).
      Format
      date
    - loyaltyProgramNamestring
      Example
      Members Plus
      Description
      [Optional] Name of the loyalty program the account belongs to (max 100 chars).
      Max Length
      100
    - loyaltyPointsBalanceinteger
      Example
      987654321
      Description
      [Optional] Current point balance in the loyalty program; zero or positive.
      Minimum
      0
  - paymentpayment
    - salesRepIDstring
      Example
      SR#46k90
      Description
      [Optional] Identifier of the sales representative who assisted with the order (max 20 chars).
      Max Length
      20
    - referralCodestring
      Example
      API 210315
      Description
      [Optional] Promotional or affiliate referral code applied at checkout (max 50 chars).
      Max Length
      50
    - isGiftboolean
      Example
      true
      Description
      [Optional] Indicates the order is being sent as a gift ("true"/"false").
    - isPaymentInInstallmentsboolean
      Description
      [Optional] Whether the total will be paid in multiple installments ("true"/"false").
    - installmentAmountnumber
      Example
      99.99
      Description
      [Optional] Amount of each individual installment payment; positive number.
      Minimum (exclusive)
      0
    - installmentCurrencyCodestring
      Example
      USD
      Description
      [Conditional] ISO 4217 currency code for installment amounts; required when isPaymentInInstallments is "true".
    - installmentCountinteger
      Example
      12
      Description
      [Conditional] Total number of installment payments; required when isPaymentInInstallments is "true".
      Minimum (exclusive)
      0
    - isPaymentRecurringboolean
      Description
      [Optional] Whether this is a recurring/subscription payment ("true"/"false").
    - orderMessagestring
      Example
      Enjoy the gift
      Description
      [Optional] Personal message or order instruction associated with the transaction.
  - paymentMethodspaymentMethodPostAuth[]
    - paymentMethodPreAuth
      - paymentTypestring<bankAccount | cash | check | creditCard | cryptoCurrency | digitalWallet | electronicFundTransfer | giftCard | invoice | loan | loyaltyPoints | moneyOrder | secCard | storeCredit | thirdParty | voucher>
        Example
        creditCard
        Description
        [Conditional] Type of payment instrument. Required when paymentMethodID is present.
        Allowed
        bankAccountcashcheckcreditCardcryptoCurrencydigitalWalletelectronicFundTransfergiftCardinvoiceloanloyaltyPointsmoneyOrdersecCardstoreCreditthirdPartyvoucher
      - paymentMethodIDstring
        Example
        2ljr9vxsdfew
        Description
        [Optional] Merchant-assigned identifier for this payment method.
      - paymentMethodAmountnumber
        Example
        399
        Description
        [Optional] Amount charged to this payment method.
        Minimum
        0
      - isPaymentStoredOnFileboolean
        Example
        true
        Description
        [Optional] Whether this instrument is saved to the account ("true"/"false").
      - cardNumberstring
        Example
        4111111111111111
        Description
        [Optional] Full card number (PAN) for credit card payments, validated using the Luhn algorithm.
      - cardTokenstring
        Example
        6f7%gf38hfUa
        Description
        [Optional] Tokenized representation of the card number.
      - expirationMonthstring<01 | 02 | 03 | 04 | 05 | 06 | 07 | 8 | 9 | 10 | 11 | 12>
        Example
        11
        Description
        [Conditional] Zero-padded two-digit card expiration month ("01".."12"); required when paymentType = creditCard.
        Allowed
        0102030405060789101112
      - expirationYearstring
        Example
        2029
        Description
        [Conditional] Card expiration year (4-digit); required when paymentType = creditCard.
      - nameOnCreditCardstring
        Example
        Jane Doe
        Description
        [Conditional] Cardholder name as embossed on the card; required when paymentType = creditCard.
      - cardBinstring
        Example
        411111
        Description
        [Optional] Bank Identification Number (6 to 11 digits) of the card.
      - cardLastFourstring
        Example
        1111
        Description
        [Optional] Last four digits of the card number.
      - totalFailedAttemptsinteger
        Example
        1
        Description
        [Optional] Number of failed payment attempts for this method.
        Minimum
        0
      - paymentMethodCreatedDateTimestring<date-time>
        Example
        2020-03-28T17:07:24-07:00
        Description
        [Optional] ISO 8601 timestamp of when this payment method was saved.
        Format
        date-time
      - paymentMethodUpdatedDateTimestring<date-time>
        Example
        2020-03-28T17:07:24-07:00
        Description
        [Optional] ISO 8601 timestamp of the last update to this payment method.
        Format
        date-time
      - addressIDstring
        Example
        23kl4l32l
        Description
        [Optional] Reference to the billing address record for this payment method.
      - nameOnAccountstring
        Example
        Jane Doe
        Description
        [Optional] Name on file for a wallet or account-based payment method.
      - walletTypestring
        Example
        Apple Pay
        Description
        [Optional] Digital wallet provider.
      - walletStatusstring<active | pending | inactive>
        Example
        active
        Description
        [Optional] Current status of the wallet.
        Allowed
        activependinginactive
      - isWalletProtectionEligibleboolean
        Example
        true
        Description
        [Optional] Whether the wallet is eligible for purchase protection ("true"/"false").
      - paymentMethodBalanceAmountnumber
        Example
        4000.32
        Description
        [Optional] Remaining balance available on this payment method.
        Minimum (exclusive)
        0
      - giftCardNumberstring
        Example
        5555444433332222
        Description
        [Optional] Full gift card number.
      - giftCardLastFourstring
        Example
        2222
        Description
        [Optional] Last four digits of the gift card number.
      - giftCardBINstring
        Example
        654678
        Description
        [Optional] Bank Identification Number (first 6 digits) of the gift card.
      - expirationDaystring
        Example
        9
        Description
        [Optional] Card expiration day, for payment types that include a day component.
      - pointsinteger
        Example
        50000
        Description
        [Optional] Loyalty or reward points balance associated with this payment method.
      - loyaltyProgramNamestring
        Example
        Members Plus
        Description
        [Optional] Name of the loyalty program associated with this payment method.
      - accountTypestring<checking | saving | moneyMarket | other>
        Example
        checking
        Description
        [Conditional] Bank account type; required when paymentType = bankAccount.
        Allowed
        checkingsavingmoneyMarketother
    - object
      - avsResultstring<matched | partialMatch | notMatched | notChecked | systemError | other>
        Example
        matched
        Description
        [Optional] Address Verification Service result code returned by the card network.
        Allowed
        matchedpartialMatchnotMatchednotCheckedsystemErrorother
      - cvvResultstring<matched | notMatched>
        Example
        matched
        Description
        [Optional] Card Verification Value validation result code returned by the card network.
        Allowed
        matchednotMatched
      - cardAuthorizationCodestring
        Example
        12345
        Description
        [Optional] Authorization approval code returned by the card network.
      - cardAuthorizationDateTimestring<date-time>
        Example
        2022-03-11T17:07:25-07:00
        Description
        [Optional] ISO 8601 timestamp of when the authorization was issued.
        Format
        date-time
      - isPreAuthorizationRejectboolean
        Description
        [Optional] Whether the authorization was rejected before submission ("true"/"false" also accepted).
      - postAuthorizationRejectReasonstring<creditReject | fraudReject | otherReject>
        Example
        creditReject
        Description
        [Optional] Reason the post-authorization was rejected.
        Allowed
        creditRejectfraudRejectotherReject
      - eciIndicatorstring<successful | unsuccessfulOrNotAttempted | attemptedButNotCompleted | other>
        Example
        unsuccessfulOrNotAttempted
        Description
        [Conditional] E-Commerce Indicator returned by the 3DS process; required when sca3DSFlow is present.
        Allowed
        successfulunsuccessfulOrNotAttemptedattemptedButNotCompletedother
      - isSCASoftDeclineboolean
        Description
        [Conditional] Whether the authorization received a soft decline requiring SCA ("true"/"false" also accepted); required when sca3DSFlow is present.
      - sca3DSFlowstring<challenge | frictionless | dataOnly>
        Example
        frictionless
        Description
        [Optional] 3DS authentication flow that was applied; one of: challenge, frictionless, dataOnly; when present, the SCA fields below become required.
        Allowed
        challengefrictionlessdataOnly
      - sca3DSVersionstring
        Example
        2.2.0
        Description
        [Conditional] 3DS protocol version used; required when sca3DSFlow is present.
      - sca3DSChallengeRequestTypestring<02 | 03 | 04 | 05 | 06 | 10 | 11>
        Example
        02
        Description
        [Conditional] Type of 3DS challenge initiated; one of: 02, 03, 04, 05, 06, 10, 11. Required when sca3DSFlow is present.
        Allowed
        02030405061011
      - sca3DSTransactionStatusstring<Y | N | U | A | I>
        Example
        Y
        Description
        [Conditional] 3DS transaction status returned by the issuer; one of: Y, N, U, A, I. Required when sca3DSFlow is present.
        Allowed
        YNUAI
      - scaAuthorizationStatusstring<approve | decline>
        Example
        approve
        Description
        [Conditional] SCA authorization outcome; one of: approve, decline. Required when sca3DSFlow is present.
        Allowed
        approvedecline
      - scaAuthorizationErrorstring<decline | fraudReject | insufficientFunds | invalidCard | incorrectInformation | lostOrStolen | withdrawalAmountExceeded | technicalError | other>
        Example
        decline
        Description
        [Conditional] Reason for a declined SCA authorization; required when scaAuthorizationStatus is "decline".
        Allowed
        declinefraudRejectinsufficientFundsinvalidCardincorrectInformationlostOrStolenwithdrawalAmountExceededtechnicalErrorother
  - itemsitem[]
    - itemTypestring<giftCard | parking | physicalGood | reservation | subscription | ticket | other>
      Example
      physicalGood
      Description
      [Optional] Category of item; one of: giftCard, parking, physicalGood, reservation, subscription, ticket, other.
      Allowed
      giftCardparkingphysicalGoodreservationsubscriptionticketother
    - brandNamestring
      Example
      Apple
      Description
      [Optional] Brand or manufacturer of the item.
    - descriptionstring
      Example
      Macbook Pro
      Description
      [Optional] Short description or name of the item.
    - categorystring
      Example
      Computers
      Description
      [Optional] Merchant-defined product category.
    - itemIDstring
      Example
      af877wernnasnfes
      Description
      [Optional] Merchant's unique product or SKU identifier.
    - isHighRiskItembooleanrequired
      Example
      true
      Description
      [Required] Whether the item is flagged as high risk ("true"/"false").
    - pricenumberrequired
      Example
      1199.99
      Description
      [Required] Unit price of the item; positive number.
      Minimum
      0
    - faceValueAmountnumber
      Example
      1599.99
      Description
      [Optional] Face or retail value of the item; zero or positive.
      Minimum
      0
    - quantitynumber
      Example
      2
      Description
      [Optional] Number of units of this item in the order.
    - addressIDstring
      Example
      2lkj34jldsoufsous82df
      Description
      [Conditional] Delivery address reference for this line item; required when shippingMethod is present.
    - productConditionstring<new | openPackage | other | refurbished | used>
      Example
      new
      Description
      [Optional] Condition of the item; one of: new, openPackage, other, refurbished, used.
      Allowed
      newopenPackageotherrefurbishedused
    - shippingCompanystring<dhl | fedex | ups | usps | other>
      Example
      ups
      Description
      [Optional] Carrier for this item; one of: dhl, fedex, ups, usps, other.
      Allowed
      dhlfedexupsuspsother
    - companyNamestring
      Example
      Regional Courier Co
      Description
      [Optional] Shipping company name for this item, when not one of the standard carriers (max 50 chars).
      Max Length
      50
    - shippingMethodstring<digital | ground | international | other | nextDay | sameDay | storePickup | twoDay | threeDay>required
      Example
      ground
      Description
      [Required] Shipping speed or method.
      Allowed
      digitalgroundinternationalothernextDaysameDaystorePickuptwoDaythreeDay
    - shippingTrackingNumberstring
      Example
      23l4fdswerea02
      Description
      [Optional] Carrier tracking number for this item (max 30 chars).
      Max Length
      30
    - promoCodestring
      Example
      ABC12
      Description
      [Optional] Promotion code applied specifically to this item (max 40 chars).
      Max Length
      40
    - promoAmountnumber
      Example
      50
      Description
      [Optional] Discount applied to this item; zero or positive.
      Minimum
      0
    - promoTypestring<bogo | bundle | employeeDiscount | freeShipping | loyaltyDiscount | newMemberDiscount | percentage | quantityPromotion | other>
      Example
      employeeDiscount
      Description
      [Optional] Category of the item-level promotion.
      Allowed
      bogobundleemployeeDiscountfreeShippingloyaltyDiscountnewMemberDiscountpercentagequantityPromotionother
    - pickupLocationstring<curbside | dropBox | inStore | other>
      Example
      curbside
      Description
      [Optional] In-store or curbside pickup method; one of: curbside, dropBox, inStore, other.
      Allowed
      curbsidedropBoxinStoreother
    - pickupDateTimestring<date-time>
      Example
      2022-03-11T17:07:24-07:00
      Description
      [Optional] ISO 8601 timestamp of the scheduled pickup.
      Format
      date-time
    - pickupPersonFirstNamestring
      Example
      Betty
      Description
      [Optional] First name of the person collecting the order (max 40 chars).
      Max Length
      40
    - pickupPersonLastNamestring
      Example
      Smith
      Description
      [Optional] Last name of the person collecting the order (max 40 chars).
      Max Length
      40
  - promotionspromotion[]
    - promoCodestring
      Example
      ABC12
      Description
      [Optional] Promotional code applied to the order.
    - promoAmountnumberrequired
      Example
      50
      Description
      [Required] Discount amount granted by this promotion; zero or positive.
      Minimum
      0
    - promoTypestring<bogo | bundle | employeeDiscount | freeShipping | loyaltyDiscount | newMemberDiscount | percentage | quantityPromotion | other>
      Example
      employeeDiscount
      Description
      [Optional] Category of the promotion (e.g., employeeDiscount, freeShipping).
      Allowed
      bogobundleemployeeDiscountfreeShippingloyaltyDiscountnewMemberDiscountpercentagequantityPromotionother
  - addressesaddress[]
    - addressIDstringrequired
      Example
      23l4jk23klj23
      Description
      [Required] Merchant-assigned identifier for this address record.
    - addressTypestring<account | billing | bopis | curbside | departure | destination | fulfillment | listing | lodging | pickup | return | shipping | venue | other>required
      Example
      shipping
      Description
      [Required] Role of this address in the order.
      Allowed
      accountbillingbopiscurbsidedeparturedestinationfulfillmentlistinglodgingpickupreturnshippingvenueother
    - primaryFlagboolean
      Example
      true
      Description
      [Optional] Marks this as the account's primary address (true/false).
    - isAddressOnFileboolean
      Description
      [Optional] Whether this address was previously saved to the account ("true"/"false").
    - firstNamestringrequired
      Example
      Jane
      Description
      [Required] Recipient's first name at this address.
    - middleNamestring
      Example
      Marie
      Description
      [Optional] Recipient's middle name at this address.
    - lastNamestringrequired
      Example
      Doe
      Description
      [Required] Recipient's last name at this address.
    - emailAddressstring
      Example
      [email protected]
      Description
      [Conditional] Recipient's email address; required when addressType is account or billing.
    - phonestringrequired
      Example
      3125555555
      Description
      [Required] Recipient's phone number.
    - phoneCountryCodestringrequired
      Example
      001
      Description
      [Required] International dial prefix for the phone number (for example, "001").
    - address1stringrequired
      Example
      1863 Main Street
      Description
      [Required] Primary street address line.
    - address2string
      Example
      Apt 7
      Description
      [Optional] Secondary address line (suite, apartment, etc.).
    - citystringrequired
      Example
      Anaheim
      Description
      [Required] City component of the address.
    - regionstringrequired
      Example
      CA
      Description
      [Required] State or region component of the address.
    - postCodestringrequired
      Example
      92802
      Description
      [Required] Postal or ZIP code.
    - countrystringrequired
      Example
      US
      Description
      [Required] ISO 3166-1 alpha-2 country code.
    - companyNamestring
      Example
      Accertify, Inc
      Description
      [Optional] Business name at this address.
    - addressCreatedDateTimestring<date-time>
      Example
      2020-03-28T17:07:24-07:00
      Description
      [Optional] ISO 8601 timestamp of when this address was saved.
      Format
      date-time
    - addressUpdatedDateTimestring<date-time>
      Example
      2021-03-28T17:07:24-07:00
      Description
      [Optional] ISO 8601 timestamp of the last modification to this address.
      Format
      date-time
  - insuranceInformationinsuranceInformation
    - insuranceDetailsinsuranceDetail[]
      Description
      [Optional] Insurance records associated with the transaction.
      - insuranceTypestring
        Example
        travel
        Description
        [Optional] Type of insurance associated with the transaction (max 30 chars).
        Max Length
        30
      - insuranceCitystring
        Example
        Sydney
        Description
        [Optional] City associated with the insurance coverage (max 40 chars).
        Max Length
        40
      - insuranceCountryCodestring
        Example
        AU
        Description
        [Optional] ISO 3166-1 alpha-2 country code associated with the insurance coverage.
      - insuranceStartDateTimestring<date-time>
        Example
        2022-03-11T17:07:24-07:00
        Description
        [Optional] ISO 8601 date and time when the insurance coverage begins.
        Format
        date-time
      - insuranceEndDateTimestring<date-time>
        Example
        2022-03-11T17:07:24-07:00
        Description
        [Optional] ISO 8601 date and time when the insurance coverage ends.
        Format
        date-time
      - insuranceNamestring
        Example
        Acme Insurance Full Cover
        Description
        [Optional] Name of the insurance product (max 50 chars).
        Max Length
        50
      - insuranceReservationNamestring
        Example
        Jane Doe
        Description
        [Optional] Name associated with the insured reservation (max 100 chars).
        Max Length
        100
      - insuranceTotalAmountnumber
        Example
        399.04
        Description
        [Optional] Total amount charged for the insurance coverage; zero or positive.
        Minimum
        0
      - insuranceCurrencyCodestring
        Example
        AUD
        Description
        [Optional] ISO 4217 three-letter currency code for the insurance amount.
  - lodgingInformationlodgingInformation
    - lodgingDetailslodgingDetail[]
      Description
      One lodging reservation within lodgingInformation.lodgingDetails[]
      - lodgingNamestring
        Example
        The Landmark London
        Description
        [Optional] Name of the lodging property.
      - lodgingPropertyIDstring
        Example
        LDMRK001
        Description
        [Optional] Merchant-assigned identifier for the lodging property.
      - lodgingChainNamestring
        Example
        Independent
        Description
        [Optional] Name of the lodging chain, if applicable.
      - lodgingAmountnumber
        Example
        350
        Description
        [Optional] Total amount charged for the lodging reservation; zero or positive.
        Minimum
        0
      - lodgingAmountCurrencyCodestring
        Example
        GBP
        Description
        [Optional] ISO 4217 currency code for the lodging amount.
      - lodgingRoomOccupancyinteger
        Example
        2
        Description
        [Optional] Number of guests occupying the room.
        Minimum
        0
      - lodgingBedTypestring
        Example
        King
        Description
        [Optional] Bed type for the room.
      - lodgingRoomTypestring
        Example
        Deluxe
        Description
        [Optional] Room type or category.
      - lodgingCommentsstring
        Example
        Non-smoking room requested
        Description
        [Optional] Free-text comments or special requests for the reservation.
      - lodgingCheckInDateTimestring<date-time>
        Example
        2022-04-16T15:00:00+01:00
        Description
        [Optional] ISO 8601 timestamp of the scheduled check-in.
        Format
        date-time
      - lodgingCheckOutDateTimestring<date-time>
        Example
        2022-04-20T11:00:00+01:00
        Description
        [Optional] ISO 8601 timestamp of the scheduled check-out.
        Format
        date-time
      - lodgingAddressIDstring
        Example
        23l4jk23klj24
        Description
        [Optional] Reference to the address record for the lodging property.
    - guestslodgingGuest[]
      Description
      One guest within lodgingInformation.guests[]
      - guestFirstNamestring
        Example
        Jane
        Description
        [Optional] First name of the lodging guest.
      - guestMiddleNamestring
        Example
        Marie
        Description
        [Optional] Middle name of the lodging guest.
      - guestLastNamestring
        Example
        Doe
        Description
        [Optional] Last name of the lodging guest.
  - carRentalInformationcarRentalInformation
    - carRentalDetailscarRentalDetail[]
      Description
      One car rental reservation within carRentalInformation.carRentalDetails[]
      - carRentalBrandstring
        Example
        Hertz
        Description
        [Optional] Car rental company brand.
      - carRentalAmountnumber
        Example
        210
        Description
        [Optional] Total amount charged for the car rental; zero or positive.
        Minimum
        0
      - carRentalCurrencyCodestring
        Example
        GBP
        Description
        [Optional] ISO 4217 currency code for the car rental amount.
      - rentalTypestring
        Example
        daily
        Description
        [Optional] Rental duration type (e.g., daily, weekly).
      - rentalClassstring
        Example
        compact
        Description
        [Optional] Rental vehicle class (e.g., compact, midsize).
      - pickupAddressIDstring
        Example
        23l4jk23klj25
        Description
        [Optional] Reference to the address record for the pickup location.
      - pickUpDateTimestring<date-time>
        Example
        2022-04-16T16:00:00+01:00
        Description
        [Optional] ISO 8601 timestamp of the scheduled pickup.
        Format
        date-time
      - returnAddressIDstring
        Example
        23l4jk23klj26
        Description
        [Optional] Reference to the address record for the return location.
      - returnDateTimestring<date-time>
        Example
        2022-04-20T10:00:00+01:00
        Description
        [Optional] ISO 8601 timestamp of the scheduled return.
        Format
        date-time
  - cruiseInformationcruiseInformation
    - cruiseDetailscruiseDetail[]
      Description
      One cruise reservation within cruiseInformation.cruiseDetails[]
      - cruiseBrandstring
        Example
        Royal Caribbean
        Description
        [Optional] Cruise line brand.
      - cruiseAmountnumber
        Example
        1500
        Description
        [Optional] Total amount charged for the cruise; zero or positive.
        Minimum
        0
      - cruiseCurrencyCodestring
        Example
        USD
        Description
        [Optional] ISO 4217 currency code for the cruise amount.
      - cruiseDepartureAddressIDstring
        Example
        23l4jk23klj27
        Description
        [Optional] Reference to the address record for the departure port.
      - cruiseInitialStartDateTimestring<date-time>
        Example
        2022-06-01T16:00:00-04:00
        Description
        [Optional] ISO 8601 timestamp of the cruise departure.
        Format
        date-time
      - cruiseReturnAddressIDstring
        Example
        23l4jk23klj27
        Description
        [Optional] Reference to the address record for the return port.
      - cruiseFinalReturnDateTimestring<date-time>
        Example
        2022-06-08T09:00:00-04:00
        Description
        [Optional] ISO 8601 timestamp of the cruise return.
        Format
        date-time
  - activityInformationactivityInformation
    - activityDetailsactivityDetail[]
      Description
      One activity reservation within activityInformation.activityDetails[]
      - activitySupplierstring
        Example
        London Eye
        Description
        [Optional] Supplier or operator of the activity.
      - activityNamestring
        Example
        Thames River Cruise
        Description
        [Optional] Name of the activity.
      - activityAmountnumber
        Example
        45
        Description
        [Optional] Total amount charged for the activity; zero or positive.
        Minimum
        0
      - activityAmountCurrencyCodestring
        Example
        GBP
        Description
        [Optional] ISO 4217 currency code for the activity amount.
      - activityAddressIDstring
        Example
        23l4jk23klj28
        Description
        [Optional] Reference to the address record for the activity location.
      - activityStartDateTimestring<date-time>
        Example
        2022-04-17T14:00:00+01:00
        Description
        [Optional] ISO 8601 timestamp of when the activity begins.
        Format
        date-time
  - agencyInformationagencyInformation
    - agencyDetailsagencyDetail[]
      Description
      [Optional] Agency records associated with the transaction.
      - agencyCodestring
        Example
        01234ABC
        Description
        [Optional] Agency code (max 20 chars).
        Max Length
        20
      - agencyNamestring
        Example
        Acme Travel Inc
        Description
        [Optional] Agency name (max 50 chars).
        Max Length
        50
      - agencySalesRepresentativeIDstring
        Example
        232324521
        Description
        [Optional] Identifier of the agency sales representative (max 20 chars).
        Max Length
        20
      - agencyConfirmationNumberstring
        Example
        ABC123
        Description
        [Optional] Confirmation number assigned by the agency (max 25 chars).
        Max Length
        25
      - agencyCountryCodestring
        Example
        AU
        Description
        [Optional] ISO 3166-1 alpha-2 country code associated with the agency.
      - agencyEmailstring
        Example
        [email protected]
        Description
        [Optional] Agency email address.
      - agencyHeadOfficestring
        Example
        Chicago
        Description
        [Optional] Location of the agency head office (max 50 chars).
        Max Length
        50
      - agencyPhonestring
        Example
        19876543211
        Description
        [Optional] Agency phone number (max 25 chars).
        Max Length
        25

Request body for POST /postAuthTravel