Skip to main content

authentication

3D Secure authentication details.

    id string

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

    eci number

    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.

    cavv string

    Possible values: <= 80 characters

    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.

    xid string

    Possible values: <= 40 characters

    This is the transaction identifier returned by the card issuer.

    status string

    Possible values: [COMPLETED , FAILED]

    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.

    merchantRefNum string

    Possible values: <= 255 characters

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

    threeDEnrollment string

    Possible values: [Y, N, U]

    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

    threeDResult string

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

    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.

    signatureStatus string

    Possible values: [Y, N]

    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.

    error

    object

    Details of the error.

    code string

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

    message string

    A description of the error.

    details string[]

    Details of any parameter value errors.

    fieldErrors

    object[]

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

  • Array [

    • field string

    Identifies the JSON request field.

    error string

    The problem associated with field.

  • ]