Authorization Reversal

POST

paymentcardauthorizations/REVS

Base path:

Use this base path if you have not yet received or not migrated to the new credentials from Travelport:

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/

Use this base path after you have migrated to the new credentials from Travelport:

Pre-production https://api.pp.travelport.net/11/payment/

Production https://api.travelport.net/11/payment/

Related Content: Pay APIs Guide

An authorization reversal is generated to notify the issuer that the sale has been voided or canceled and that the authorization hold should be released.

If a reversal is not sent, the authorized funds may remain outstanding for anywhere from 3 to 14 days, depending on the card type. In some countries if a reversal advice is not received within the same business day the transaction will be processed.

The response indicates whether the authorization vendor received the reversal request. It is not a guarantee the reversal has been processed.

Request

Also see Authentication and Common Pay API Headers.

Query Parameters

None.

Request Body

Object

Description

Required/Optional

Length

Type

(AN: Alphanumeric
A: Alpha
N: Numeric)

PaymentCardAuthorizationRequest

Top level object for request.

Required

   
PaymentCardAuthorizationQueryRequest

 

Top level object.

Required

   

PaymentCardRequest

 

Top level object for payment card details.

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

 

expireDate

Credit card expiration date in MMYY format.

Example 0824

Optional

4

N

 

agentSignOn

Agent ID

Optional

<= 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 are:

  • AX

  • CA

  • VI

  • DS

Required

2

AN

 

PrimaryAccountNumber

Payment card account number. Length is validated based on card type.

Required

<= 19

AN

approvalCode

Approval code from the authorization response.

Required

<= 8

AN

Response

All Pay API requests return the same response structure, in which completionCode and completionCodeDescription provide the status of the transaction. See Payment Card Authorization for the response body table.

Example Request

{
 "PaymentCardAuthorizationRequest": {
  "PaymentCardAuthorizationQueryRequest": {
   "PaymentCardRequest": {
    "airlineMerchantCode": "DL",
    "localDateTime": "2022-06-08T09:45:00",
    "paymentCardCode": "VI",
    "PrimaryAccountNumber": "4012001037141112",
    "approvalCode": "062635"
   }
  }
 }
}

Example Response

{
 "PaymentCardAuthorizationResponse": {
  "@type": "PaymentCardAuthorizationResponse",
  "transactionId": "e19890cf-2124-4b2d-8861-ef24f5087671:ppnd114",
  "PaymentCardAuthorization": {
   "@type": "PaymentCardAuthorization",
   "completionCode": "000",
   "approvalCode": "062635",
   "completionCodeDescription": "Successful approval/completion or V.I.P. PINverification valid",
   "PrimaryAccountNumber": "4012001037141112"
  }
 }
}