On This Page

Pre-Authorization with a Token

This section describes how to process a pre-authorization.

Response Field Handling

When you receive the

AUTH_DECLINE_CAPTURE_POSSIBLE

value in the

errorInformation.reason

REST API field of an authorization response, it indicates that a capture attempt will not be rejected automatically. Before processing the capture, verify that it is permitted in this scenario by reviewing the card scheme’s First Ride Risk and shared‑liability rules.

For an example of the field data, see the response in REST Example: Pre-Authorization with a Token. For more information about the field, see the errorInformation.reason REST API field description.

Endpoint

Production:

POST https://api.cybersource.com/pts/v2/payments

Test:

POST https://apitest.cybersource.com/pts/v2/payments

Required Fields for a Pre-Authorization with a Token

clientReferenceInformation.code: Set this field value to
TransitDA BAU nominal value auth
.
clientReferenceInformation.partner.thirdPartyCertificationNumber: Cybersource provides the value for this field.
clientReferenceInformation.transactionId
orderInformation.amountDetails.currency
orderInformation.amountDetails.totalAmount
paymentInformation.card.type
pointOfSaleInformation.catLevel: Set this field to
2
.
pointOfSaleInformation.emv. cardSequenceNumber
pointOfSaleInformation.entryMode: Set this field to
contactless
.
pointOfSaleInformation.operatingEnvironment
pointOfSaleInformation.terminalCapability: Set this field to
5
.
pointOfSaleInformation.terminalId
pointOfSaleInformation.terminalPinCapability: Set this field to
0
.
processingInformation.authorizationOptions.aggregatedAuthIndicator: Set this field to
true
.
processingInformation.authorizationOptions.deferredAuthIndicator: Set this field to
true
.
processingInformation.commerceIndicator: Set this field to
retail
.
processingInformation.industryDataType: Set this field to
transit
.
processingInformation.reconciliationId
tokenInformation.jti

Related Information

API field reference guide for the REST API

REST Example: Pre-Authorization with a Token

Request

{
  "clientReferenceInformation": {
    "code": "TransitDA BAU nominal value auth",
    "transactionId": "12845679",
    "partner": {
      "thirdPartyCertificationNumber": "123456789012"
    }
  },
  "pointOfSaleInformation": {
    "operatingEnvironment": "2",
    "terminalPinCapability": "0",
    "catLevel": "2",
    "terminalId": "12345678",
    "entryMode": "contactless",
    "terminalCapability": "5",
    "emv": {
      "cardSequenceNumber": "01"
    }
  },
  "processingInformation": {
    "reconciliationId": "7866535268",
    "commerceIndicator": "retail",
    "industryDataType": "transit",
    "authorizationOptions": {
      "aggregatedAuthIndicator": "true",
      "deferredAuthIndicator": "true"
    }
  },
  "orderInformation": {
    "amountDetails": {
      "totalAmount": "1",
      "currency": "THB"
    }
  },
  "tokenInformation": {
    "jti": "c76392f4-cde4-11aa-b8bc-0242ac14c074"
  },
  "paymentInformation": {
    "card": {
      "type": "062"
    }
  }
}

Response to a Successful Request

{
  "_links": {
    "authReversal": {
      "method": "POST",
      "href": "/pts/v2/payments/7012384708016080703137/reversals"
    },
    "self": {
      "method": "GET",
      "href": "/pts/v2/payments/7012384708016080703137"
    },
    "capture": {
      "method": "POST",
      "href": "/pts/v2/payments/7012384708016080703137/captures"
    }
  },
  "clientReferenceInformation": {
    "code": "TransitDA BAU nominal value auth",
    "transactionId": "12845679"
  },
  "id": "7012384708016080703137",
  "orderInformation": {
    "amountDetails": {
      "authorizedAmount": "1.00",
      "currency": "THB"
    }
  },
  "paymentAccountInformation": {
    "card": {
      "type": "062"
    }
  },
  "paymentInformation": {
    "tokenizedCard": {
      "type": "062"
    },
    "card": {
      "type": "062"
    }
  },
  "processorInformation": {
    "approvalCode": "005290",
    "settlementDate": "0501",
    "responseCode": "00",
    "avs": {
      "code": "2"
    }
  },
  "reconciliationId": "333306641171",
  "status": "AUTHORIZED",
  "submitTimeUtc": "2023-11-29T06:14:33Z"
}

Response to a Successful Request Under First Ride Risk Liability

{
  "_links": {
    "self": {
      "method": "GET",
      "href": "/pts/v2/payments/7012384708016080703137"
    }
  },
  "clientReferenceInformation": {
    "code": "TransitDA BAU nominal value auth"
  },
  "errorInformation": {
    "reason": "AUTH_DECLINE_CAPTURE_POSSIBLE",
    "message": "Authorization Declined. Follow-on Capture can be processed."
  },
  "id": "7078109972977125857011",
  "paymentInsightsInformation": {
    "responseInsights": {
      "categoryCode": "97",
      "category": "PAYMENT_INSIGHTS_INTERNAL_ERROR"
    }
  },
  "processorInformation": {
    "responseCode": "58",
    "avs": {
      "code": "2"
    }
  },
  "status": "AUTHORIZED"
}