On This Page

Credits

This topic describes how to process an airline credit.
This service distributes funds without requiring a capture ID.
IMPORTANT
All fields used in the original transaction must be included in your request.

Endpoint

Production:
POST
https://api.cybersource.com
/pts/v2/credits/
Test:
POST
https://apitest.cybersource.com
/pts/v2/credits/

Required Fields for Processing an Airline
Credit

Include these required fields to process an airline credit.
IMPORTANT
When relaxed requirements for address data and the expiration date are being used, not all fields in this list are required. It is your responsibility to determine whether your account is enabled to use this feature and which fields are required. For details about relaxed requirements, see Relaxed Requirements for Address Data and Expiration Date in Payment Transactions.

Optional Fields for Processing an Airline
Credit

This section includes these types of optional fields for an airline
credit
:

General Optional Fields

You can use these optional fields to include additional information in any airline purchase.
travelInformation.agency.code
travelInformation.agency.name
travelInformation.transit.airline.arrivalDate
travelInformation.transit.airline.carrierName
travelInformation.transit.airline.clearingCount
travelInformation.transit.airline.clearingSequence
travelInformation.transit.airline.creditReasonIndicator
travelInformation.transit.airline.customerCode
travelInformation.transit.airline.documentType
For a list of possible values, see Airline Document Type Codes.
travelInformation.transit.airline.electronicTicketIndicator
travelInformation.transit.airline.exchangeTicketFeeAmount
travelInformation.transit.airline.numberOfPassengers
travelInformation.transit.airline.passengerName
travelInformation.transit.airline.planNumber
travelInformation.transit.airline.purchaseType
travelInformation.transit.airline.reservationSystemCode
travelInformation.transit.airline.restrictedTicketDesciption
travelInformation.transit.airline.restrictedTicketIndicator
travelInformation.transit.airline.ticketChangeIndicator
travelInformation.transit.airline.ticketIssueDate
travelInformation.transit.airline.ticketIssuer.locality
travelInformation.transit.airline.ticketNumber
travelInformation.transit.airline.totalClearingAmount
travelInformation.transit.airline.totalFeeAmount
travelInformation.transit[].exchangeTicketAmount

Airline Optional Fields for Ticket Purchases

You can use these optional fields to include additional information when requesting an airline
credit
 for a ticket purchase.
travelInformation.transit.airline.legs[].arrivalTime
travelInformation.transit.airline.legs[].arrivalTimeMeridian
travelInformation.transit.airline.legs[].carrierCode
travelInformation.transit.airline.legs[].class
travelInformation.transit.airline.legs[].conjunctionTicket
travelInformation.transit.airline.legs[].couponNumber
travelInformation.transit.airline.legs[].departureDate
travelInformation.transit.airline.legs[].departureTime
travelInformation.transit.airline.legs[].departureTimeMeridian
travelInformation.transit.airline.legs[].destinationAirportCode
travelInformation.transit.airline.legs[].endorsementsRestrictions
travelInformation.transit.airline.legs[].exchangeTicketNumber
travelInformation.transit.airline.legs[].fareBasis
travelInformation.transit.airline.legs[].feeAmount
travelInformation.transit.airline.legs[].flightNumber
travelInformation.transit.airline.legs[].originatingAirportCode
travelInformation.transit.airline.legs[].stopoverIndicator
travelInformation.transit.airline.legs[].taxAmount
travelInformation.transit.airline.legs[].totalFareAmount

Ancillary Optional Fields

You can use these optional fields to include additional information when requesting an airline
credit
 for an ancillary purchase.
travelInformation.transit.airline.ancillaryInformation.connectedTicketNumber
travelInformation.transit.airline.ancillaryInformation.creditReasonIndicator
travelInformation.transit.airline.ancillaryInformation.passengerName
travelInformation.transit.airline.ancillaryInformation.service[].categoryCode
For a list of possible values, see Ancillary Service Category Codes.
travelInformation.transit.airline.ancillaryInformation.service[].subCategoryCode
travelInformation.transit.airline.ancillaryInformation.ticketNumber

REST Example: Processing an Airline Credit

Request
{
  "paymentInformation": {
    "card": {
      "number": "4111111111111111",
      "expirationMonth": "12",
      "expirationYear": "31"
    }
  },
  "orderInformation": {
    "amountDetails": {
      "totalAmount": "500.00",
      "currency": "USD"
    },
    "billTo": {
      "firstName": "John",
      "lastName": "Doe",
      "address1": "123 Happy St.",
      "locality": "Sunnyville",
      "administrativeArea": "CA",
      "postalCode": "12345",
      "country": "US",
      "email": "johndoe@test.com"
    }
  }
}
Response to a Successful Request
{
  "_links": {
    "void": {
      "method": "POST",
      "href": "/pts/v2/credits/6823065885666134104951/voids"
    },
    "self": {
      "method": "GET",
      "href": "/pts/v2/credits/6823065885666134104951"
    }
  },
  "clientReferenceInformation": {
    "code": "1682306588644"
  },
  "creditAmountDetails": {
    "currency": "USD",
    "creditAmount": "500.00"
  },
  "id": "6823065885666134104951",
  "orderInformation": {
    "amountDetails": {
      "currency": "USD"
    }
  },
  "paymentAccountInformation": {
    "card": {
      "type": "001"
    }
  },
  "paymentInformation": {
    "tokenizedCard": {
      "type": "001"
    },
    "card": {
      "type": "001"
    }
  },
  "processorInformation": {
    "approvalCode": "888888",
    "responseCode": "100"
  },
  "reconciliationId": "74259417PGM9TXHT",
  "status": "PENDING",
  "submitTimeUtc": "2023-04-24T03:23:08Z"
}