Verify 3Ds authentication status

POST 
/customers/:customerId/prepaid/cards/:cardId/3ds-authentications/:auth3dsId

The endpoint will update the status of the 3D Secure authentication, and based on the provided status, the authorization request will be either VERIFIED or REJECTED.

Request

Path Parameters

customerId stringrequired

Unique identifier of the customer.

cardId stringrequired

UUID based Card id.

auth3dsId stringrequired

Authentication 3DS id.

application/json

Body

Information about the status of the 3DS authentication and the method used for it.

walletOperationId stringrequired

A distinct identifier for the 3DS operation.

verification

object

required

Contains information about the mechanism used during the verification.

method Auth3dsMethod (string)required

Possible values: [BIOMETRIC]

Authentication method.

status Auth3dsStatus (string)required
Possible values: [VERIFIED, REJECTED, FAILED]
• VERIFIED - The 3DS authentication process has been successfully completed, and the given authorization attempt is permited.
• REJECTED - The 3DS authentication process has been rejected by the user, preventing from the authorzation request to complete.
• FAILED - The 3DS authentication process has failed, preventing the authorzation to complete. Please refer to statusReason for further information.
statusReason string

Possible values: <= 100 characters

Reason for the unsuccessful 3DS authentication.

Responses

201

Created

application/json

Schema

Schema

walletOperationId stringrequired

A distinct identifier for the 3DS operation.

verification

object

required

Contains information about the mechanism used during the verification.

method Auth3dsMethod (string)required

Possible values: [BIOMETRIC]

Authentication method.

status Auth3dsStatus (string)required
Possible values: [VERIFIED, REJECTED, FAILED]
• VERIFIED - The 3DS authentication process has been successfully completed, and the given authorization attempt is permited.
• REJECTED - The 3DS authentication process has been rejected by the user, preventing from the authorzation request to complete.
• FAILED - The 3DS authentication process has failed, preventing the authorzation to complete. Please refer to statusReason for further information.
statusReason string

Possible values: <= 100 characters

Reason for the unsuccessful 3DS authentication.

customerId stringrequired

Unique identifier of the customer.

cardId stringrequired

UUID based Card id.

auth3dsId stringrequired

Authentication 3DS id.

creationTime date-timerequired

Represents creation RFC 3339, section 5.6 date-time.

Example (from schema)

{
  "walletOperationId": "bbbd87eb-08a9-437b-a9a7-df47b601593b",
  "verification": {
    "method": "BIOMETRIC"
  },
  "status": "VERIFIED",
  "statusReason": "string",
  "customerId": "5435323362",
  "cardId": "string",
  "auth3dsId": "string",
  "creationTime": "2021-07-15T17:54:12Z"
}

VERIFIED_3DS_AUTHENTICATION

{
  "walletOperationId": "bbbd87eb-08a9-437b-a9a7-df47b601593b",
  "verification": {
    "method": "BIOMETRIC"
  },
  "status": "VERIFIED",
  "customerId": "5435323362",
  "cardId": "ff3713e7-61f5-4c54-9131-81ba820c2efa",
  "auth3dsId": "41260ee6-4b29-43c8-8e00-4c911f0179f9",
  "creationTime": "2021-07-15T17:54:12Z"
}

EXPIRED_3DS_AUTHENTICATION_REQUEST

{
  "walletOperationId": "bbbd87eb-08a9-437b-a9a7-df47b601593b",
  "verification": {
    "method": "BIOMETRIC"
  },
  "status": "FAILED",
  "statusReason": "3DS authentication request has expired.",
  "customerId": "5435323362",
  "cardId": "ff3713e7-61f5-4c54-9131-81ba820c2efa",
  "auth3dsId": "41260ee6-4b29-43c8-8e00-4c911f0179f9",
  "creationTime": "2021-07-15T17:54:12Z"
}

400

Bad Request

application/json

Schema

Schema

error

object

Represents details of an error.

code string

The error code.

message string

The description of the error.

details string[]

Details for the errors of any parameter value.

fieldErrors

object[]

List of field errors associated with the main error.

Array [

field string

Identifies the JSON request field.

error string

The problem associated with the field.

]

Example (from schema)

{
  "error": {
    "code": "string",
    "message": "string",
    "details": [
      "string"
    ],
    "fieldErrors": [
      {
        "field": "string",
        "error": "string"
      }
    ]
  }
}

MISSING_VERIFICATION_METHOD

{
  "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": "verification.method",
        "error": "must not be null"
      }
    ]
  }
}

401

Unauthorized

application/json

Schema

Schema

error

object

Represents details of an error.

code string

The error code.

message string

The description of the error.

details string[]

Details for the errors of any parameter value.

fieldErrors

object[]

List of field errors associated with the main error.

Array [

field string

Identifies the JSON request field.

error string

The problem associated with the field.

]

Example (from schema)

{
  "error": {
    "code": "string",
    "message": "string",
    "details": [
      "string"
    ],
    "fieldErrors": [
      {
        "field": "string",
        "error": "string"
      }
    ]
  }
}

INVALID_CREDENTIALS

{
  "error": {
    "code": "5279",
    "message": "Invalid credentials",
    "details": [
      "The authentication credentials are invalid."
    ]
  }
}

500

Internal Server Error

application/json

Schema

Schema

error

object

Represents details of an error.

code string

The error code.

message string

The description of the error.

details string[]

Details for the errors of any parameter value.

fieldErrors

object[]

List of field errors associated with the main error.

Array [

field string

Identifies the JSON request field.

error string

The problem associated with the field.

]

Example (from schema)

{
  "error": {
    "code": "string",
    "message": "string",
    "details": [
      "string"
    ],
    "fieldErrors": [
      {
        "field": "string",
        "error": "string"
      }
    ]
  }
}

INTERNAL_SERVER_ERROR

{
  "error": {
    "code": "DW-INTERNAL-SERVER-ERROR",
    "message": "Internal Server Error",
    "details": [
      "There was an error while processing the operation"
    ]
  }
}

503

Service Unavailable

application/json

Schema

Schema

error

object

Represents details of an error.

code string

The error code.

message string

The description of the error.

details string[]

Details for the errors of any parameter value.

fieldErrors

object[]

List of field errors associated with the main error.

Array [

field string

Identifies the JSON request field.

error string

The problem associated with the field.

]

Example (from schema)

{
  "error": {
    "code": "string",
    "message": "string",
    "details": [
      "string"
    ],
    "fieldErrors": [
      {
        "field": "string",
        "error": "string"
      }
    ]
  }
}

SERVICE_UNAVAILABLE

{
  "error": {
    "code": "DW-SERVICE-UNAVAILABLE",
    "message": "Service Unavailable",
    "details": [
      "Service Unavailable"
    ]
  }
}

Loading...