Welcome to our new developer portal! Use the "Ask" button to chat with our AI Agent.
Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Click to Pay API

Click to Pay enrol

post
/issuers/{issuerId}/cards/{cardId}/operations:clickToPayEnrolment

This request is used by the issuer's backend to enrol the card to Click to Pay.

Note: It cannot be used to update Click to Pay information. For that, please refer to: - Click to Pay update card - Click to Pay update consumer

Note: If the card enrolment is not successful, D1 will end-up with a FAILED operation. But if the consumer was successfully enrolled, the get Click to Pay profile API will return a profile with the enrolled consumer and no card associated to it depending on the scheme's internal behavior.

Warning: This API does not support bulk enrolments. If you need to perform mass enrolments of cards to the Click to Pay service, it is recommended to use the batch file registration with Click to Pay auto-enrolment. Contact your Thales representative to configure the auto-enrolment feature.

Authorizations
AuthorizationstringRequired

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.

Path parameters
issuerIdstring · min: 10 · max: 10Required

The id of the issuer

cardIdstring · min: 1 · max: 48Required

Unique identifier of the card.

Pattern: ^[A-Za-z0-9_-]{1,48}$
Header parameters
x-correlation-idstringOptional

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}$
Body
namestring · min: 1 · max: 26Optional

The card holder name as present on the card. It is applicable only to Visa.

Example: John SmithPattern: ^[\p{L}\p{N}\u0600-\u06FF ,.'_#;:\/-]{1,26}$
reasonstringOptional

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 · enumOptional

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

Possible values:
Responses
200

Card enrolment to Click to Pay has been taken into account.

application/json

Operation result information.

operationIdstring · min: 1 · max: 64Optional

Unique identifier of the operation

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

Status of the operation

Possible values:
post/issuers/{issuerId}/cards/{cardId}/operations:clickToPayEnrolment
POST /banking/v1/issuers/{issuerId}/cards/{cardId}/operations:clickToPayEnrolment HTTP/1.1
Host: api.d1.thalescloud.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 444

{
  "name": "John Smith",
  "billingAddress": {
    "line1": "1230 Rue de Rivoli",
    "line2": "text",
    "line3": "text",
    "city": "Paris",
    "state": "75",
    "zipCode": "75000",
    "countryCode": "FR"
  },
  "consumerInfo": {
    "firstName": "Alexandre",
    "middleName": "Andrew",
    "lastName": "Doe",
    "language": "en-US",
    "mobilePhoneNumber": {
      "countryCode": "+33",
      "phoneNumber": "624302941"
    },
    "email": "john.smith@myhostmaill.com"
  },
  "reason": "customer was contacted on June 28",
  "reasonCode": "ISSUER_DECISION"
}
{
  "operationId": "text",
  "status": "PENDING"
}

Click to Pay get consumer profiles

get
/issuers/{issuerId}/consumers/{consumerId}/clickToPayProfiles

Retrieve the Click to Pay profiles for the given consumerId.

There can be one profile per scheme, at maximum.

If the end-user (consumer) exists in D1 solution but was never enrolled to Click to Pay then an empty list will be returned by the API.

Authorizations
AuthorizationstringRequired

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.

Path parameters
issuerIdstring · min: 10 · max: 10Required

The id of the issuer

consumerIdstring · min: 1 · max: 64Required

Unique identifier of the consumer.

Pattern: ^[A-Za-z0-9_-]{1,64}$
Header parameters
x-correlation-idstringOptional

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}$
Responses
200

Profile retrieved.

application/json
messagestringOptional

Optional string message. In case issuer is using both schemes and one of the two is returning an error, we will send back partial answer in the clickToPayProfiles array, and in this message we will giving more details on the received error. This field is for troubleshooting purposes only, it can change at any time so MUST NOT be parsed, and is not supposed to be human readable so CANNOT be displayed to end users.

