> For the complete documentation index, see [llms.txt](https://docs.payments.thalescloud.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.payments.thalescloud.io/merchant-tokenization/ja/bakkuendo/apis/client-api/binding-notifications.md). # Binding notifications ## Notify Binding Creation > 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. ```json {"openapi":"3.1.1","info":{"title":"Thales COF Client API","version":"1.42"},"tags":[{"name":"Binding notifications"}],"servers":[{"url":"/tsh-cof"}],"security":[{"BasicAuth":[]}],"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{"tokenId":{"type":"string","description":"The token identifier.","minLength":1,"maxLength":128},"deviceId":{"type":"string","description":"The unique device identifier.","minLength":1,"maxLength":24},"deviceType":{"type":"string","description":"The device type.","maxLength":32,"enum":["PHONE","TABLET","WATCH","TV","WEARABLE_DEVICE"]},"appType":{"type":"string","description":"The device type.","maxLength":32,"enum":["IOS","ANDROID","WEB"]},"vProvisionedTokenId":{"type":"string","description":"Specific to Visa. Another token identifier that shall be used only with Visa Cloud Token Framework.","minLength":1,"maxLength":36},"selectedIdvMethod":{"type":"string","description":"The ID&V method selected to bind the device.","maxLength":32,"enum":["OTP_SMS","OTP_EMAIL","OTP_ONLINE_BANKING","APP_TO_APP","OUTBOUND_CALL","CUSTOMER_SERVICE","NONE","UNKNOWN"]},"merchantId":{"type":"string","description":"Identifier of the merchant provided by Thales at on-boarding.","minLength":1,"maxLength":128},"creationTimestamp":{"type":"string","maxLength":64,"description":"Token or binding creation timestamp compliant with ISO 8601."}}},"paths":{"/notify-binding-creation":{"post":{"description":"Notify the token requestor about a device binding creation. \n\nIn case of retryable error returned by the token requestor, the notification will be resent periodically with exponential backoff.","operationId":"notifyBindingCreation","parameters":[{"schema":{},"$ref":"#/parameters/authorization"},{"schema":{},"$ref":"#/parameters/xCorrelationId"}],"responses":{"204":{"$ref":"#/responses/204"},"400":{"$ref":"#/responses/400"},"401":{"$ref":"#/responses/401"},"404":{"$ref":"#/responses/404"},"429":{"$ref":"#/responses/429"},"500":{"$ref":"#/responses/500"},"503":{"$ref":"#/responses/503"}},"tags":["Binding notifications"],"summary":"Notify Binding Creation","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["merchantId","tokenId","deviceId","selectedIdvMethod"],"properties":{"tokenId":{"$ref":"#/components/schemas/tokenId"},"deviceId":{"$ref":"#/components/schemas/deviceId"},"deviceType":{"$ref":"#/components/schemas/deviceType"},"appType":{"$ref":"#/components/schemas/appType"},"vProvisionedTokenId":{"$ref":"#/components/schemas/vProvisionedTokenId"},"selectedIdvMethod":{"$ref":"#/components/schemas/selectedIdvMethod"},"merchantId":{"$ref":"#/components/schemas/merchantId"},"creationTimestamp":{"$ref":"#/components/schemas/creationTimestamp"}}}}}}}}},"parameters":{"authorization":{"in":"header","description":"Technical identifier pre-defined at on-boarding that identifies the API\nconsumer.\nFormat shall be the string 'APIKEY' followed by a space and the\napi key value.\n
Example: APIKEY c03f88fe-01ba-11e8-ba89-0ed5f89f718b\n","name":"authorization","required":true,"type":"string","minLength":1,"maxLength":512},"xCorrelationId":{"in":"header","description":"A unique message identifier. It eventually correlates the notification with a request if any. The goal is to help on customer support when needed. ","name":"x-correlation-id","required":true,"type":"string","minLength":1,"maxLength":36}},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad request - Not Retryable"},"401":{"description":"Unauthorized - Not Retryable"},"404":{"description":"Not Found - Not Retryable"},"429":{"description":"Too Many Requests - Retryable"},"500":{"description":"Internal Server Error - Retryable"},"503":{"description":"Service Unavailable - Retryable"}}} ``` ## Notify Binding Update > 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. ```json {"openapi":"3.1.1","info":{"title":"Thales COF Client API","version":"1.42"},"tags":[{"name":"Binding notifications"}],"servers":[{"url":"/tsh-cof"}],"security":[{"BasicAuth":[]}],"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{"tokenId":{"type":"string","description":"The token identifier.","minLength":1,"maxLength":128},"deviceId":{"type":"string","description":"The unique device identifier.","minLength":1,"maxLength":24},"deviceType":{"type":"string","description":"The device type.","maxLength":32,"enum":["PHONE","TABLET","WATCH","TV","WEARABLE_DEVICE"]},"appType":{"type":"string","description":"The device type.","maxLength":32,"enum":["IOS","ANDROID","WEB"]},"bindingState":{"type":"string","maxLength":64,"description":"Binding state.","enum":["DELETED"]},"vProvisionedTokenId":{"type":"string","description":"Specific to Visa. Another token identifier that shall be used only with Visa Cloud Token Framework.","minLength":1,"maxLength":36},"merchantId":{"type":"string","description":"Identifier of the merchant provided by Thales at on-boarding.","minLength":1,"maxLength":128},"eventInitiator":{"type":"string","description":"The initiator of the event. For example a delete binding can be initiated by the scheme or by the app in the device.","maxLength":32,"enum":["TSP","APP"]},"creationTimestamp":{"type":"string","maxLength":64,"description":"Token or binding creation timestamp compliant with ISO 8601."},"lastUpdateTimestamp":{"type":"string","maxLength":64,"description":"Token or binding last update timestamp compliant with ISO 8601."}}},"paths":{"/notify-binding-update":{"post":{"description":"Notify the token requestor about a device binding update. \n\nIn case of retryable error returned by the token requestor, the notification will be resent periodically with exponential backoff.","operationId":"notifyBindingUpdate","parameters":[{"schema":{},"$ref":"#/parameters/authorization"},{"schema":{},"$ref":"#/parameters/xCorrelationId"}],"responses":{"204":{"$ref":"#/responses/204"},"400":{"$ref":"#/responses/400"},"401":{"$ref":"#/responses/401"},"404":{"$ref":"#/responses/404"},"429":{"$ref":"#/responses/429"},"500":{"$ref":"#/responses/500"},"503":{"$ref":"#/responses/503"}},"tags":["Binding notifications"],"summary":"Notify Binding Update","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["merchantId","tokenId","deviceId","bindingState","eventInitiator"],"properties":{"tokenId":{"$ref":"#/components/schemas/tokenId"},"deviceId":{"$ref":"#/components/schemas/deviceId"},"deviceType":{"$ref":"#/components/schemas/deviceType"},"appType":{"$ref":"#/components/schemas/appType"},"bindingState":{"$ref":"#/components/schemas/bindingState"},"vProvisionedTokenId":{"$ref":"#/components/schemas/vProvisionedTokenId"},"merchantId":{"$ref":"#/components/schemas/merchantId"},"eventInitiator":{"$ref":"#/components/schemas/eventInitiator"},"creationTimestamp":{"$ref":"#/components/schemas/creationTimestamp"},"lastUpdateTimestamp":{"$ref":"#/components/schemas/lastUpdateTimestamp"}}}}}}}}},"parameters":{"authorization":{"in":"header","description":"Technical identifier pre-defined at on-boarding that identifies the API\nconsumer.\nFormat shall be the string 'APIKEY' followed by a space and the\napi key value.\n
Example: APIKEY c03f88fe-01ba-11e8-ba89-0ed5f89f718b\n","name":"authorization","required":true,"type":"string","minLength":1,"maxLength":512},"xCorrelationId":{"in":"header","description":"A unique message identifier. It eventually correlates the notification with a request if any. The goal is to help on customer support when needed. ","name":"x-correlation-id","required":true,"type":"string","minLength":1,"maxLength":36}},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad request - Not Retryable"},"401":{"description":"Unauthorized - Not Retryable"},"404":{"description":"Not Found - Not Retryable"},"429":{"description":"Too Many Requests - Retryable"},"500":{"description":"Internal Server Error - Retryable"},"503":{"description":"Service Unavailable - Retryable"}}} ``` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.payments.thalescloud.io/merchant-tokenization/ja/bakkuendo/apis/client-api/binding-notifications.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.