API de 3DS

Get all 3-D Secure operations

get

https://api.d1.thalescloud.io/banking/v1https://api.d1-stg.thalescloud.io/banking/v1

/issuers/{issuerId}/cards/{cardId}/3ds/operations

This request is used by the issuer backend to retrieve all operations related to a card. The API specifies the starting point (offset) and the number of operations (limit) to be retrieved. Offset 0 (the default) corresponds to the most recent operation. For example a limit of 5 and an offset of 2 would return the five most recent operations before the most recent two”.

If no operations are available for the given cardId, an empty list is returned.

Operations that are older than one year are removed.

Autorizaciones

bearerAuth

AuthorizationstringRequerido

A JWT generated by the Get Authorization Token API.
The server checks the validity of the provided token to control access to this protected resource. Please refer to Get OAuth 2.0 access token for more details on the flow and on how to get this JWT.

Parámetros de ruta

issuerIdstring · mín: 10 · máx: 10Requerido

The id of the issuer

cardIdstring · mín: 1 · máx: 48Requerido

Unique identifier of the card.

Pattern: ^[A-Za-z0-9_-]{1,48}$

Parámetros de consulta

offsetintegerOpcional

Index from which the query starts returning operations (default value: 0)

limitinteger · mín: 1 · máx: 50Opcional

Upper limit of the query

Default: 10

Parámetros de encabezado

x-correlation-idstringOpcional

Random identifier which can be used to correlate the different API calls done as part of a single use-case. This identifier will be the one primarily used for troubleshooting.

Warning: This identifier should not be derived from sensitive personal data, as its value will be logged in clear.

There is no strong guarantee of the uniqueness of this identifier, so please refrain from using it for other purpose than logging and troubleshooting.

Pattern: ^[A-Za-z0-9_-]{1,64}$

Respuestas

200

Successful

application/json

remainingOperationsintegerOpcional

400

Malformed request

application/json

401

The provided Authorization header is missing or invalid

application/json

404

Resource not found, Unknown issuerId or consumerId or accountId or digital card id

application/json

500

Internal Server Error

application/json

get

/issuers/{issuerId}/cards/{cardId}/3ds/operations

HTTPcURLJavaScriptPython

GET /banking/v1/issuers/{issuerId}/cards/{cardId}/3ds/operations HTTP/1.1
Host: api.d1.thalescloud.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "operations": [
    {
      "operationId": "text",
      "operation": "3DS_FRICTIONLESS",
      "status": "SUCCESSFUL",
      "startTime": "2022-06-16T06:28:02.492Z",
      "consumerId": "text",
      "details": {
        "acsTransactionId": "text",
        "purchase": {
          "merchantName": "text",
          "amount": "text",
          "currencyCode": "text"
        },
        "device": {
          "deviceChannel": "01",
          "appInstanceId": "text",
          "authnType": "BIOMETRIC"
        },
        "eci": "text",
        "authenticationMethod": "02",
        "transStatus": "Y",
        "transStatusReason": "text",
        "rba": {
          "evaluatedRule": [],
          "selectedRule": [],
          "appliedExemption": []
        }
      },
      "error": "text"
    }
  ],
  "remainingOperations": 1
}

Get 3-D Secure operation

get

https://api.d1.thalescloud.io/banking/v1https://api.d1-stg.thalescloud.io/banking/v1

/issuers/{issuerId}/cards/{cardId}/3ds/operations/{operationId}

This request is used by the issuer backend to retrieve the information related to a 3-D Secure operation on a card.

Getting an operation older than one year will return an error.

Autorizaciones

bearerAuth

AuthorizationstringRequerido

A JWT generated by the Get Authorization Token API.
The server checks the validity of the provided token to control access to this protected resource. Please refer to Get OAuth 2.0 access token for more details on the flow and on how to get this JWT.

Parámetros de ruta

issuerIdstring · mín: 10 · máx: 10Requerido

The id of the issuer

cardIdstring · mín: 1 · máx: 48Requerido

Unique identifier of the card.

Pattern: ^[A-Za-z0-9_-]{1,48}$

operationIdstring · mín: 1 · máx: 64Requerido

Unique identifier of the operation

Pattern: ^[A-Za-z0-9_-]{1,64}$

Parámetros de encabezado

x-correlation-idstringOpcional

Random identifier which can be used to correlate the different API calls done as part of a single use-case. This identifier will be the one primarily used for troubleshooting.

Warning: This identifier should not be derived from sensitive personal data, as its value will be logged in clear.

There is no strong guarantee of the uniqueness of this identifier, so please refrain from using it for other purpose than logging and troubleshooting.

Pattern: ^[A-Za-z0-9_-]{1,64}$

Respuestas

200

Successful

application/json

Details about a 3-D Secure operation.

operationIdstring · mín: 1 · máx: 64Requerido

