Payment Card Authorization

POST	paymentcardauthorizations/AUTH Base path: Pre-production https://api.apim-a.adc.pp.travelport.io:443/11/payment/ Production https://api.apim-a.adc.prod.travelport.io:443/11/payment/

Request

Also see Authorization and Common Pay API Headers.

Query Parameters

None.

Request Body

Show Request Body Table - authorization data

Object	Description / Example	Required / Optional / Conditional	Length	Type (AN: Alphanumeric A: Alpha N: Numeric)
PaymentCardRequest	Top level object for request.	Required
airlineMerchantCode	Validating airline carrier code. Example: A8 for All Around Airline airlineMerchantCode is not the payment card vendor but rather the transaction's merchant of record; for example, BA for a ticket issued on British Airways.	Required	<= 3	AN
extendedPaymentInstallments	Optional in any authorization request. Notes how many payments are in an extended payment plan.	Optional	2	N
expireDate	Credit card expiration date in MMYY format. Example 0824	Required	4	N
agentSignOn	Agent ID	Required	<= 10	AN
localDateTime	Date and time of transaction in YYYY-MM-DDTHH:MM:SS format. Example 2027-08-20T04:12:16	Required		AN
paymentCardSecurityCode	Card security code. Although the API does not validate this optional field, IATA requires all authorization requests to include the CSC/CVV number.	Optional	4	AN
paymentCardCode	Two letter card vendor code. Supported values: AX CA VI DS	Required	2	AN
PrimaryAccountNumber	Payment card account number. Length is validated based on card type.	Required	<= 19	AN
eCI	3D secure data element. Individual card scheme rules may apply. If you provide 3-D secure data, the ECI is mandatory. Electronic Commerce Indicator (ECI) is a value returned by Directory Servers (Visa, MasterCard, Discover and American Express) indicating the outcome of authentication attempted on transactions enforced by 3DS.	Required if sending 3D secure data	2	AN
cAVV	3D secure data element. Individual card scheme rules may apply. The Cardholder Authentication Verification Value . Example: AAACBGESJIMBIFMBZhIkAAAAAAA	Required if sending 3D secure data	<= 28	AN
xID	3D secure data element. Individual card scheme rules may apply. Merchants must ensure that each Payer Authentication Request (PAReq) contains a unique combination of account ID and xID - Visa only. Example: MDAwMDAwMDAwMDEyMzQ2Njc4OTA	Required if sending 3D secure data for Visa	<= 28	AN
uCAFIndicator	3D secure data element. Individual card scheme rules may apply. If you provide 3-D secure data, the ECI is mandatory. Universal Card Authentication Field (UCAF). MasterCard only. UCAF is the mechanism that transmits the AAV from the merchant to the issuer for authentication purposes during authorization.	Required if sending 3D secure data for MasterCard	1	AN
CurrencyAmount	Top level object.	Required	3
value	Amount of transaction with no decimal. Example: $200.56 in USD should be sent as 20056	Required	>= 1	N
code	ISO currency code; e.g., USD or GBP.	Required	3	A
minorUnit	Number of decimal places in the currency.	Required	1	N
AgencyPCCDetail	Top level object.	Optional	2
StateProv	Two-letter state location of agency.	Optional	2-6	A
PostalCode	Postal code of agency.	Optional	<= 22	AN

Show Request Body Table - optional cardholder and itinerary data

The following cardholder data is optional in the authorization request. If Address is sent, an address verification is performed and a subsequent Address Verification request is not needed.

