Skip to main content

settlementRequest

    merchantRefNum stringrequired

    Possible values: <= 255 characters

    This is the merchant reference number created by the merchant and submitted as part of the request. It must be unique for each request.

    amount number

    Possible values: <= 99999999999

    This is the amount of the request, in minor units.For example, to process US $10.99, this value should be 1099.

    dupCheck boolean

    Default value: true

    This validates that this request is not a duplicate. A request is considered a duplicate if the merchantRefNum has already been used in a previous request within the past 90 days.

    Note: This value defaults to true

    splitpay

    object[]

  • Array [

    • linkedAccount stringrequired

    This is the ID of the linked account. This account must already be linked to the merchant account.

    amount number

    This is the amount to transfer to the linked account in minor currency units. The total amount to all linked accounts cannot exceed the transaction total.

    percent number

    This is the percentage of the total transaction amount to transfer to that account. The total percentage to all linked accounts cannot exceed 100%.

  • ]

    • airlineTravelDetails

    object

    Contains information about your airline travel.

    Note: This object is only for Airline Merchants.

    passengerName stringrequired

    Possible values: <= 20 characters

    Name of the passenger to whom the ticket was issued.

    departureDate daterequired

    Date of passenger’s departure. Date format = YYYY-MM-DD, ISO 8601 expected. For example 2022-12-20.

    origin stringrequired

    Possible values: >= 3 characters and <= 3 characters

    Departure Airport Code: IATA Airport Code.

    computerizedReservationSystem string

    Possible values: [STRT, PARS, DATS, SABR, DALA, BLAN, DERD, TUID]

    Indicates the computerized reservation system used to make the reservation and purchase the ticket. For tickets purchased in Germany, this field should one of these codes:

    • STRT - Start

    • PARS - TWA

    • DATS - Delta

    • SABR - Sabre

    • DALA - Covia-Apollo

    • BLAN - Dr. Blank

    • DERD - DER

    • TUID - TUI

    Note: Required only if the ticket is purchased in Germany. Otherwise it can be omitted.

    ticket

    object

    Information about the Airline Ticket Number and if the ticket is restricted.

    ticketNumber stringrequired

    Possible values: <= 20 characters

    Airline ticket number

    isRestrictedTicket boolean

    Indicates whether this ticket is non-refundable. This entry should be supplied on CPS/Passenger Transport 1 or 2 transactions if the ticket was purchased as a non-refundable ticket. Valid values are:

    • false - No restriction (default)

    • true - Restricted (non-refundable) ticket'

    customerReferenceNumber string

    Possible values: <= 20 characters

    Contains the code that the cardholder supplied to the card acceptor.

    travelAgency

    object

    Information about the travel agency if the ticket was issued by a travel agency.

    code string

    Possible values: <= 8 characters

    Code identifying travel agency if the ticket was issued by a travel agency..

    name string

    Possible values: <= 25 characters

    Information about the travel agency if the ticket was issued by a travel agency.

    tripLegs

    object

    A grouping of four separate trip segments. Each leg contains detailed itinerary information.

    leg1

    object

    Contains detailed itinerary information for one of the trip legs

    flight

    object

    Operating Carrier Code and the Number of the airline flight to be taken on Leg of the trip (excluding the carrier code).

    carrierCode string

    Possible values: >= 2 characters and <= 2 characters

    Operating Carrier Code; the standard abbreviation code indicating name of the operating carrier like United Airlines, Jet Blue, etc.

    flightNumber string

    Possible values: non-empty and <= 5 characters

    Number of the airline flight to be taken on Leg of the trip excluding the carrier code.

    serviceClass string

    Possible values: non-empty and <= 1 characters, [F, J, W, Y]

    Indicates service class (first class, business class, etc.). Example values (not limited to):

    • F - first class

    • J - business class

    • W - premium economy class

    • Y - economy class

    isStopOverAllowed boolean

    Indicates whether a stopover is allowed on this ticket. Valid values are:

    • false - not allowed

    • true - allowed

    destination string

    Possible values: >= 3 characters and <= 3 characters

    Destination Airport Code (IATA Airport Code).

    fareBasis string

    Possible values: non-empty and <= 6 characters

    Contains a Fare Basis Code for Leg that carriers assign to a particular ticket type, such as business class or discounted/nonrefundable.

    departureDate date

    Date of passenger’s departure for this leg. Date format = YYYY-MM-DD, ISO 8601 expected. For example, 2014-01-26

    leg2

    object

    Contains detailed itinerary information for one of the trip legs

    flight

    object

    Operating Carrier Code and the Number of the airline flight to be taken on Leg of the trip (excluding the carrier code).

    carrierCode string

    Possible values: >= 2 characters and <= 2 characters

    Operating Carrier Code; the standard abbreviation code indicating name of the operating carrier like United Airlines, Jet Blue, etc.

    flightNumber string

    Possible values: non-empty and <= 5 characters

    Number of the airline flight to be taken on Leg of the trip excluding the carrier code.

    serviceClass string

    Possible values: non-empty and <= 1 characters, [F, J, W, Y]

    Indicates service class (first class, business class, etc.). Example values (not limited to):

    • F - first class

    • J - business class

    • W - premium economy class

    • Y - economy class

    isStopOverAllowed boolean

    Indicates whether a stopover is allowed on this ticket. Valid values are:

    • false - not allowed

    • true - allowed

    destination string

    Possible values: >= 3 characters and <= 3 characters

    Destination Airport Code (IATA Airport Code).

    fareBasis string

    Possible values: non-empty and <= 6 characters

    Contains a Fare Basis Code for Leg that carriers assign to a particular ticket type, such as business class or discounted/nonrefundable.

    departureDate date

    Date of passenger’s departure for this leg. Date format = YYYY-MM-DD, ISO 8601 expected. For example, 2014-01-26

    leg3

    object

    Contains detailed itinerary information for one of the trip legs

    flight

    object

    Operating Carrier Code and the Number of the airline flight to be taken on Leg of the trip (excluding the carrier code).

    carrierCode string

    Possible values: >= 2 characters and <= 2 characters

    Operating Carrier Code; the standard abbreviation code indicating name of the operating carrier like United Airlines, Jet Blue, etc.

    flightNumber string

    Possible values: non-empty and <= 5 characters

    Number of the airline flight to be taken on Leg of the trip excluding the carrier code.

    serviceClass string

    Possible values: non-empty and <= 1 characters, [F, J, W, Y]

    Indicates service class (first class, business class, etc.). Example values (not limited to):

    • F - first class

    • J - business class

    • W - premium economy class

    • Y - economy class

    isStopOverAllowed boolean

    Indicates whether a stopover is allowed on this ticket. Valid values are:

    • false - not allowed

    • true - allowed

    destination string

    Possible values: >= 3 characters and <= 3 characters

    Destination Airport Code (IATA Airport Code).

    fareBasis string

    Possible values: non-empty and <= 6 characters

    Contains a Fare Basis Code for Leg that carriers assign to a particular ticket type, such as business class or discounted/nonrefundable.

    departureDate date

    Date of passenger’s departure for this leg. Date format = YYYY-MM-DD, ISO 8601 expected. For example, 2014-01-26

    leg4

    object

    Contains detailed itinerary information for one of the trip legs

    flight

    object

    Operating Carrier Code and the Number of the airline flight to be taken on Leg of the trip (excluding the carrier code).

    carrierCode string

    Possible values: >= 2 characters and <= 2 characters

    Operating Carrier Code; the standard abbreviation code indicating name of the operating carrier like United Airlines, Jet Blue, etc.

    flightNumber string

    Possible values: non-empty and <= 5 characters

    Number of the airline flight to be taken on Leg of the trip excluding the carrier code.

    serviceClass string

    Possible values: non-empty and <= 1 characters, [F, J, W, Y]

    Indicates service class (first class, business class, etc.). Example values (not limited to):

    • F - first class

    • J - business class

    • W - premium economy class

    • Y - economy class

    isStopOverAllowed boolean

    Indicates whether a stopover is allowed on this ticket. Valid values are:

    • false - not allowed

    • true - allowed

    destination string

    Possible values: >= 3 characters and <= 3 characters

    Destination Airport Code (IATA Airport Code).

    fareBasis string

    Possible values: non-empty and <= 6 characters

    Contains a Fare Basis Code for Leg that carriers assign to a particular ticket type, such as business class or discounted/nonrefundable.

    departureDate date

    Date of passenger’s departure for this leg. Date format = YYYY-MM-DD, ISO 8601 expected. For example, 2014-01-26

    passengerNameRecord string

    Possible values: <= 10 characters

    The airline company uses the passengerNameRecord as a reservation number.

    additionalBookingReference string

    Possible values: <= 50 characters

    BookingReference field. Typically used for the PNR, but should allow an airline to specify any other reference if they feel fit.

    totalFare number

    Total fare for all legs on the ticket, excluding taxes and fees. If multiple tickets are purchased, this is the total fare for all tickets

    totalFee number

    Total fee for all legs on the ticket. If multiple tickets are purchased, this is the total fee for all tickets.

    totalTaxes number

    Total taxes for all legs on the ticket. If multiple tickets are purchased, this is the total taxes for all tickets.

    passengers string

    Information about the passengers reserved tickets with the same transaction.