Welcome to our new developer portal! Use the "Ask" button to chat with our AI Agent.

トークン発行・管理 API

TSP-API-OUT-v2-Provisioning-Management-oas2.yaml

POST /tokens

post

This method is used by TSH to request the creation of a new token.

ヘッダーパラメータ
x-correlation-idstring · 最小: 1 · 最大: 64必須

Unique identifier used to trace function calls across systems

本文
issuerIdstring · 最小: 10 · 最大: 10必須

Unique Identifier of Issuer

Example: ISSUER1234
issuerCardRefIdstring · 最小: 1 · 最大: 64オプション

A unique identifier of the issuer that aims to identify the funding card.
This parameter is provided by the TSH unless it's not connected to Issuer.
This identifier might be updated by Issuer on card replacement/renewal flows.

walletCardRefIdstring · 最小: 1 · 最大: 64必須

A unique identifier of the wallet provider that aims to identify the funding card.
This parameter is provided by the TSH.
For ApplePay, it corresponds to the FPANID.
This identifier remains constant even on card replacement/renewal flows.

cipheredCardInfostring · 最小: 1 · 最大: 8196オプション

TSH sends card information as JSON encrypted using the PKCS#7 encryption scheme defined in RFC 2315/5652 using following encryption parameters:

  • The content encryption algorithm used is AES256/CBC/PKCS7Padding using a randomly generated AES key.
  • The key encryption algorithm is either RSAES-PKCS1-v1_5 (RSA/NONE/PKCS1Padding) or RSA/NONE/OAEPWithSHA256AndMGF1Padding (with MGF1 using SHA-256), using the certificate provided during onboarding.
    The key encryption algorithm is defined during onboarding and is by default (if ommitted) the RSA/NONE/PKCS1Padding for legacy purpose.
    It is recommended to configure RSA/NONE/OAEPWithSHA256AndMGF1Padding (with MGF1 using SHA-256) for new TSPs.
  • The encryption result is then encoded using base64.
  • The public key length in the certificate can be 2048-bit or 4096-bit.

Once deciphered, the card info contains the following information:

JSON field parameter namedescriptionMOCLength
fpanThe funding pan to digitizeMUp to 19
expThe expiry date in the format MMYYO4
cvvDepending of the OEM, this value is provided or notO3 or 4
additionalCardInfosOptional JSON Open format, in order to add additional card info - project dependentOUp to 8177

Note: If not provided, the TSP must rely on the walletCardRefId provided to find the funding card to digitize from its token vault.

publicKeyIdentifierstring · 最小: 1 · 最大: 32オプション

Identifier of the key used to encrypt cipheredCardInfo.
Provided by TSP to Thales during onboarding.

tokenProductIdstring · 最小: 1 · 最大: 48オプション

ID of the token product (Identify token domain).

As the token products are mapped to Issuer card products, the values shall be defined at the begining of the project with the TSP.

tokenRequestorIdstring · 最小: 1 · 最大: 48必須

ID of the token requestor in the format expected by the TSP

tokenStorageIdstring · 最小: 1 · 最大: 64必須

Token storage unique identifier (also known as deviceId or applicationId).
Indicates the storage in which the token has been digitized.
For ApplePay, it corresponds to the device SEID.

reusedTokenIdstring · 最小: 1 · 最大: 48オプション

The tokenId provided in case the Wallet Provider wants to re-use an existing token.
This is applicable for Apple Pay only and needs to have an agreement on this process at the beginning of a project.

initialStatestring · enumオプション

Initial state of the token when created.
Default value is SUSPENDED

Example: SUSPENDED可能な値:
レスポンス
post
/tokens

PUT /tokens/{tokenId}/cardInfo

put

This method is used by TSH to request the update of funding pan information of the token

パスパラメータ
tokenIdstring · 最小: 1 · 最大: 48必須

Identifier of the token to update

ヘッダーパラメータ
x-correlation-idstring · 最小: 1 · 最大: 64必須

Unique identifier used to trace function calls across systems

本文
issuerIdstring · 最小: 10 · 最大: 10必須

Unique Identifier of Issuer

