On This Page
Pre-Authorization Bundled with Payer Authentication
Enroll Service
When a customer is authenticated without a challenge, the transaction can be authorized
either in the same request or in a separate authorization request. Whether authorization
occurs in the same request or a separate request, the values from the check enrollment
response must be passed to the authorization request to qualify for a liability shift.
This section provides information on how to process a pre-authorization combined with
authentication of the cardholder that does not require additional authentication.
For more information about Payer Authentication, see the
Payer Authentication Developer Guide
. Processor-Specific Information
National Payment Gateway
requires payer authentication data in customer-initiated transactions.When the domestic scheme directory server for mada cards is not available and
authentication falls back to the global scheme directory server, the authentication
brand response field indicates which directory server was used during the
authentication process.
Endpoint
Production:
POST
https://api.sa.cybersource.com
/pts/v2/paymentsTest:
POST
https://apitest.sa.cybersource.com
/pts/v2/paymentsRequired Fields for a Pre-Authorization with Payer Authentication Enroll Service
REST Example: Pre-Authorization with Payer Authentication
Enroll Service
Request
This example includes optional fields.
{ "clientReferenceInformation": { "code": "SPG_REQ_01" }, "consumerAuthenticationInformation": { "referenceId": "CybsCruiseTester-da287c74", "overrideCountryCode": "SA", "deviceChannel": "Browser", "challengeCode": "04" }, "processingInformation": { "actionList": [ "CONSUMER_AUTHENTICATION" ], }, "orderInformation": { "billTo": { "firstName": "Abdullah", "lastName": "Muhammad", "phoneNumber": "01-4844094", "address2": "P.O.Box: 16335", "address1": "Al Dariyah Dist.", "postalCode": "22028", "email": "[email protected]" }, "amountDetails": { "totalAmount": "3001", "currency": "SAR" }, "invoiceDetails": { "purchaseOrderNumber": "PurchaseOrderNumber123" } }, "aggregatorInformation": { "subMerchant": { "id": "001" } }, "merchantInformation": { "categoryCode": 5411, "merchantDescriptor": { "country": "SA", "address1": "API Address", "postalCode": "12987-7318", "locality": "Riyadh", "name": "API Merchant-Name1" } }, "paymentInformation": { "card": { "expirationYear": "2031", "number": "CARD_NUMBER", "securityCode": "123", "expirationMonth": "12", "type": "060" } } }
Response to a Successful Request
{ "paymentInformation": { "bin": "968208", "issuer": "Al Bank Al Saudi Al Fransi", "binCountry": "SA", "cardBrand": "MADA", "cardType": "PREPAID" }, "consumerAuthenticationInformation": { "challengeRequired": "N", "authenticationTransactionId": "rx39Q8ZN7aPE0bHxoSe1", "strongAuthentication": { "OutageExemptionIndicator": "0" }, "acsUrl": "https://1merchantacsstag.cardinalcommerce.com/MerchantACSWeb/creq.jsp", "acsReferenceNumber": "Cardinal ACS", "stepUpUrl": "https://centinelapistag.cardinalcommerce.com/V2/Cruise/StepUp", "pareq": "eyJtZXNzYWdl-short-example", "directoryServerTransactionId": "b435dda8-a2b0-490e-ae39-1b7e01d1dc4e", "veresEnrolled": "Y", "threeDSServerTransactionId": "0cd884bb-c8ef-4dfc-97e1-a78b741c42b8", "acsOperatorID": "MerchantACS", "specificationVersion": "2.2.0", "acsTransactionId": "1231149d-299b-4a64-ba89-3ab10e538b48" }, "embeddedActions": { "CONSUMER_AUTHENTICATION": { "reason": "CONSUMER_AUTHENTICATION_REQUIRED", "message": "The cardholder is enrolled in Payer Authentication. Please authenticate the cardholder before continuing with the transaction.", "status": "PENDING_AUTHENTICATION" } }, "submitTimeUtc": "2024-01-29T14:43:14Z", "id": "7065393947881234567890", "errorInformation": { "reason": "CONSUMER_AUTHENTICATION_REQUIRED", "message": "The cardholder is enrolled in Payer Authentication. Please authenticate the cardholder before continuing with the transaction." }, "status": "PENDING_AUTHENTICATION", "clientReferenceInformation": { "code": "TC_SPG_REQUEST_PB-159" } }