get/issuers/{issuerId}/consumers/{consumerId}/clickToPayProfiles
GET /banking/v1/issuers/{issuerId}/consumers/{consumerId}/clickToPayProfiles HTTP/1.1
Host: api.d1.thalescloud.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "clickToPayProfiles": [
    {
      "scheme": "MASTERCARD",
      "consumerId": "text",
      "consumerInfo": {
        "firstName": "Alexandre",
        "middleName": "Andrew",
        "lastName": "Doe",
        "language": "en-US",
        "mobilePhoneNumber": {
          "countryCode": "+33",
          "phoneNumber": "624302941"
        },
        "email": "john.smith@myhostmaill.com"
      },
      "cards": [
        {
          "cardId": "1111-2222-3333",
          "panSuffix": "1254",
          "exp": "1240",
          "digitalCardId": "FWSPMC000000000159f71f703d2141efaf04dd26803f922b",
          "name": "John Smith",
          "billingAddress": {
            "line1": "1230 Rue de Rivoli",
            "line2": "text",
            "line3": "text",
            "city": "Paris",
            "state": "75",
            "zipCode": "75000",
            "countryCode": "FR"
          }
        }
      ]
    }
  ],
  "message": "text"
}

Click to Pay update card

post
/issuers/{issuerId}/cards/{cardId}/operations:clickToPayUpdate

This request is used by the issuer's backend to update the card information that was pushed to Click to Pay.

Authorizations
AuthorizationstringRequired

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.

Path parameters
issuerIdstring · min: 10 · max: 10Required

The id of the issuer

cardIdstring · min: 1 · max: 48Required

Unique identifier of the card.

Pattern: ^[A-Za-z0-9_-]{1,48}$
Header parameters
x-correlation-idstringOptional

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}$
Body
namestring · min: 1 · max: 26Optional

The card holder name as present on the card. It is applicable only to Visa.

Example: John SmithPattern: ^[\p{L}\p{N}\u0600-\u06FF ,.'_#;:\/-]{1,26}$
reasonstringOptional

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 · enumOptional

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

Possible values:
Responses
200

Card information update has been taken into account.

application/json

Operation result information.

operationIdstring · min: 1 · max: 64Optional

Unique identifier of the operation

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

Status of the operation

Possible values:
post/issuers/{issuerId}/cards/{cardId}/operations:clickToPayUpdate
POST /banking/v1/issuers/{issuerId}/cards/{cardId}/operations:clickToPayUpdate HTTP/1.1
Host: api.d1.thalescloud.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 240

{
  "name": "John Smith",
  "billingAddress": {
    "line1": "1230 Rue de Rivoli",
    "line2": "text",
    "line3": "text",
    "city": "Paris",
    "state": "75",
    "zipCode": "75000",
    "countryCode": "FR"
  },
  "reason": "customer was contacted on June 28",
  "reasonCode": "ISSUER_DECISION"
}
{
  "operationId": "text",
  "status": "PENDING"
}

Click to Pay update consumer

post
/issuers/{issuerId}/consumers/{consumerId}/operations:clickToPayUpdate

This request is used by the issuer's backend to update the end user (consumer) information that was pushed to Click to Pay.

Authorizations
AuthorizationstringRequired

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.

Path parameters
issuerIdstring · min: 10 · max: 10Required

The id of the issuer

consumerIdstring · min: 1 · max: 64Required

Unique identifier of the consumer.

Pattern: ^[A-Za-z0-9_-]{1,64}$
Header parameters
x-correlation-idstringOptional

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}$
Body
reasonstringOptional

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 · enumOptional

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

Possible values:
Responses
200

End user (consumer) information update has been taken into account.

application/json

Operation result information.

operationIdstring · min: 1 · max: 64Optional

Unique identifier of the operation

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

Status of the operation