Example: ISSUER1234
newCipheredCardInfostring · 最小: 1 · 最大: 8196必須

TSH sends new card information as JSON encrypted using the PKCS#7 encryption scheme defined in RFC 2315/5652 using following encryption parameters:

  • The content encryption algorithm used is AES256/CBC/PKCS7Padding using a randomly generated AES key.
  • The key encryption algorithm is either RSAES-PKCS1-v1_5 (RSA/NONE/PKCS1Padding) or RSA/NONE/OAEPWithSHA256AndMGF1Padding (with MGF1 using SHA-256), using the certificate provided during onboarding.
    The key encryption algorithm is defined during onboarding and is by default (if ommitted) the RSA/NONE/PKCS1Padding for legacy purpose.
    It is recommended to configure RSA/NONE/OAEPWithSHA256AndMGF1Padding (with MGF1 using SHA-256) for new TSPs.
  • The encryption result is then encoded using base64.
  • The public key length in the certificate can be 2048-bit or 4096-bit.

Once deciphered, the card info contains the following information:

JSON field parameter namedescriptionMOCLength
newFpanThe new funding pan value to updateOUp to 19
newExpThe new expiry date in the format MMYYO4
newAdditionalCardInfosOptional JSON Open format, in order add/update/delete additional card info - project dependentOUp to 8177

Note: At least one of the three JSON fields needs to be provided.

publicKeyIdentifierstring · 最小: 1 · 最大: 32オプション

Identifier of the key used to encrypt newCipheredCardInfo.
Provided by TSP to Thales during onboarding.

newIssuerCardRefIdstring · 最小: 1 · 最大: 64オプション

New unique identifier of the issuer that aims to identify the funding card.

レスポンス
204

successful

コンテンツなし

put
/tokens/{tokenId}/cardInfo

コンテンツなし

PUT /tokens/{tokenId}/state

put

This method is used by TSH to request the update of token state

パスパラメータ
tokenIdstring · 最小: 1 · 最大: 48必須

Identifier of the token to update

ヘッダーパラメータ
x-correlation-idstring · 最小: 1 · 最大: 64必須

Unique identifier used to trace function calls across systems

本文
issuerIdstring · 最小: 10 · 最大: 10必須

Unique Identifier of Issuer

Example: ISSUER1234
newStatestring · enum必須

state of the token

可能な値:
reasonstring · 最小: 1 · 最大: 16オプション

The reason of the state update

Possible values are:

reason codedescription
11001Activation from user interaction
21001Activation initiated by the issuer
21002Deletion initiated by the issuer
11002Deletion initiated by the user
21003Suspension initiated by the issuer
11003Suspension initiated by the user
21004Resumption initiated by the issuer
11004Resumption initiated by the user
レスポンス
204

successful

コンテンツなし

put
/tokens/{tokenId}/state

コンテンツなし

POST /tokens/{tokenId}/replenishment

post

This method is used by TSH, in case of HCE, to request replenishment of payment credentials in the mobile wallet. This API only applies to TSH Pay solution (Issuer HCE wallet).

パスパラメータ
tokenIdstring · 最小: 1 · 最大: 48必須

Identifier of the token to update

ヘッダーパラメータ
x-correlation-idstring · 最小: 1 · 最大: 64必須

Unique identifier used to trace function calls across systems

本文
issuerIdstring · 最小: 10 · 最大: 10必須

Unique Identifier of Issuer

Example: ISSUER1234
atcstring · 最小: 4 · 最大: 4必須

Value of the application transaction counter that will be used in the next payment transaction. The ATC is encoded as an hexa string on 4 digits.

lastRepCounterstring · 最大: 5必須

Value of the replenishment counter for the last replenishment.

schemeTranRecordsstring · 最大: 2000オプション

Transaction records for the last transactions as specified by the payment scheme. The transaction records data is encoded in base 64.

schemeTranRecSigstring · 最大: 200オプション

Signature of the transaction records computed according to the scheme specifications and encoded in hexa.

レスポンス
post
/tokens/{tokenId}/replenishment

PUT /tokens/{tokenId}/replenishment/status

