PApaymentology
3DS

(Mock) ACS Client Authorization

Changed on

This API provides 3DS authentication for APATA. It reads the request and mocks a authentication response.

post/pws/pws_apata_auth_client/

Request

  • Base URL
    https://api.uat.paymentology.com/ppws/api
  • URL
    https://api.uat.paymentology.com/ppws/api/pws/pws_apata_auth_client/
  • Auth
    none declared

Request body

clientIdinteger

Unique identifier assigned to the client by Paymentology system

ridinteger

Transaction identifier generated by Paymentology system

acsTranIdstring

Unique txn ID generated by ACS for every transaction

tokeninteger

Unique token assigned to each PAN (card number)

messageCategorystring
<ul><li class="docBullet">01 - Payment</li><li class="docBullet">02 - Non-Payment</li></ul>
merchantNamestring

Name of Merchant where transaction was initiated

txnAmountnumber

Transaction amount in minor units of the ongoing transaction

txnCurrencystring

Currency in which amount is expressed

authTypeinteger

Authentication type required by the cardholder.<ul><li class="docBullet">0 - No Client Authentication – (OTP via API)</li><li class="docBullet">1 - Client authentication (OOB)</li></ul>

otpstring

One time passcode to be sent to the cardholder either via SMS or Push notification or any other medium

languagePreferencestring

Language Preference sent from Paymentology system

additionalDatastring

Additional data that may be used in the future

merchantRedirectUrlstring

Url of the merchant app which can be used to redirect cardholders

merchantURLstring

Merchant App URL that Authentication App can call the Merchant app after OOB authentication has occurred.

merchantAppRedirectURLstring

Merchant app declaring their URL within the CReq message, so that the ACS can redirect the cardholder to the merchant app after OOB authentication has occurred.

otpReferenceCodestring

Unique value generated with each new OTP value

stepupRequestIdstring

Unique identifier for the step-up authentication request

Example request

{
  "clientId": 12345,
  "rid": 10000,
  "acsTranId": "559b5bc7-b1ca-4872-bc9d-6f55cad7a790",
  "token": 11223344,
  "messageCategory": "01",
  "merchantName": "Unknown",
  "txnAmount": 123.45,
  "txnCurrency": "840",
  "authType": 1,
  "otp": "email",
  "languagePreference": "12345",
  "additionalData": "{}",
  "merchantRedirectUrl": "http://example.com",
  "merchantURL": "merchantScheme://appName?transID=b2385523-a66c-4907-ac3c-91848e8c0067",
  "merchantAppRedirectURL": "merchantScheme://appName?transID=b2385523-a66c-4907-ac3c-91848e8c0067",
  "otpReferenceCode": "12312311",
  "stepupRequestId": "550e8400-e29b-41d4-a716-446655440000"
}

Response

Successful Response

ridinteger

Unique authentication reference received in the request.

tokeninteger

Unique card token received in the request

responseCodestring

Response code to indicate whether transaction was success or failed.

<ul><li class="docBullet">00 - Success</li><li class="docBullet">01 - Declined</li></ul>
descriptionstring

Result description

authenticationPerformedstring

Performed authentication methods

Example response

{
  "rid": 10000,
  "token": 11223344,
  "responseCode": "00",
  "description": "success",
  "authenticationPerformed": "12345"
}

Changes