Unique identifier of the operation

Pattern: ^[A-Za-z0-9_-]{1,64}$

operationstring · enumRequerido

The operation type.

Valores posibles:

statusstring · enumRequerido

Status of the operation

Valores posibles:

startTimestring · mín: 1 · máx: 64Requerido

The time the request has been processed. Format ISO 8601 YYYY-MM-DDThh:mm:ssTZD

Example: 2022-06-16T06:28:02.492Z

consumerIdstring · mín: 1 · máx: 64Opcional

Unique identifier of the consumer.

Pattern: ^[A-Za-z0-9_-]{1,64}$

detailsone ofOpcional

errorstringOpcional

Human readable string representing the error, only present in case of operation failure

400

Malformed request

application/json

401

The provided Authorization header is missing or invalid

application/json

404

Resource not found, Unknown issuerId or consumerId or accountId or digital card id

application/json

500

Internal Server Error

application/json

get

/issuers/{issuerId}/cards/{cardId}/3ds/operations/{operationId}

HTTPcURLJavaScriptPython

GET /banking/v1/issuers/{issuerId}/cards/{cardId}/3ds/operations/{operationId} HTTP/1.1
Host: api.d1.thalescloud.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "operationId": "text",
  "operation": "3DS_FRICTIONLESS",
  "status": "SUCCESSFUL",
  "startTime": "2022-06-16T06:28:02.492Z",
  "consumerId": "text",
  "details": {
    "acsTransactionId": "text",
    "purchase": {
      "merchantName": "text",
      "amount": "text",
      "currencyCode": "text"
    },
    "device": {
      "deviceChannel": "01",
      "appInstanceId": "text",
      "authnType": "BIOMETRIC"
    },
    "eci": "text",
    "authenticationMethod": "02",
    "transStatus": "Y",
    "transStatusReason": "text",
    "rba": {
      "evaluatedRule": [],
      "selectedRule": [],
      "appliedExemption": []
    }
  },
  "error": "text"
}

Delete

post

https://api.d1.thalescloud.io/banking/v1https://api.d1-stg.thalescloud.io/banking/v1

/issuers/{issuerId}/appInstances/{appInstanceId}/authnCredentials/operations:delete

This request is used by the issuer backend to delete the authentication credentials from an application instance. If these credentials were the only ones the user had for the 3DS service, the action cascades to deactivate the 3DS service for all the user's 3DS-eligible cards. The application instance is also deleted when it doesn't have any other associated resources. Note: The deletion cannot be reversed.

Autorizaciones

bearerAuth

AuthorizationstringRequerido

A JWT generated by the Get Authorization Token API.
The server checks the validity of the provided token to control access to this protected resource. Please refer to Get OAuth 2.0 access token for more details on the flow and on how to get this JWT.

Parámetros de ruta

issuerIdstring · mín: 10 · máx: 10Requerido

The id of the issuer

appInstanceIdstringRequerido

Unique identifier of the issuer application instance.

Parámetros de encabezado

x-correlation-idstringOpcional

Random identifier which can be used to correlate the different API calls done as part of a single use-case. This identifier will be the one primarily used for troubleshooting.

Warning: This identifier should not be derived from sensitive personal data, as its value will be logged in clear.

There is no strong guarantee of the uniqueness of this identifier, so please refrain from using it for other purpose than logging and troubleshooting.

Pattern: ^[A-Za-z0-9_-]{1,64}$

Cuerpo

application/json

reasonstringOpcional

The reason why the action is performed.

This a free text field in case the bank wants to send details, that will be returned in the operations list.

Example: customer was contacted on June 28Pattern: ^[a-zA-Z0-9 ]{1,64}$

reasonCodestring · enumOpcional

The reason why the action has been performed. If not provided, default reason code is ISSUER_DECISION.

Valores posibles:

Respuestas

200

Deletion was successful.

application/json

Operation result information.

operationIdstring · mín: 1 · máx: 64Opcional

Unique identifier of the operation

Pattern: ^[A-Za-z0-9_-]{1,64}$

statusstring · enumOpcional

Status of the operation

Valores posibles:

400

Bad Request, Invalid request URI or header, or unsupported nonstandard parameter

application/json

401

The provided Authorization header is missing or invalid

application/json

404

Resource not found, Unknown issuerId or appInstanceId

application/json

500

Internal Server Error

application/json

post

/issuers/{issuerId}/appInstances/{appInstanceId}/authnCredentials/operations:delete

HTTPcURLJavaScriptPython

POST /banking/v1/issuers/{issuerId}/appInstances/{appInstanceId}/authnCredentials/operations:delete HTTP/1.1
Host: api.d1.thalescloud.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 75

{
  "reason": "customer was contacted on June 28",
  "reasonCode": "USER_DECISION"
}

{
  "operationId": "text",
  "status": "SUCCESSFUL"
}