Possible values:
post/issuers/{issuerId}/consumers/{consumerId}/operations:clickToPayUpdate
POST /banking/v1/issuers/{issuerId}/consumers/{consumerId}/operations:clickToPayUpdate HTTP/1.1
Host: api.d1.thalescloud.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 424

{
  "consumerInfo": {
    "firstName": "Alexandre",
    "middleName": "Andrew",
    "lastName": "Doe",
    "language": "en-US",
    "mobilePhoneNumber": {
      "countryCode": "+33",
      "phoneNumber": "624302941"
    },
    "email": "john.smith@myhostmaill.com"
  },
  "billingAddress": {
    "line1": "1230 Rue de Rivoli",
    "line2": "text",
    "line3": "text",
    "city": "Paris",
    "state": "75",
    "zipCode": "75000",
    "countryCode": "FR"
  },
  "reason": "customer was contacted on June 28",
  "reasonCode": "ISSUER_DECISION"
}
{
  "operationId": "text",
  "status": "PENDING"
}

Click to Pay opt-out card

post
/issuers/{issuerId}/cards/{cardId}/operations:clickToPayOptout

This request is used by the issuer's backend to opt-out a card that was enrolled to Click to Pay.

Authorizations
AuthorizationstringRequired

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.

Path parameters
issuerIdstring · min: 10 · max: 10Required

The id of the issuer

cardIdstring · min: 1 · max: 48Required

Unique identifier of the card.

Pattern: ^[A-Za-z0-9_-]{1,48}$
Header parameters
x-correlation-idstringOptional

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}$
Body
reasonstringOptional

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 · enumOptional

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

Possible values:
Responses
200

Card opt-out from Click to Pay has been taken into account.

application/json

Operation result information.

operationIdstring · min: 1 · max: 64Optional

Unique identifier of the operation

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

Status of the operation

Possible values:
post/issuers/{issuerId}/cards/{cardId}/operations:clickToPayOptout
POST /banking/v1/issuers/{issuerId}/cards/{cardId}/operations:clickToPayOptout HTTP/1.1
Host: api.d1.thalescloud.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 77

{
  "reason": "customer was contacted on June 28",
  "reasonCode": "ISSUER_DECISION"
}
{
  "operationId": "text",
  "status": "PENDING"
}

Click to Pay opt-out consumer

post
/issuers/{issuerId}/consumers/{consumerId}/operations:clickToPayOptout

This request is used by the issuer's backend to opt-out a consumer that was enrolled to Click to Pay.

The consumer opt-out will opt-out the consumer and all its associated cards from Click to Pay in one single operation.

Authorizations
AuthorizationstringRequired

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.

Path parameters
issuerIdstring · min: 10 · max: 10Required

The id of the issuer

consumerIdstring · min: 1 · max: 64Required

Unique identifier of the consumer.

Pattern: ^[A-Za-z0-9_-]{1,64}$
Header parameters
x-correlation-idstringOptional

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}$
Body
reasonstringOptional

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 · enumOptional

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

Possible values:
Responses
200

Consumer opt-out from Click to Pay has been taken into account. The opt-out can be PENDING or SUCCESSFUL.

In Case of SUCCESSFUL it can mean that:

  • the operation is already finished and success,
  • the operation was already done, the consumer was already opted-out,
  • the operation was not needed as the consumer was never enrolled to Click to Pay.
application/json

Operation result information.

operationIdstring · min: 1 · max: 64Optional

Unique identifier of the operation

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

Status of the operation

Possible values:
post/issuers/{issuerId}/consumers/{consumerId}/operations:clickToPayOptout
POST /banking/v1/issuers/{issuerId}/consumers/{consumerId}/operations:clickToPayOptout HTTP/1.1
Host: api.d1.thalescloud.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 77

{
  "reason": "customer was contacted on June 28",
  "reasonCode": "ISSUER_DECISION"
}
{
  "operationId": "text",
  "status": "PENDING"
}
PreviousCard API
NextOutbound API (from D1)

Last updated

Was this helpful?