On This Page
Pre-Authorization Bundled with Payer Authentication
Validate Service
When a customer is authenticated after a challenge, the transaction can be authorized in
the same request or in a separate authorization request. Whether authorization is
combined with validation or occurs in a separate request, the values from the validation
response must be passed to the authorization request to qualify for a liability shift to
the issuing bank. This section provides information on how to process that type of
transaction.
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 Validate Service
REST Example: Pre-Authorization with Payer Authentication
Validate Service
Request
This example includes optional fields.
{ "clientReferenceInformation": { "code": "SPG_REQ_01" }, "consumerAuthenticationInformation": { "referenceId": "CybsCruiseTester-d47f8d5c", "overrideCountryCode": "SA", "deviceChannel": "Browser", "authenticationTransactionId": "8HuyDYiugte0I1RxiRU1", "challengeCode": "04" }, "processingInformation": { "actionList": [ "VALIDATE_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": "AlBankAlSaudiAlFransi", "binCountry": "SA", "cardBrand": "MADA", "cardType": "PREPAID" }, "consumerAuthenticationInformation": { "eciRaw": "05", "authenticationTransactionId": "fggOjcMXWKXFpxzAI0N1", "strongAuthentication": { "OutageExemptionIndicator": "0" }, "effectiveAuthenticationType": "FR", "authorizationPayload": "eyJjb250YWluZXJWZXJ-short-example", "eci": "05", "cavv": "AJkBBkhgQQAAAE4gSEJydQAAAAA=", "paresStatus": "Y", "acsReferenceNumber": "Cardinal ACS", "xid": "AJkBBkhgQQAAAE4gSEJydQAAAAA=", "directoryServerTransactionId": "e6a43429-7310-4ea1-b903-6a35941d9150", "veresEnrolled": "Y", "threeDSServerTransactionId": "827d03b1-e93b-4b81-9086-f0d257640e8b", "acsOperatorID": "MerchantACS", "ecommerceIndicator": "mada", "specificationVersion": "2.2.0", "acsTransactionId": "33c16320-5b5c-4569-9703-fb1a4c6f8858" }, "embeddedActions": { "CONSUMER_AUTHENTICATION": { "status": "AUTHENTICATION_SUCCESSFUL" } }, "paymentAccountInformation": { "card": { "currency": "SAR", "type": "060" } }, "orderInformation": { "amountDetails": { "currency": "SAR", "authorizedAmount": "100.00" } }, "processorInformation": { "approvalCode": "830SPG", "retrievalReferenceNumber": "333417123456", "cardVerification": { "resultCode": "M", "resultCodeRaw": "M" }, "responseCode": "00", "consumerAuthenticationResponse": { "code": "2", "codeRaw": "2" }, "settlementDate": "220915" }, "_links": { "self": { "method": "GET", "href": "/pts/v2/payments/7013657600822661348823" }, "refund": { "method": "POST", "href": "/pts/v2/payments/7013657600822661348823/refunds" } }, "clientReferenceInformation": { "code": "TC_SPG_REQUEST_PB-54" }, "consumerAuthenticationInformation": { "token": "abc" }, "reconciliationId": "7013657600822661348823", "status": "COMPLETED", "id": "7013657600822661348823", "submitTimeUtc": "2023-11-30T17:36:00Z" }