API de Aprovisionamiento y Gestión

WS-Transit-API-OUT-oas2.yaml

Request to send a script to a device

post

This method is used by TSH to provide a script to a device.

Parámetros de encabezado

x-podstring · máx: 128Requerido

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.

Cuerpo

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

Unique task identifier used to correlate a callback to a request.

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

The Wallet Card Identifier. Unique for each wallet card.

seIdstringRequerido

Secure Element Identifier

Pattern: ([0-9a-fA-F][0-9a-fA-F]){1,24}

Respuestas

200

sendScript response payload

application/json

500

Internal Server Error

post/sendScript

POST /sendScript HTTP/1.1
x-pod: text
Content-Type: application/json
Accept: */*
Content-Length: 230

{
  "requestHeader": {
    "requestId": "text",
    "sessionId": "text",
    "generationDateTime": "2026-01-01T00:00:00.000Z"
  },
  "taskId": "text",
  "walletCardId": "text",
  "seId": "text",
  "apduCommands": [
    {
      "data": "text",
      "messageId": "text",
      "messageName": "text"
    }
  ]
}

{
  "responseHeader": {
    "responseId": "text",
    "sessionId": "text",
    "generationDateTime": "2026-01-01T00:00:00.000Z",
    "statusCode": 1,
    "statusMessage": "text"
  }
}

Request to update a digital card

post

This method is used by TSH to request to update a digital card.

Parámetros de encabezado

x-podstring · máx: 128Requerido

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.

Cuerpo

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

Unique task identifier used to correlate a callback to a request.

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

The Wallet Card Identifier. Unique for each wallet card.

seIdstringRequerido

Secure Element Identifier

Pattern: ([0-9a-fA-F][0-9a-fA-F]){1,24}

operationstring · enumRequerido

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.

Valores posibles:

Respuestas

200

updateCard response payload

application/json

500

Internal Server Error

post/updateCard

POST /updateCard HTTP/1.1
x-pod: text
Content-Type: application/json
Accept: */*
Content-Length: 691

{
  "requestHeader": {
    "requestId": "text",
    "sessionId": "text",
    "generationDateTime": "2026-01-01T00:00:00.000Z"
  },
  "taskId": "text",
  "walletCardId": "text",
  "seId": "text",
  "operation": "SUSPEND",
  "cardDescriptor": {
    "appletCurrencyCode": "text",
    "displayCardNumber": "text",
    "cardholderName": "text",
    "cardArtManifest": [
      "text"
    ],
    "labelColor": "text",
    "shortDescription": "text",
    "longDescription": "text",
    "privacyPolicyURL": "text",
    "termsAndConditionsURL": "text",
    "contactWebsite": "text",
    "contactEmail": "text",
    "contactNumber": "text",
    "contactName": "text",
    "cardActions": {
      "minLoadedBalance": 1,
      "maxLoadedBalance": 1,
      "minLoadAmount": 1,
      "maxLoadAmount": 1
    },
    "mobileApp": {
      "identifier": "text",
      "action": "text",
      "intentExtraText": "text"
    }
  }
}

{
  "responseHeader": {
    "responseId": "text",
    "sessionId": "text",
    "generationDateTime": "2026-01-01T00:00:00.000Z",
    "statusCode": 1,
    "statusMessage": "text"
  }
}

Request to get the status of a task

post

This method is used by TSH to request a task status.

Parámetros de encabezado

x-podstring · máx: 128Requerido

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.

Cuerpo

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

Unique task identifier used to correlate a callback to a request.

seIdstringRequerido

Secure Element Identifier

Pattern: ([0-9a-fA-F][0-9a-fA-F]){1,24}

Respuestas

200

getTaskStatus response payload

application/json

taskStatusstring · enumOpcionalValores posibles:

500

Internal Server Error

post/getTaskStatus

POST /getTaskStatus HTTP/1.1
x-pod: text
Content-Type: application/json
Accept: */*
Content-Length: 135

{
  "requestHeader": {
    "requestId": "text",
    "sessionId": "text",
    "generationDateTime": "2026-01-01T00:00:00.000Z"
  },
  "taskId": "text",
  "seId": "text"
}

{
  "responseHeader": {
    "responseId": "text",
    "sessionId": "text",
    "generationDateTime": "2026-01-01T00:00:00.000Z",
    "statusCode": 1,
    "statusMessage": "text"
  },
  "taskStatus": "PROCESSING"
}