3D Secure

3D Secure is a way to authenticate and protect transactions. Typically, it's only possible to protect the initial transaction in an order with 3D Secure.

Retrieve a list of ThreeDSecure entries

Authorizations:
query Parameters
limit
integer [ 0 .. 1000 ]

The collection items limit.

offset
integer >= 0

The collection items offset.

header Parameters
Organization-Id
string (ResourceId) <= 50 characters
Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21

Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).

Responses

Response Headers
Rate-Limit-Limit
integer

The number of allowed requests in the current period.

Rate-Limit-Remaining
integer

The number of remaining requests in the current period.

Rate-Limit-Reset
string

The date in format defined by RFC 822 when the current period will reset.

Pagination-Total
integer

Total items count.

Pagination-Limit
integer

Items per page limit.

Pagination-Offset
integer

Pagination offset.

Response Schema: application/json
Array ()
id
string <= 50 characters

The 3D Secure entry identifier string.

customerId
required
string <= 50 characters

Related customer ID.

gatewayAccountId
required
string <= 50 characters

Related gateway account ID.

paymentCardId
required
string <= 50 characters

Related payment card ID.

websiteId
required
string <= 50 characters

Related Website ID.

enrolled
required
string
Enum: "Y" "N" "U"

Is the cardholder enrolled in 3DSecure.

enrollmentEci
required
string

The 3D Secure entry enrollment eci.

eci
integer

The 3D Secure entry electronic commerce indicator.

cavv
string

The 3D Secure entry cardholder authentication verification value.

xid
string

The 3D Secure entry transaction Id.

payerAuthResponseStatus
string
Enum: "Y" "N" "U" "A"

The 3D Secure entry Auth Response Status.

signatureVerification
string
Enum: "Y" "N"

If signature was verified.

amount
required
number <double>

Transaction amount.

currency
required
string 3 characters

ISO 4217 alphabetic currency code.

createdTime
string <date-time>

The 3D Secure entry created time.

Array of objects (SelfLink) non-empty

The links related to resource.

Request samples

// all parameters are optional
const firstCollection = await api.threeDSecure.getAll();

// alternatively you can specify one or more of them
const params = {limit: 20, offset: 100}; 
const secondCollection = await api.threeDSecure.getAll(params);

// access the collection items, each item is a Member
secondCollection.items.forEach(entry => console.log(entry.fields.customerId));

Response samples

Content type
application/json
[
  • {
    }
]

Create a ThreeDSecure entry

Create a ThreeDSecure entry.

Authorizations:
header Parameters
Organization-Id
string (ResourceId) <= 50 characters
Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21

Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).

Request Body schema: application/json

ThreeDSecure resource.

customerId
required
string <= 50 characters

Related customer ID.

gatewayAccountId
required
string <= 50 characters

Related gateway account ID.

paymentCardId
required
string <= 50 characters

Related payment card ID.

websiteId
required
string <= 50 characters

Related Website ID.

enrolled
required
string
Enum: "Y" "N" "U"

Is the cardholder enrolled in 3DSecure.

enrollmentEci
required
string

The 3D Secure entry enrollment eci.

eci
integer

The 3D Secure entry electronic commerce indicator.

cavv
string

The 3D Secure entry cardholder authentication verification value.

xid
string

The 3D Secure entry transaction Id.

payerAuthResponseStatus
string
Enum: "Y" "N" "U" "A"

The 3D Secure entry Auth Response Status.

signatureVerification
string
Enum: "Y" "N"

If signature was verified.

amount
required
number <double>

Transaction amount.

currency
required
string 3 characters

ISO 4217 alphabetic currency code.

Responses

Response Headers
Rate-Limit-Limit
integer

The number of allowed requests in the current period.

Rate-Limit-Remaining
integer

The number of remaining requests in the current period.

Rate-Limit-Reset
string

The date in format defined by RFC 822 when the current period will reset.

Response Schema: application/json
id
string <= 50 characters

The 3D Secure entry identifier string.

customerId
required
string <= 50 characters

Related customer ID.

gatewayAccountId
required
string <= 50 characters

Related gateway account ID.

paymentCardId
required
string <= 50 characters

Related payment card ID.