put

This method is used by TSH, in case of HCE, to notify the TSP the replenishment of payment credentials has been completed in the mobile wallet. This API only applies to TSH Pay solution (Issuer HCE wallet).

パスパラメータ
tokenIdstring · 最小: 1 · 最大: 48必須

Identifier of the token to update

ヘッダーパラメータ
x-correlation-idstring · 最小: 1 · 最大: 64必須

Unique identifier used to trace function calls across systems

本文
issuerIdstring · 最小: 10 · 最大: 10必須

Unique Identifier of Issuer

Example: ISSUER1234
repCounterstring · 最大: 5必須

Value of the replenishment counter for the last replenishment.

diversifiersstring[]オプション

Payment credential diversifier:

  • For an SUK, this is an ATC which is a string of 4 hexa digits.
  • For an LUK, this is an "YHHHHCC" Visa CBP diversifier which is a string of 7 digits.
レスポンス
204

successful

コンテンツなし

put
/tokens/{tokenId}/replenishment/status

コンテンツなし

PUT /tokens/{tokenId}/newData/status

put

This method is used by TSH to inform the TSP about the token re-personalization result in case of token renewal.

パスパラメータ
tokenIdstring · 最小: 1 · 最大: 48必須

Identifier of the token to update

ヘッダーパラメータ
x-correlation-idstring · 最小: 1 · 最大: 64必須

Unique identifier used to trace function calls across systems

本文
issuerIdstring · 最小: 10 · 最大: 10必須

Unique Identifier of Issuer

Example: ISSUER1234
statusstring · enum必須可能な値:
レスポンス
204

successful

コンテンツなし

put
/tokens/{tokenId}/newData/status

コンテンツなし

GET /healthCheck

get

This method is used by TSH to monitor TSP health. It should be used every 30 seconds in production environment.

ヘッダーパラメータ
x-request-idstring · 最小: 1 · 最大: 64必須

Unique identifier of the request

レスポンス
204

successful

コンテンツなし

get
/healthCheck

コンテンツなし

POST /tokens/{tokenId}/reperso

post

This request is triggered when TSH has to repersonalize a token and requires all the data elements associated.

After this request, TSP shall recover all the existing elements and submit it to the TSH through Submit New Token Data.

TSH will callback TSP through the Notify Token Reperso Result to notify the profile has been pushed to the device with success. At this moment, TSP shall set the ATC to zero to sync with the ATC personalized in the device.

パスパラメータ
tokenIdstring · 最小: 1 · 最大: 48必須

Identifier of the token to update

ヘッダーパラメータ
x-correlation-idstring · 最小: 1 · 最大: 64必須

Unique identifier used to trace function calls across systems

本文
issuerIdstring · 最小: 10 · 最大: 10オプション

Unique Identifier of Issuer

Example: ISSUER1234
レスポンス
204

successful

コンテンツなし

post
/tokens/{tokenId}/reperso

コンテンツなし

POST /tokens/{tokenId}/appletUpdate

post

For ApplePay only. This notification informs the TSP that the applet version was updated by Apple.

パスパラメータ
tokenIdstring · 最小: 1 · 最大: 48必須

Identifier of the token to update

ヘッダーパラメータ
x-correlation-idstring · 最小: 1 · 最大: 64必須

Unique identifier used to trace function calls across systems

本文
issuerIdstring · 最小: 10 · 最大: 10必須

Unique Identifier of Issuer

Example: ISSUER1234
appletVersionstring · 最小: 1 · 最大: 32必須

Only for ApplePay. Applet version as provided by the Wallet Provider.

Example: 1.22
レスポンス
204

successful

コンテンツなし

post
/tokens/{tokenId}/appletUpdate

コンテンツなし

POST /listTokens

post

This method is used by TSH to request the list of tokens associated to either a funding PAN, a card reference ID or a token PAN. In case of a search by token PAN, the list returned by TSP shall contain 1 element at most.

ヘッダーパラメータ
x-correlation-idstring · 最小: 1 · 最大: 64必須

Unique identifier used to trace function calls across systems

