3D Secure Card Lookup.
If you are an ISO (Independent Sales Organization), you will need to specify a SubClientID (see notes below).
URL:
https://<FQDN>/v2/clients/<ClientIDISO>/3ds/lookup
Request:
JSON Name | Value | Required | Default | Description | |||
---|---|---|---|---|---|---|---|
3dsID | String | R | 3dsID from 3D Secure Initialize | ||||
authenticationIndicator | String 2 digits |
R | |||||
transactionMode | String 1 character |
O | |||||
transactionType | String 1 character |
R | |||||
productCode | String 3 characters |
R | |||||
account | object | R | Account | ||||
accountID | String 22 characters |
R | AccountID | ||||
owner | object | R | Owner | ||||
String | R | Email Address | |||||
phone | object | O | Phone Number (E.164 Numbering) | ||||
countryCode | String 1-3 digits |
O | 1 | Country Calling Code | |||
number | String Min: 4 digits Max: 12-14 digits |
R | Phone Number | ||||
order | object | R | Order | ||||
orderID | String 1-50 characters |
R | Order Number | ||||
currency | String 3 digits |
O | 840 | ISO 4217 Currency Number | |||
amount | String Amount |
R | Transaction Amount | ||||
browser | object | R | Browser Info | ||||
javascriptEnabled | boolean | O | |||||
userAgent | String | O | |||||
header | String | O | |||||
javaEnabled | boolean | O | |||||
language | String | O | |||||
colorDepth | String | O | |||||
screenHeight | String | O | |||||
screenWidth | String | O | |||||
ipAddress | String | O | |||||
deviceChannel | String | R | Either:
|
Sample Request:
Pack your Request, the following Samples shown here are unpacked only for human readability:
{
"3dsID": "ID_BASE64-URL-SAFE-VALUE",
"authenticationIndicator": "01",
"transactionType": "C",
"productCode": "ACF",
"account": {
"accountID": "TabaPay_AccountID_22-c",
"owner": {
"email": "[email protected]"
}
},
"order": {
"orderID": "12345678",
"amount": "0.10"
},
"browser": {
"deviceChannel": "Browser"
}
}
Response:
Status Codes:
Status Code | Description | |
---|---|---|
200 | OK | A Lookup Response is returned. |
207 | Multi-Status | One or more Failures occurred while processing the Request. |
404 | Not Found | The AccountID does not point to a valid Account. |
See Status Codes for other possible Status Codes that might be returned.
Response Data:
JSON Name | Value | Description | Status Code | |||||
---|---|---|---|---|---|---|---|---|
200 | 200 Challenge |
207 | Other | |||||
SC | Integer 3-digit code |
HTTP Status Code | ✔ | ✔ | ✔ | O | ||
EC | String 1 or 8 characters |
Internal Error Code | ✔ | ✔ | ✔ | O | ||
EM | String | Error Message | O | O | ||||
3dsVersion | String | The 3D Secure Version that was used to process this request | ✔ | ✔ | ||||
enrolled | String | Authentication Eligibility Status | ✔ | ✔ | ||||
processorTransactionID | String | Processor Transaction Identifier | ✔ | ✔ | ||||
dsTransactionID | String | Directory Server Transaction Identifier | O | O | ||||
status | String | Status | ✔ | |||||
ECI | String | ECI (Electronic Commerce Indicator) | ✔ | |||||
UCAF | String | UCAF (Universal Cardholder Authentication Field)
|
✔ | |||||
XID | String | XID (Transaction ID) | O | |||||
challengeURL | String | Consumer Authentication URL | ✔ | |||||
payload | String | Encoded Payment Request | ✔ |
Sample Responses:
No Challenge:
{
"SC": 200,
"EC": "0",
"3dsVersion": "2.1.0",
"enrolled": "Y",
"processorTransactionID":"11111111111111111111",
"dsTransactionID": "11111111-2222-3333-4444-555555555555",
"status": "Y",
"ECI": "05",
"UCAF": "1111111111111111111111111111"
}
-----
Challenge:
{
"SC": 200,
"EC": "0",
"3dsVersion": "2.1.0",
"enrolled": "Y",
"processorTransactionID": "11111111111111111111",
"dsTransactionID": "11111111-2222-3333-4444-555555555555",
"challengeURL":"https://someplace.somewhere.com/challenge",
"payload":"A_LONG_PAYLOAD"
}
Notes:
For Clients who are an ISO (Independent Sales Organization), to specify your ClientID and a SubClientID, use the underscore character ("_") to separate the two values: <ClientID>_<SubClientID>
where:
- ClientID is your unique 22-character string and
- SubClientID is an assigned 4, 6 or 8-digit value.
Also please read the 3D Secure FAQ.