Authentication Enquiry
This API is used to get authentication result in case challenge.
Note:
• Please refer to the step number 27 in the above diagram.
Request
Field name | Type | Description |
---|---|---|
threeDsServerTransId | String | Generated by 3DS provider. This value is in lookup response and callback. |
externalReferenceId | String | Unique authentication Id which is generated by 3DS Requestor. Conditional only if available |
Response
Sample API (UAT):
POST Method
1) Enquiry Request Fields format and description
Header
Field Name | Data Type | Example | Description | Requirement |
---|---|---|---|---|
Authorization | String | Bearer xxxx | Required | |
Content-Type | String | application/json | Required |
Body
Field Name | Data Type | Example | Description | Requirement |
---|---|---|---|---|
externalReferenceId |
String |
Unique authentication Id which is generated by 3DS Requestor |
||
threeDsServerTransId |
String |
"8a880dc0-d2d2-4067-bcb1-b08d1690b26e" |
3DS Server transaction ID or transactionID Generated by 3DS provider. This value is in lookup response and callback. |
If both parameter passed, we take threeDsServerTransId as a higher priority. |
Full Request example:
Request Header:
POST /enquiry
Content-Type: application/json
Authorization: Bearer xxx
Request Body:
{
"threeDsServerTransId": "8a880dc0-d2d2-4067-bcb1-b08d1690b26e"
}
Or
{
"externalReferenceId": "795baa56-204d-42bd-a9c8-4cf0b7a567bd”
}
2) Enquiry Response Filed format and description
Field Name | Data Type | Example | Description | Requirement |
---|---|---|---|---|
threeDsServerTransId |
String 36 characters |
"8a880dc0-d2d2- |
Unique transaction identifier assigned by the 3DS Server to identify a single transaction. |
Required |
dsTransId |
String 36 characters |
"8a890900- |
Unique transaction identifier assigned by the Directory Server (DS) to identify a single transaction. NOTE: Required for Mastercard Identity Check transaction in Authorization |
Required |
authenticationValue |
String 28 characters |
"xgSUOhRfAAA |
CAVV |
Required |
transactionStatus |
String 1 character |
“Y” |
Transactions status result identifier. Possible Values: Y - Successful Authentication N - Failed Authentication / Account Not Verified / Transaction Denied U - Unable to Complete Authentication A - Successful Attempts Transaction C** - Challenge Required for Authentication R** - Authentication Rejected (Merchant must not submit for authorization) D - Challenge Required; Decoupled Authentication confirmed. I - Informational Only; 3DS Requestor challenge preference acknowledged. NOTE: Statuses of C and R only apply to Consumer authentication 2.0. |
Required |
eci |
String 2 characters |
"05" |
Electronic Commerce Indicator (ECI). Possible Values: Mastercard - 02, 01, 00 |
Required |
Enquiry Response
Success Response example:
{
"dsTransId": "9999999-bcb1-b08d1690b26e",
"threeDsServerTransId": "8a880dc0-d2d2-4067-bcb1-b08d1690b26e",
"authenticationValue": "xgSUOhRfAAAAAAAAAAAAAAAAAAAA",
"eci": "05",
"transactionStatus": "Y"
}
Error Response
Field Name | Data Type | Format | Example | Description |
---|---|---|---|---|
status | String | 1 char | "U" - authentication failed | status of authentication |
error | String | 255 varchar | "2.0 is not supported for this card" | Error Description |
errorCode | String | 4 chars | "A002" | Error code |
emvErrorCode | String | 3 characters | Code indicating the type of problem identified in the message. | Required in Message Error |
emvErrorComponent | String | 1 character | Code indicating the 3-D Secure component that identified the error. | Required in Message Error |
emvErrorDescription | String | 2048 characters | Text describing the problem identified in the message. | Required in Message Error |
emvErrorDetail | String | 2048 characters | Additional detail regarding the problem identified in the message. | Required in Message Error |
Error Response example:
{
"status": "string",
"error": "string",
"errorCode": "string",
"emvError": {
"emvErrorCode": "string",
"emvErrorComponent": "string",
"emvErrorDescription": "string",
"emvErrorDetail": "string"
}
}
Updated 2 days ago