Binding notifications

Notify Binding Creation

post

Notify the token requestor about a device binding creation.

In case of retryable error returned by the token requestor, the notification will be resent periodically with exponential backoff.

Authorizations

BasicAuth

AuthorizationstringRequired

Header parameters

authorizationanyRequired

Technical identifier pre-defined at on-boarding that identifies the API consumer. Format shall be the string 'APIKEY' followed by a space and the api key value. Example: APIKEY c03f88fe-01ba-11e8-ba89-0ed5f89f718b

x-correlation-idanyRequired

A unique message identifier. It eventually correlates the notification with a request if any. The goal is to help on customer support when needed.

Body

application/json

tokenIdstring · min: 1 · max: 128Required

The token identifier.

deviceIdstring · min: 1 · max: 24Required

The unique device identifier.

deviceTypestring · enum · max: 32Optional

The device type.

Example: PHONEPossible values:

appTypestring · enum · max: 32Optional

The device type.

Example: ANDROIDPossible values:

vProvisionedTokenIdstring · min: 1 · max: 36Optional

Specific to Visa. Another token identifier that shall be used only with Visa Cloud Token Framework.

selectedIdvMethodstring · enum · max: 32Required

The ID&V method selected to bind the device.

Example: APP_TO_APPPossible values:

merchantIdstring · min: 1 · max: 128Required

Identifier of the merchant provided by Thales at on-boarding.

creationTimestampstring · max: 64Optional

Token or binding creation timestamp compliant with ISO 8601.

Example: 2017-11-10T09:08:24.479Z

Responses

204

No Content

No content

400

Bad request - Not Retryable

401

Unauthorized - Not Retryable

404

Not Found - Not Retryable

429

Too Many Requests - Retryable

500

Internal Server Error - Retryable

503

Service Unavailable - Retryable

post/notify-binding-creation

HTTPcURLJavaScriptPython

POST /tsh-cof/notify-binding-creation HTTP/1.1
Authorization: Basic username:password
authorization: null
x-correlation-id: null
Content-Type: application/json
Accept: */*
Content-Length: 206

{
  "tokenId": "text",
  "deviceId": "text",
  "deviceType": "PHONE",
  "appType": "ANDROID",
  "vProvisionedTokenId": "text",
  "selectedIdvMethod": "APP_TO_APP",
  "merchantId": "text",
  "creationTimestamp": "2017-11-10T09:08:24.479Z"
}

No content

Notify Binding Update

post

Notify the token requestor about a device binding update.

In case of retryable error returned by the token requestor, the notification will be resent periodically with exponential backoff.

Authorizations

BasicAuth

AuthorizationstringRequired

Header parameters

authorizationanyRequired

Technical identifier pre-defined at on-boarding that identifies the API consumer. Format shall be the string 'APIKEY' followed by a space and the api key value. Example: APIKEY c03f88fe-01ba-11e8-ba89-0ed5f89f718b

x-correlation-idanyRequired

A unique message identifier. It eventually correlates the notification with a request if any. The goal is to help on customer support when needed.

Body

application/json

tokenIdstring · min: 1 · max: 128Required

The token identifier.

deviceIdstring · min: 1 · max: 24Required

The unique device identifier.

deviceTypestring · enum · max: 32Optional

The device type.

Example: PHONEPossible values:

appTypestring · enum · max: 32Optional

The device type.

Example: ANDROIDPossible values:

bindingStatestring · enum · max: 64Required

Binding state.

Example: DELETEDPossible values:

vProvisionedTokenIdstring · min: 1 · max: 36Optional

Specific to Visa. Another token identifier that shall be used only with Visa Cloud Token Framework.

merchantIdstring · min: 1 · max: 128Required

Identifier of the merchant provided by Thales at on-boarding.

eventInitiatorstring · enum · max: 32Required

The initiator of the event. For example a delete binding can be initiated by the scheme or by the app in the device.

Example: TSPPossible values:

creationTimestampstring · max: 64Optional

Token or binding creation timestamp compliant with ISO 8601.

Example: 2017-11-10T09:08:24.479Z

lastUpdateTimestampstring · max: 64Optional

Token or binding last update timestamp compliant with ISO 8601.

Example: 2017-11-13T11:012:41.165Z

Responses

204

No Content

No content

400

Bad request - Not Retryable

401

Unauthorized - Not Retryable

404

Not Found - Not Retryable

429

Too Many Requests - Retryable

500

Internal Server Error - Retryable

503

Service Unavailable - Retryable

post/notify-binding-update

HTTPcURLJavaScriptPython

POST /tsh-cof/notify-binding-update HTTP/1.1
Authorization: Basic username:password
authorization: null
x-correlation-id: null
Content-Type: application/json
Accept: */*
Content-Length: 271

{
  "tokenId": "text",
  "deviceId": "text",
  "deviceType": "PHONE",
  "appType": "ANDROID",
  "bindingState": "DELETED",
  "vProvisionedTokenId": "text",
  "merchantId": "text",
  "eventInitiator": "TSP",
  "creationTimestamp": "2017-11-10T09:08:24.479Z",
  "lastUpdateTimestamp": "2017-11-13T11:012:41.165Z"
}

No content