> 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/wallet-server-transit-api-for-huawei/ja/api-rifarensu/song-xin-cao-zuo-tsh-fa-xin/purobijoninguoyobi-api.md).
# プロビジョニングおよび管理 API
[WS-Transit-API-OUT-oas2.yaml](https://openapi.gitbook.com/o/fwy1mtbRONGA2YDKDBr0/spec/WS-Transit-API-OUT-oas2.yaml)
## Request to send a script to a device
> This method is used by TSH to provide a script to a device.
```json
{"openapi":"3.1.1","info":{"title":"Thales TSH Transit API - TSH to WS","version":"1.0.8"},"paths":{"/sendScript":{"post":{"summary":"Request to send a script to a device","description":"This method is used by TSH to provide a script to a device.","operationId":"sendScript","parameters":[{"$ref":"#/components/parameters/podHeader"}],"responses":{"200":{"description":"sendScript response payload","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sendScriptRes"}}}},"500":{"description":"Internal Server Error"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/sendScriptReq"}}},"description":"sendScript request payload","required":true}}}},"components":{"parameters":{"podHeader":{"schema":{"type":"string","maxLength":128},"name":"x-pod","in":"header","description":"HTTP header identifying the pod and corresponding DNS hostname of the load balancer from which traffic is coming. Subsequent API calls should be sent to this pod.","required":true}},"schemas":{"sendScriptRes":{"type":"object","properties":{"responseHeader":{"type":"object","properties":{"responseId":{"$ref":"#/components/schemas/responseId"},"sessionId":{"$ref":"#/components/schemas/sessionId"},"generationDateTime":{"$ref":"#/components/schemas/generationDateTime"},"statusCode":{"type":"number","description":"Status code to the request\n|Status code | Description|\n|-------|-------|\n|0|OK| \n|111|Missing mandatory parameter|\n|112|Bad parameter format| \n|119|Unknown virtual card| \n|321|Operation already on-going for this device| \n|432|Operation is not allowed with current card state| \n|911|Operation failed| \n|921|Unexpected server error|\n"},"statusMessage":{"type":"string","description":"Textual status message"}},"required":["responseId","sessionId","statusCode"]}},"required":["responseHeader"]},"responseId":{"type":"string","description":"Unique response identifier","minLength":1,"maxLength":48},"sessionId":{"type":"string","description":"Unique session identifier used to trace the calls across systems during a use case.","minLength":1,"maxLength":48},"generationDateTime":{"type":"string","description":"Date time representing when the request or response has been generated.
RFC3339 format.
Example:\n - 2018-12-24T17:32:28Z","format":"date-time"},"sendScriptReq":{"type":"object","properties":{"requestHeader":{"$ref":"#/components/schemas/requestHeader"},"taskId":{"$ref":"#/components/schemas/taskId"},"walletCardId":{"$ref":"#/components/schemas/walletCardId"},"seId":{"$ref":"#/components/schemas/seId"},"apduCommands":{"$ref":"#/components/schemas/apduCommands"}},"required":["requestHeader","taskId","walletCardId","seId","apduCommands"]},"requestHeader":{"type":"object","properties":{"requestId":{"$ref":"#/components/schemas/requestId"},"sessionId":{"$ref":"#/components/schemas/sessionId"},"generationDateTime":{"$ref":"#/components/schemas/generationDateTime"}},"required":["requestId","sessionId"]},"requestId":{"type":"string","description":"Unique request identifier","minLength":1,"maxLength":48},"taskId":{"type":"string","description":"Unique task identifier used to correlate a callback to a request.","minLength":1,"maxLength":64},"walletCardId":{"type":"string","description":"The Wallet Card Identifier. Unique for each wallet card.","minLength":1,"maxLength":64},"seId":{"type":"string","description":"Secure Element Identifier","pattern":"([0-9a-fA-F][0-9a-fA-F]){1,24}"},"apduCommands":{"type":"array","description":"List of APDU commands to send to a secure element.","items":{"type":"object","properties":{"data":{"type":"string","description":"APDU command to execute on SE, encoded in Hex string.","pattern":"^([0-9a-fA-F]{2})*$","maxLength":512},"messageId":{"type":"string","description":"ID of the command to execute","minLength":1,"maxLength":64},"messageName":{"type":"string","description":"Descriptive name of the command that needs to be executed.","minLength":1,"maxLength":100}},"required":["data","messageId"]}}}}}
```
## Request to update a digital card
> This method is used by TSH to request to update a digital card.
```json
{"openapi":"3.1.1","info":{"title":"Thales TSH Transit API - TSH to WS","version":"1.0.8"},"paths":{"/updateCard":{"post":{"summary":"Request to update a digital card","description":"This method is used by TSH to request to update a digital card.","operationId":"updateCard","parameters":[{"$ref":"#/components/parameters/podHeader"}],"responses":{"200":{"description":"updateCard response payload","content":{"application/json":{"schema":{"$ref":"#/components/schemas/updateCardRes"}}}},"500":{"description":"Internal Server Error"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/updateCardReq"}}},"description":"updateCard request payload","required":true}}}},"components":{"parameters":{"podHeader":{"schema":{"type":"string","maxLength":128},"name":"x-pod","in":"header","description":"HTTP header identifying the pod and corresponding DNS hostname of the load balancer from which traffic is coming. Subsequent API calls should be sent to this pod.","required":true}},"schemas":{"updateCardRes":{"type":"object","properties":{"responseHeader":{"type":"object","properties":{"responseId":{"$ref":"#/components/schemas/responseId"},"sessionId":{"$ref":"#/components/schemas/sessionId"},"generationDateTime":{"$ref":"#/components/schemas/generationDateTime"},"statusCode":{"type":"number","description":"Status code to the request\n|Status code | Description|\n|-------|-------|\n|0|OK| \n|111|Missing mandatory parameter|\n|112|Bad parameter format| \n|119|Unknown virtual card| \n|321|Operation already on-going for this device| \n|432|Operation is not allowed with current card state| \n|911|Operation failed| \n|921|Unexpected server error|\n"},"statusMessage":{"type":"string","description":"Textual status message"}},"required":["responseId","sessionId","statusCode"]}},"required":["responseHeader"]},"responseId":{"type":"string","description":"Unique response identifier","minLength":1,"maxLength":48},"sessionId":{"type":"string","description":"Unique session identifier used to trace the calls across systems during a use case.","minLength":1,"maxLength":48},"generationDateTime":{"type":"string","description":"Date time representing when the request or response has been generated.
RFC3339 format.
Example:\n - 2018-12-24T17:32:28Z","format":"date-time"},"updateCardReq":{"type":"object","properties":{"requestHeader":{"$ref":"#/components/schemas/requestHeader"},"taskId":{"$ref":"#/components/schemas/taskId"},"walletCardId":{"$ref":"#/components/schemas/walletCardId"},"seId":{"$ref":"#/components/schemas/seId"},"operation":{"$ref":"#/components/schemas/operation"},"cardDescriptor":{"$ref":"#/components/schemas/cardDescriptor"}},"required":["requestHeader","taskId","walletCardId","seId","operation"]},"requestHeader":{"type":"object","properties":{"requestId":{"$ref":"#/components/schemas/requestId"},"sessionId":{"$ref":"#/components/schemas/sessionId"},"generationDateTime":{"$ref":"#/components/schemas/generationDateTime"}},"required":["requestId","sessionId"]},"requestId":{"type":"string","description":"Unique request identifier","minLength":1,"maxLength":48},"taskId":{"type":"string","description":"Unique task identifier used to correlate a callback to a request.","minLength":1,"maxLength":64},"walletCardId":{"type":"string","description":"The Wallet Card Identifier. Unique for each wallet card.","minLength":1,"maxLength":64},"seId":{"type":"string","description":"Secure Element Identifier","pattern":"([0-9a-fA-F][0-9a-fA-F]){1,24}"},"operation":{"type":"string","enum":["SUSPEND","RESUME","DELETE","METADATA_UPDATE","REDIRECT","ERASE"],"description":"Operation to perform on a digital card.SUSPEND: for suspending the digital card, usually GP lock is performed on SERESUME: for resuming the digital card, usually GP unlock is performed on SEDELETE: for deleting the digital card and related instances in SEMETADATA_UPDATE: for updating the digital card metadata.cardDescriptor is provided for this operation.REDIRECT: used to notify the device to connect to TSH to fetch some commands using getDeviceCommands API.ERASE: for completely removing the digital card from device and server as defined in GDPR."},"cardDescriptor":{"type":"object","description":"The card descriptor which contains various metadata.","properties":{"appletCurrencyCode":{"type":"string","description":"The apple currency code. It is specified as 3 letters code (ISO4217)","minLength":3,"maxLength":3},"displayCardNumber":{"type":"string","description":"The card number to be displayed on the wallet.
If it's not provided, cardId will be used.","minLength":1,"maxLength":16},"cardholderName":{"type":"string","description":"The card holder to be displayed on the wallet.","minLength":1,"maxLength":128},"cardArtManifest":{"$ref":"#/components/schemas/cardArtManifest"},"labelColor":{"type":"string","description":"Color of overlaying text","pattern":"^rgb([0-9]{1,3},[0-9]{1,3},[0-9]{1,3})$"},"shortDescription":{"type":"string","description":"A short description of the card.","maxLength":32},"longDescription":{"type":"string","description":"A longer description of the card.","maxLength":64},"privacyPolicyURL":{"type":"string","description":"URL pointing to issuer privacy policy","maxLength":128},"termsAndConditionsURL":{"type":"string","description":"URL pointing to card terms and conditions","maxLength":128},"contactWebsite":{"type":"string","description":"Customer service website of the issuer","maxLength":128},"contactEmail":{"type":"string","description":"Customer service email address of the issuer","maxLength":32},"contactNumber":{"type":"string","description":"Customer service phone number of the issuer. This number is provided in standard, international format with country code","maxLength":32},"contactName":{"type":"string","description":"Customer service contact name of the issuer","maxLength":128},"cardActions":{"type":"object","properties":{"minLoadedBalance":{"type":"number","description":"Minimum value amount a card can contain after applying a top-up action"},"maxLoadedBalance":{"type":"number","description":"Maximum value amount a card can contain after using a top-up action"},"minLoadAmount":{"type":"number","description":"Minimum amount that can be added during a top-up action per transaction"},"maxLoadAmount":{"type":"number","description":"Maximum amount that can be added during a top-up action per transaction"}},"required":["maxLoadedBalance","minLoadAmount"]},"mobileApp":{"type":"object","properties":{"identifier":{"type":"string","description":"Identifier of the mobile application","maxLength":128},"action":{"type":"string","description":"Mobile application native action. Used for deep linking","maxLength":128},"intentExtraText":{"type":"string","description":"Mobile application native intent extra text. Used for deep linking","maxLength":128}},"required":["identifier"]}}},"cardArtManifest":{"type":"array","description":"Array of GUIDs required to build card art. Each cart art can be retrieved using getAsset API with corresponding GUID.","items":{"type":"string","maxLength":64}}}}}
```
## Request to get the status of a task
> This method is used by TSH to request a task status.
```json
{"openapi":"3.1.1","info":{"title":"Thales TSH Transit API - TSH to WS","version":"1.0.8"},"paths":{"/getTaskStatus":{"post":{"summary":"Request to get the status of a task","description":"This method is used by TSH to request a task status.","operationId":"getTaskStatus","parameters":[{"$ref":"#/components/parameters/podHeader"}],"responses":{"200":{"description":"getTaskStatus response payload","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getTaskStatusRes"}}}},"500":{"description":"Internal Server Error"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/getTaskStatusReq"}}},"description":"getTaskStatus request payload","required":true}}}},"components":{"parameters":{"podHeader":{"schema":{"type":"string","maxLength":128},"name":"x-pod","in":"header","description":"HTTP header identifying the pod and corresponding DNS hostname of the load balancer from which traffic is coming. Subsequent API calls should be sent to this pod.","required":true}},"schemas":{"getTaskStatusRes":{"type":"object","properties":{"responseHeader":{"type":"object","properties":{"responseId":{"$ref":"#/components/schemas/responseId"},"sessionId":{"$ref":"#/components/schemas/sessionId"},"generationDateTime":{"$ref":"#/components/schemas/generationDateTime"},"statusCode":{"type":"number","description":"Status code to the request\n|Status code | Description|\n|-------|-------|\n|0|OK| \n|111|Missing mandatory parameter|\n|112|Bad parameter format| \n|121|Unknown task| \n|911|Operation failed| \n|921|Unexpected server error|\n"},"statusMessage":{"type":"string","description":"Textual status message"}},"required":["responseId","sessionId","statusCode"]},"taskStatus":{"type":"string","enum":["PROCESSING","COMPLETED","FAILED"]}},"required":["responseHeader"]},"responseId":{"type":"string","description":"Unique response identifier","minLength":1,"maxLength":48},"sessionId":{"type":"string","description":"Unique session identifier used to trace the calls across systems during a use case.","minLength":1,"maxLength":48},"generationDateTime":{"type":"string","description":"Date time representing when the request or response has been generated.
RFC3339 format.
Example:\n - 2018-12-24T17:32:28Z","format":"date-time"},"getTaskStatusReq":{"type":"object","properties":{"requestHeader":{"$ref":"#/components/schemas/requestHeader"},"taskId":{"$ref":"#/components/schemas/taskId"},"seId":{"$ref":"#/components/schemas/seId"}},"required":["requestHeader","taskId","seId"]},"requestHeader":{"type":"object","properties":{"requestId":{"$ref":"#/components/schemas/requestId"},"sessionId":{"$ref":"#/components/schemas/sessionId"},"generationDateTime":{"$ref":"#/components/schemas/generationDateTime"}},"required":["requestId","sessionId"]},"requestId":{"type":"string","description":"Unique request identifier","minLength":1,"maxLength":48},"taskId":{"type":"string","description":"Unique task identifier used to correlate a callback to a request.","minLength":1,"maxLength":64},"seId":{"type":"string","description":"Secure Element Identifier","pattern":"([0-9a-fA-F][0-9a-fA-F]){1,24}"}}}}
```
---
# 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:
```
GET https://docs.payments.thalescloud.io/wallet-server-transit-api-for-huawei/ja/api-rifarensu/song-xin-cao-zuo-tsh-fa-xin/purobijoninguoyobi-api.md?ask=
```
The question should be specific, self-contained, and written in natural language.
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.