本文
issuerIdstring · 最小: 10 · 最大: 10必須

Unique Identifier of Issuer

Example: ISSUER1234
cipheredCardInfostring · 最小: 1 · 最大: 8196オプション

TSH sends card information as JSON encrypted using the PKCS#7 encryption scheme defined in RFC 2315/5652 using following encryption parameters:

  • The content encryption algorithm used is AES256/CBC/PKCS7Padding using a randomly generated AES key.
  • The key encryption algorithm is either RSAES-PKCS1-v1_5 (RSA/NONE/PKCS1Padding) or RSA/NONE/OAEPWithSHA256AndMGF1Padding (with MGF1 using SHA-256), using the certificate provided during onboarding.
    The key encryption algorithm is defined during onboarding and is by default (if ommitted) the RSA/NONE/PKCS1Padding for legacy purpose.
    It is recommended to configure RSA/NONE/OAEPWithSHA256AndMGF1Padding (with MGF1 using SHA-256) for new TSPs.
  • The encryption result is then encoded using base64.
  • The public key length in the certificate can be 2048-bit or 4096-bit.

Once deciphered, the card info contains the following information:

JSON field parameter namedescriptionMOCLength
fpanThe funding panMUp to 19
cipheredTokenInfostring · 最小: 1 · 最大: 8196オプション

TSH sends token information as JSON encrypted using the PKCS#7 encryption scheme defined in RFC 2315/5652 using following encryption parameters:

  • The content encryption algorithm used is AES256/CBC/PKCS7Padding using a randomly generated AES key.
  • The key encryption algorithm is either RSAES-PKCS1-v1_5 (RSA/NONE/PKCS1Padding) or RSA/NONE/OAEPWithSHA256AndMGF1Padding (with MGF1 using SHA-256), using the certificate provided during onboarding.
    The key encryption algorithm is defined during onboarding and is by default (if ommitted) the RSA/NONE/PKCS1Padding for legacy purpose.
    It is recommended to configure RSA/NONE/OAEPWithSHA256AndMGF1Padding (with MGF1 using SHA-256) for new TSPs.
  • The encryption result is then encoded using base64.
  • The public key length in the certificate can be 2048-bit or 4096-bit.

Once deciphered, the card info contains the following information:

JSON field parameter namedescriptionMOCLength
dpanThe token PANMUp to 19
issuerCardRefIdstring · 最小: 1 · 最大: 64オプション

A unique identifier of the issuer that aims to identify the funding card.
This parameter is provided by the TSH unless it's not connected to Issuer.
This identifier might be updated by Issuer on card replacement/renewal flows.

publicKeyIdentifierstring · 最小: 1 · 最大: 32オプション

Identifier of the key used to encrypt cipheredCardInfo.
Provided by TSP to Thales during onboarding.

レスポンス
post
/listTokens

POST /tokens/{tokenId}/replenish

post

This request is triggered when TSH has to replenish a token. This API only applies to Google Pay solution.

パスパラメータ
tokenIdstring · 最小: 1 · 最大: 48必須

Identifier of the token to update

ヘッダーパラメータ
x-correlation-idstring · 最小: 1 · 最大: 64必須

Unique identifier used to trace function calls across systems

本文
issuerIdstring · 最小: 10 · 最大: 10オプション

Unique Identifier of Issuer

Example: ISSUER1234
レスポンス
post
/tokens/{tokenId}/replenish

PUT /tokens/{tokenId}/replenish/done

put

This method is used by TSH to inform the TSP that the token replenishment has been done. This API only applies to Google Pay solution.

パスパラメータ
tokenIdstring · 最小: 1 · 最大: 48必須

Identifier of the token to update

ヘッダーパラメータ
x-correlation-idstring · 最小: 1 · 最大: 64必須

Unique identifier used to trace function calls across systems

本文
issuerIdstring · 最小: 10 · 最大: 10必須

Unique Identifier of Issuer

Example: ISSUER1234
レスポンス
204

successful

コンテンツなし

put
/tokens/{tokenId}/replenish/done

コンテンツなし

最終更新

役に立ちましたか?