authentication

3D Secure authentication details.

idstring

This is the ID of authentication, returned in the response.

Example: 5d4db3bc-34c9-417f-a051-0d992ad9284e

ecinumber

This is the E-Commerce Indicator (ECI). This value will be returned only on payer authentication transactions, or for enrollments where the issuer is non-participating and the card scheme supports it. This value must be appended to the authorization request, where it enables the interchange benefits granted to merchants processing payer Authentication transactions.

Visa

5 – Identifies a successfully authenticated transaction.
6 – Identifies an attempts authenticated transaction.
7 – Identifies a non-authenticated transaction.

Mastercard

1 - Identifies a non-authenticated transaction.
2 - Identifies a successfully authenticated transaction.

Example: 5

cavvstring

This is the Cardholder Authentication Verification Value, indicating that the transaction has been authenticated. This value should be appended to the authorization request signifying that the transaction has been successfully authenticated.

Possible values: <= 80 characters

Example: AAABBhkXYgAAAAACBxdiENhf7A+=

xidstring

This is the transaction identifier returned by the card issuer.

Possible values: <= 40 characters

Example: aWg4N1ZZOE53TkFrazJuMmkyRDA=

statusstring

This is the status of the Enrollment Lookup request. Possible values are:

COMPLETED - The transaction has been completed.
FAILED - The authentication request failed. Check the error code for details.

Possible values: [COMPLETED , FAILED]

merchantRefNumstring

This is the merchant reference number created by the merchant and submitted as part of the request. It must be unique for each request.

Possible values: <= 255 characters

Example: merchantABC-123-authentications

threeDEnrollmentstring

This indicates whether or not the cardholder is enrolled in 3D Secure. Possible values are:

Y – Cardholder authentication available.
N – Cardholder not enrolled in authentication.
U – Cardholder authentication unavailable

Possible values: [Y, N, U]

threeDResultstring

This indicates the outcome of the Authentication.

Y – The cardholder successfully authenticated with their card issuer.
A – The cardholder authentication was attempted.
N – The cardholder failed to successfully authenticate with their card issuer.
U – Authentication with the card issuer was unavailable.
E – An error occurred during authentication.

Possible values: [Y, A, N, U, E]

signatureStatusstring

This is the 3D Secure signature verification result value.

Y – All transaction and signature checks satisfied.
N – At least one transaction or signature check failed.

Possible values: [Y, N]

error object

Details of the error.

codestring

The error code. Also shown in the X-Application-Status-Code response header.

Example: 5068

messagestring

A description of the error.

Example: Field error(s)

detailsstring[]

Details of any parameter value errors.

fieldErrors object[]

If applicable, this is a list of fields that have issues.

Array [

fieldstring

Identifies the JSON request field.

Example: accountId

errorstring

The problem associated with field.

Example: AccountId is missing in the request. If multiple accounts are registered with same currency, accountId is mandatory.

]

authentication
{
  "id": "5d4db3bc-34c9-417f-a051-0d992ad9284e",
  "eci": 5,
  "cavv": "AAABBhkXYgAAAAACBxdiENhf7A+=",
  "xid": "aWg4N1ZZOE53TkFrazJuMmkyRDA=",
  "status": "COMPLETED ",
  "merchantRefNum": "merchantABC-123-authentications",
  "threeDEnrollment": "Y",
  "threeDResult": "Y",
  "signatureStatus": "Y",
  "error": {
    "code": "5068",
    "message": "Field error(s)",
    "details": [
      "Either you submitted a request that is missing a mandatory field or the value of a field does not match the format expected."
    ],
    "fieldErrors": [
      {
        "field": "accountId",
        "error": "AccountId is missing in the request. If multiple accounts are registered with same currency, accountId is mandatory."
      }
    ]
  }
}