Object	Description / Example	Required / Optional / Conditional	Length	Type (AN: Alphanumeric A: Alpha N: Numeric)
CardHolder	Top level object.	Optional	3
CardHolderName	Name as displayed on payment card.	Optional	<= 30	AN
IP4Address	IP address of transaction.	Optional	15	AN
Person	Top level object for cardholder name and address data.	Optional	5
birthDate	Date of birth in YYYY-MM-DD format. Example 1962-08-24	Optional		AN
PersonName	Top level object. Only one instance of PersonName is supported. If multiple passengers exist, send only the first passenger name and details.	Optional	3
Given	Given name, first name or names.	Optional	<= 30	AN
Middle	Middle initial.	Optional	1	AN
Surname	Family / last name.	Optional	<= 30	AN
Address	Top level object. If Address is sent, address verification is performed as part of authorization. If Address is sent all objects must be populated.	Optional	5
AddressLine	Address of cardholder. Array of address lines. Each address line has a maximum of 20 characters. Example: 123 Main St	Optional	<= 20 per	Array of AN
City	Cardholder city.	Optional	<= 20	AN
StateProv	Top level object.	Optional	1
value	State or province code. Example: CO for Colorado.	Optional	<= 10	AN
Country	Top level object.	Optional	1
value	Country code. Example: GB for Great Britain.	Optional	2	AN
PostalCode	Postal code. No special characters or blanks.	Optional	<= 10	AN
Telephone	Top level object.	Optional	1	Array of objects
role	Custom user-assigned role to assign to this number such as Mobile or Work.	Optional	19	AN
phoneNumber	String. Phone number.	Optional	19	AN
Email	Top level object.	Optional	1	Array of objects
value	String for email address. Example: happy.customer@travelport.com	Optional	<= 60	AN
TravelInfoAir	Top level object for optional itinerary data to send and verify. Notes: If only the GDS reservation locator is sent, Travelport retrieves the applicable reservation and uses the current stored itinerary data. If any itinerary changes have not been committed they are not reflected in the itinerary data. If both the GDS reservation locator and itinerary data are sent, Travelport uses the itinerary data sent in the authorization request. Travelport does not retrieve the reservation to compare the itinerary on the reservation with the itinerary in the request. If itinerary data is sent without a GDS reservation locator, Travelport uses the itinerary data sent in the request. If no itinerary data and no GDS reservation locator is sent, Travelport does not process the request. If the GDS reservation locator sent in the authorization request is invalid or non-retrievable, Travelport carries out the authorization without itinerary data.	Optional	3
departureDate	Date of first departure in YYYY-MM-DD format.	Optional	10	AN
numberOfTravelers	Number of travelers on the itinerary.	Optional	<= 3	N
fareBasisCode	Fare basis code for the reservation. Only one fare basis code is supported in the request. This should be the first fare basis code for the passenger the authorization is being requested for.	Optional	<= 8	AN
LocatorCode	Top level object.	Optional	2
value	Reservation locator code for itinerary.	Optional	<= 8	AN
source	GDS that assigned reservation locator code. Example: 1G	Optional	<= 3	AN
FirstFlightNumber	First flight number in itinerary.	Optional	4	AN
FirstFlightDepartureTime	Time of departure of first flight in format HH:MM:SS. Example: 09:45:00-06:00	Optional		AN
FirstSegmentClass	Booking class of the first flight.	Optional	1-2	AN
AirportCodes	Array of all airport codes in itinerary (space delimited, 3 characters each). Example: "AirportCodes": ["DEN", "ORD", "DEN", "DFW"]	Optional	2-10	Array of A
AirlineCodes	Array of all airlines in itinerary (space delimited, 2 or 3 characters each). Example: "AirlineCodes": ["AA", BA", "DL"]	Optional	1-9	Array of A

Response

All the Pay APIs use the following response structure, in which completionCode and completionCodeDescription provide the status of the transaction. See Pay API Response Codes for the values that may be returned. Other objects below may or may not be returned depending on the transaction sent.

Show Response Body Table

Object	Description
PaymentCardAuthorizationResponse	Top level object for response. Key value pair: transactionId: Internal identifier for the transaction.
PaymentCardAuthorization	Provides confirmation details. The first three following key value pairs are returned for all Pay API responses: completionCode: Code 000 is the OK response. See Pay API Response Codes for other codes. completionDescription: Text description of the value returned in completionCode. PrimaryAccountNumber: The credit card number sent in the request. The following key value pairs are returned only in specific Pay responses: approvalCode: Approval for amount of charge. Returned in authorizations and authorization reversals. avsResult: Vendor response for address verification. Returned in address verifications. securityResult: Vendor response for security code (CSC/CVV). Returned if paymentCardSecurityCode sent in the authorization request.

Object

Description

PaymentCardAuthorizationResponse

Top level object for response.

Key value pair:

transactionId: Internal identifier for the transaction.

PaymentCardAuthorization

Provides confirmation details. The first three following key value pairs are returned for all Pay API responses:

completionCode: Code 000 is the OK response. See Pay API Response Codes for other codes.
completionDescription: Text description of the value returned in completionCode.
PrimaryAccountNumber: The credit card number sent in the request.

The following key value pairs are returned only in specific Pay responses:

approvalCode: Approval for amount of charge. Returned in authorizations and authorization reversals.
avsResult: Vendor response for address verification. Returned in address verifications.
securityResult: Vendor response for security code (CSC/CVV). Returned if paymentCardSecurityCode sent in the authorization request.

Example Request

The first example sends the minimum required data for the authorization request.

Show Example Payment Card Authorization Request - minimum required data

{
 "PaymentCardAuthorizationRequest": {
  "PaymentCardAuthorizationQueryRequest": {
   "PaymentCardRequest": {
    "airlineMerchantCode": "AA",
    "expireDate": "1223",
    "agentSignOn": "ABC123BZ",
    "localDateTime": "2022-08-02T09:45:00",
    "paymentCardCode": "VI",
    "PrimaryAccountNumber": "4012001037141112",
    "CurrencyAmount": {
     "value": "130",
     "code": "USD"
    }
   }
  }
 }
}

Show Example Payment Card Authorization Request - minimum required data - Discover exception for US POS

{
 "PaymentCardAuthorizationRequest": {
  "PaymentCardAuthorizationQueryRequest": {
   "PaymentCardRequest": {
    "airlineMerchantCode": "AA",
    "expireDate": "1223",
    "agentSignOn": "ABC123BZ",
    "localDateTime": "2022-08-02T09:45:00",
    "paymentCardCode": "DS",
    "PrimaryAccountNumber": "6011406100000002",
    "CurrencyAmount": {
     "value": "130",
     "code": "USD"
    },
    "AgencyPCCDetail": {
     "StateProv": "CO",
     "PostalCode": "12345"
    }
   }
  }
 }
}

The following examples send the minimum required data plus the 3DS data as required by Visa and MasterCard.

Show Example Payment Card Authorization Request - with Visa 3DS data

{
 "PaymentCardAuthorizationRequest": {
  "PaymentCardAuthorizationQueryRequest": {
   "PaymentCardRequest": {
    "airlineMerchantCode": "AA",
    "extendedPaymentInstallments": "06",
    "expireDate": "1223",
    "eCI": "05",
    "cAVV": "AAACBGESJIMBIFMBZhIkAAAAAAA=",
    "xID": "MDAwMDAwMDAwMDEyMzQ2Njc4OTA=",
    "agentSignOn": "ZD1C05",
    "localDateTime": "2022-06-08T09:45:00",
    "paymentCardCode": "VI",
    "PrimaryAccountNumber": "4012001037141112",
    "CurrencyAmount": {
     "value": "20066",
     "code": "USD"
    },
    "CardHolder": {
     "@type": "CardHolder",
     "CardHolderName": "John Doe",
     "IP4Address": "111.222.0.0",
     "Person": {
      "dob": "2011-01-24",
      "PersonName": {
       "Given": "John",
       "Middle": "E",
       "Surname": "Doe"
      },
      "Address": [
       {
        "AddressLine": [
         "123 Main St"
        ],
        "City": "YourCity",
        "StateProv": {
         "value": "CO"
        },
        "Country": {
         "value": "IN"
        },
        "PostalCode": "80010"
       }
      ],
      "Telephone": [
       {
        "role": "Mobile",
        "phoneNumber": "5551212"
       }
      ],
      "Email": [
       {
        "value": "happy.customer@travelport.com"
       }
      ]
     }
    },
    "TravelInfoAir": {
     "departureDate": "2018-08-28",
     "numberOfTravelers": 1,
     "fareBasisCode": "Y",
     "LocatorCode": {
      "value": "ZXG25P",
      "source": "1G"
     },
     "FirstFlightNumber": "1123",
     "FirstFlightDepartureTime": "09:45:00-06:00",
     "FirstSegmentClass": "F",
     "AirportCodes": [
      "DEN",
      "ORD",
      "DEN",
      "DFW"
     ],
     "AirlineCodes": [
      "AA",
      "BA",
      "DL"
     ]
    }
   }
  }
 }
}

Show Example Payment Card Authorization Request - with MasterCard 3DS data

{
  "PaymentCardAuthorizationRequest" : {
    "PaymentCardAuthorizationQueryRequest" : {
      "PaymentCardRequest" : {
        "airlineMerchantCode" : "XX",
        "extendedPaymentInstallments" : "0",
        "expireDate" : "1225",
        "eCI" : "00",
        "uCAFIndicator" : "0",
        "agentSignOn" : "ZD1C05",
        "localDateTime" : "2018-06-08T09:45:00",
        "paymentCardSecurityCode" : "134",
        "paymentCardCode" : "CA",
        "PrimaryAccountNumber" : "5204********0008",
        "CurrencyAmount" : {
          "value" : "5100",
          "code" : "USD"
          “mnorUnit”: “2”
        },
        "AgencyPCCDetail" : {
          "StateProv" : "CO",
          "PostalCode" : "12345"
        },
        "CardHolder" : {
          "@type" : "CardHolder",
          "CardHolderName" : "John Doe",
          "IP4Address" : "111.222.0.0",
          "Person" : {
            "dob" : "2011-01-24",
            "PersonName" : {
              "Given" : "John",
              "Middle" : "E",
              "Surname" : "Doe"
            },
            "Address" : [ {
              "AddressLine" : [ "123 Main St" ],
              "City" : "YourCity",
              "StateProv" : {
                "value" : "CO"
              },
              "Country" : {
                "value" : "US"
              },
              "PostalCode" : "80010"
            } ],
            "Telephone" : [ {
              "role" : "Mobile",
              "phoneNumber" : "5551212.0"
            } ],
            "Email" : [ {
              "value" : "happy.customer@travelport.com"
            } ]
          }
        },
        "TravelInfoAir" : {
          "departureDate" : "2019-08-04",
          "numberOfTravelers" : "1",
          "fareBasisCode" : "Y",
          "LocatorCode" : {
            "value" : "ZXG25P",
            "source" : "1G"
         },
          "FirstFlightNumber" : "1123",
          "FirstFlightDepartureTime" : "09:45:00-06:00",
          "FirstSegmentClass" : "F",
          "AirportCodes" : [ "DEN", "ORD", "DEN", "DFW" ],
          "AirlineCodes" : [ "AA", "BA", "DL" ]
        }
      }
    }
  }
}

Example Response

The first example below is a response to a minimum authorization request.

Show Example Response

{
 "PaymentCardAuthorizationResponse": {
  "@type": "PaymentCardAuthorizationResponse",
  "transactionId": "82f997d2-79bc-4145-af12-e85c241c2b8d:ppnd114",
  "PaymentCardAuthorization": {
   "@type": "PaymentCardAuthorization",
   "completionCode": "000",
   "approvalCode": "070073",
   "completionCodeDescription": "Successful approval/completion or V.I.P. PINverification valid",
   "PrimaryAccountNumber": "4012001037141112"
  }
 }
}

The second example confirms an address verification ("avsResult": "Y") and the CVV code ( "securityResult": "M") because a cardholder address was sent in the authorization request

Show Example Response - address verification and MasterCard 3DS data

{
 "PaymentCardAuthorizationResponse": {
  "@type": "PaymentCardAuthorizationResponse",
  "transactionId": "1e2bf344-01c1-4377-a1ad-2348a330b82a",
  "PaymentCardAuthorization": {
   "@type": "PaymentCardAuthorization",
   "completionCode": "000",
   "approvalCode": "032147",
   "avsResult": "Y",
   "securityResult": "M",
   "completionCodeDescription": "Successful approval/completion or V.I.P. PINverification valid",
   "PrimaryAccountNumber": "5204********0008"
  }
 }
}