settlementRequest

merchantRefNumstringrequired

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

Possible values: <= 255 characters

amountnumber

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

Possible values: <= 99999999999

dupCheckboolean

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

Default value: true

splitpay object[]

Array [

linkedAccountstringrequired

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

Example: 123124124

amountnumber

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.

Example: 505

percentnumber

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

Example: 5

]

airlineTravelDetails object

Contains information about your airline travel.

Note: This object is only for Airline Merchants.

passengerNamestringrequired

Name of the passenger to whom the ticket was issued.

Possible values: <= 20 characters

Example: Venkata Suresh

departureDatedaterequired

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

Example: 2022-12-20

originstringrequired

Departure Airport Code: IATA Airport Code.

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

Example: SXF

computerizedReservationSystemstring

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.

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

Example: DATS

ticket object

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

ticketNumberstringrequired

Airline ticket number

Possible values: <= 20 characters

Example: 1234567891011

isRestrictedTicketboolean

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'

customerReferenceNumberstring

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

Possible values: <= 20 characters

Example: 10987654321

travelAgency object

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

codestring

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

Possible values: <= 8 characters

Example: MY AGENT

namestring

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

Possible values: <= 25 characters

Example: MYAGENT347

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).

carrierCodestring

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

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

Example: LH

flightNumberstring

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

Possible values: non-empty and <= 5 characters

Example: 0799

serviceClassstring

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

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

Example: F

isStopOverAllowedboolean

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

false - not allowed
true - allowed

destinationstring

Destination Airport Code (IATA Airport Code).

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

Example: SOF

fareBasisstring

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

Possible values: non-empty and <= 6 characters

Example: VMAY

departureDatedate

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

Example: 2022-12-20

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).

carrierCodestring

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

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

Example: LH

flightNumberstring

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

Possible values: non-empty and <= 5 characters

Example: 0799

serviceClassstring

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

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

Example: F

isStopOverAllowedboolean

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

false - not allowed
true - allowed

destinationstring

Destination Airport Code (IATA Airport Code).

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

Example: SOF

fareBasisstring

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

Possible values: non-empty and <= 6 characters

Example: VMAY

departureDatedate

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

Example: 2022-12-20

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).

carrierCodestring

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

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

Example: LH

flightNumberstring

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

Possible values: non-empty and <= 5 characters

Example: 0799

serviceClassstring

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

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

Example: F

isStopOverAllowedboolean

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

false - not allowed
true - allowed

destinationstring

Destination Airport Code (IATA Airport Code).

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

Example: SOF

fareBasisstring

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

Possible values: non-empty and <= 6 characters

Example: VMAY

departureDatedate

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

Example: 2022-12-20

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).

carrierCodestring

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

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

Example: LH

flightNumberstring

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

Possible values: non-empty and <= 5 characters

Example: 0799

serviceClassstring

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

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

Example: F

isStopOverAllowedboolean

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

false - not allowed
true - allowed

destinationstring

Destination Airport Code (IATA Airport Code).

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

Example: SOF

fareBasisstring

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

Possible values: non-empty and <= 6 characters

Example: VMAY

departureDatedate

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

Example: 2022-12-20

passengerNameRecordstring

The airline company uses the passengerNameRecord as a reservation number.

Possible values: <= 10 characters

Example: ABCDE12345

additionalBookingReferencestring

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

Possible values: <= 50 characters

totalFarenumber

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

totalFeenumber

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

totalTaxesnumber

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

passengersstring

Information about the passengers reserved tickets with the same transaction.

settlementRequest
{
  "merchantRefNum": "string",
  "amount": 0,
  "dupCheck": true,
  "splitpay": [
    {
      "linkedAccount": "123124124",
      "amount": 505,
      "percent": 5
    }
  ],
  "airlineTravelDetails": {
    "passengerName": "Venkata Suresh",
    "departureDate": "2022-12-20",
    "origin": "SXF",
    "computerizedReservationSystem": "DATS",
    "ticket": {
      "ticketNumber": "1234567891011",
      "isRestrictedTicket": true
    },
    "customerReferenceNumber": "10987654321",
    "travelAgency": {
      "code": "MY AGENT",
      "name": "MYAGENT347"
    },
    "tripLegs": {
      "leg1": {
        "flight": {
          "carrierCode": "LH",
          "flightNumber": "0799"
        },
        "serviceClass": "F",
        "isStopOverAllowed": true,
        "destination": "SOF",
        "fareBasis": "VMAY",
        "departureDate": "2022-12-20"
      },
      "leg2": {
        "flight": {
          "carrierCode": "LH",
          "flightNumber": "0799"
        },
        "serviceClass": "F",
        "isStopOverAllowed": true,
        "destination": "SOF",
        "fareBasis": "VMAY",
        "departureDate": "2022-12-20"
      },
      "leg3": {
        "flight": {
          "carrierCode": "LH",
          "flightNumber": "0799"
        },
        "serviceClass": "F",
        "isStopOverAllowed": true,
        "destination": "SOF",
        "fareBasis": "VMAY",
        "departureDate": "2022-12-20"
      },
      "leg4": {
        "flight": {
          "carrierCode": "LH",
          "flightNumber": "0799"
        },
        "serviceClass": "F",
        "isStopOverAllowed": true,
        "destination": "SOF",
        "fareBasis": "VMAY",
        "departureDate": "2022-12-20"
      }
    },
    "passengerNameRecord": "ABCDE12345",
    "additionalBookingReference": "string",
    "totalFare": 0,
    "totalFee": 0,
    "totalTaxes": 0,
    "passengers": "string"
  }
}