websiteId
required
string <= 50 characters

Related Website ID.

enrolled
required
string
Enum: "Y" "N" "U"

Is the cardholder enrolled in 3DSecure.

enrollmentEci
required
string

The 3D Secure entry enrollment eci.

eci
integer

The 3D Secure entry electronic commerce indicator.

cavv
string

The 3D Secure entry cardholder authentication verification value.

xid
string

The 3D Secure entry transaction Id.

payerAuthResponseStatus
string
Enum: "Y" "N" "U" "A"

The 3D Secure entry Auth Response Status.

signatureVerification
string
Enum: "Y" "N"

If signature was verified.

amount
required
number <double>

Transaction amount.

currency
required
string 3 characters

ISO 4217 alphabetic currency code.

createdTime
string <date-time>

The 3D Secure entry created time.

Array of objects (SelfLink) non-empty

The links related to resource.

Request samples

Content type
application/json
{
  • "customerId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "gatewayAccountId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "paymentCardId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "websiteId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "enrolled": "Y",
  • "enrollmentEci": "string",
  • "eci": 0,
  • "cavv": "string",
  • "xid": "string",
  • "payerAuthResponseStatus": "Y",
  • "signatureVerification": "Y",
  • "amount": 0,
  • "currency": "USD"
}

Response samples

Content type
application/json
{
  • "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "customerId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "gatewayAccountId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "paymentCardId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "websiteId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "enrolled": "Y",
  • "enrollmentEci": "string",
  • "eci": 0,
  • "cavv": "string",
  • "xid": "string",
  • "payerAuthResponseStatus": "Y",
  • "signatureVerification": "Y",
  • "amount": 0,
  • "currency": "USD",
  • "createdTime": "2019-08-24T14:15:22Z",
  • "_links": [
    ]
}

Retrieve a ThreeDSecure entry

Retrieve a ThreeDSecure entry with specified identifier string.

Authorizations:
path Parameters
id
required
string <= 50 characters ^[@~\-\.\w]+$

The resource identifier string.

header Parameters
Organization-Id
string (ResourceId) <= 50 characters
Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21

Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).

Responses

Response Headers
Rate-Limit-Limit
integer

The number of allowed requests in the current period.

Rate-Limit-Remaining
integer

The number of remaining requests in the current period.

Rate-Limit-Reset
string

The date in format defined by RFC 822 when the current period will reset.

Response Schema: application/json
id
string <= 50 characters

The 3D Secure entry identifier string.

customerId
required
string <= 50 characters

Related customer ID.

gatewayAccountId
required
string <= 50 characters

Related gateway account ID.

paymentCardId
required
string <= 50 characters

Related payment card ID.

websiteId
required
string <= 50 characters

Related Website ID.

enrolled
required
string
Enum: "Y" "N" "U"

Is the cardholder enrolled in 3DSecure.

enrollmentEci
required
string

The 3D Secure entry enrollment eci.

eci
integer

The 3D Secure entry electronic commerce indicator.

cavv
string

The 3D Secure entry cardholder authentication verification value.

xid
string

The 3D Secure entry transaction Id.

payerAuthResponseStatus
string
Enum: "Y" "N" "U" "A"

The 3D Secure entry Auth Response Status.

signatureVerification
string
Enum: "Y" "N"

If signature was verified.

amount
required
number <double>

Transaction amount.

currency
required
string 3 characters

ISO 4217 alphabetic currency code.

createdTime
string <date-time>

The 3D Secure entry created time.

Array of objects (SelfLink) non-empty

The links related to resource.

Request samples

const entry = await api.threeDSecure.get({id: 'foobar-001'});
console.log(entry.fields.customerId);

Response samples

Content type
application/json
{
  • "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "customerId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "gatewayAccountId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "paymentCardId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "websiteId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "enrolled": "Y",
  • "enrollmentEci": "string",
  • "eci": 0,
  • "cavv": "string",
  • "xid": "string",
  • "payerAuthResponseStatus": "Y",
  • "signatureVerification": "Y",
  • "amount": 0,
  • "currency": "USD",
  • "createdTime": "2019-08-24T14:15:22Z",
  • "_links": [
    ]
}