v1

latestOpenAPI 3.0.0All rights reserved2026-07-2439128156.3 KB

3D Secure

3D Secure Lookup

3D Secure Card Lookup.

post/v2/clients/{ClientID}/3ds/lookup

Path parameters

ClientIDstring required

22-character <glossary:ClientID>. Ask TabaPay Support if you need to specify a <glossary:SubClientID>.

Query parameters

enhancedResponsestring required

Provides more granular detail in 3DS responses.

Request body

3dsIDstring required

3dsID returned from 3dsinit

sdkSessionIDstring

Mobile flow referenceID (used in conjunction with init.sdkVersion, comes from the SDK's setup.onComplete)

Required if the device channel is SDK.

authenticationIndicatorstring required

2-digit Authentication Indicator

transactionModestring

1-character Transaction Mode

transactionTypestring required

C is the only Transaction Type supported.

productCodestring required

3-character Product Code

Example request

{
  "account": {
    "owner": {
      "email": "test@tabapay.com",
      "phone": {
        "countryCode": "1",
        "number": "5555555555"
      },
      "name": {
        "first": "Tobias",
        "last": "Pennywick"
      },
      "address": {
        "country": "840"
      }
    }
  },
  "order": {
    "currency": "840"
  }
}

Response

A Lookup Response is returned.

SCinteger

HTTP Status Code

ECstring

Internal Error Code. This is used to help TabaPay team members trace an error.

EMstring

Short description of the error if an error occurred.

3dsVersionstring

The 3D Secure Version that was used to process this request.

Expected values are of the form: 2.X.X

enrolledstring

Authentication Eligibility Status

Possible Values:

Y Enrolled
N Not Enrolled
U Issuer Server Unavailable
B Merchant bypassed authentication

processorTransactionIDstring

Processor Transaction Identifier

dsTransactionIDstring

Directory Server Transaction Identifier

Save to pass to Create Transaction for a 3DS Payment

statusstring

Transaction Status Result

Possible Values:

Y Successful Authentication
N Failed Authentication
B Merchant bypassed authentication
U Unable to Complete Authentication
A Successful Attempts Transaction
C Challenge Required for Authentication
R Authentication Rejected
I Informational Only; 3DS Requester challenge preference acknowledged

ECIstring

Electronic Commerce Indicator

Possible Values:

UCAFstring

Universal Cardholder Authentication Field

Visa uses <glossary:CAVV> (Cardholder Authentication Verification Value)

MasterCard uses AAV (Account-Holder Authentication Value)

XIDstring

XID (Transaction ID)

Optional

challengeURLstring

Consumer Authentication URL

Only present if Challenge

payloadstring

Base64 Encoded Payment Request

Only present if Challenge

cardholderInfostring

Text provided by the ACS/Issuer to Cardholder during a Frictionless transaction. The Issuer can provide information to Cardholder. For example: Additional authentication is needed for this transaction, please contact (Issuer Name) at xxx-xxx-xxxx. The Issuing Bank can optionally support this value. The merchant is required to display this within their Checkout when present.

signatureVerificationstring

Transaction Signature status identifier.

Possible Values: Y - Indicates that the signature of the PARes has been validated successfully and the message contents can be trusted. N - Indicates that the PARes could not be validated. This result could be for a variety of reasons; tampering, certificate expiration, etc., and the result should not be trusted.

stepUpURLstring

The fully qualified URL that the client uses to post the cardholder in order to complete the Consumer Authentication transaction for the Cardinal Cruise API integration. Note: This is only for a Cardinal Cruise API Integration

3dsRCstring

TabaPay Error Code for <glossary:3DS>, this should be 0 unless there is an issue. Please store this in your logs.

Example response

{
  "3dsVersion": "2.2.0",
  "enrolled": "Y",
  "processorTransactionID": "11111111111111111111",
  "dsTransactionID": "11111111-2222-3333-4444-555555555555",
  "status": "`Y`",
  "ECI": "05",
  "UCAF": "1111111111111111111111111111",
  "XID": "VkM0MXAwOGhjMGxuaUcxU1VtNjA=",
  "challengeURL": "https://someplace.somewhere.com/challenge"
}