Welcome to our new developer portal! Use the "Ask" button to chat with our AI Agent.
For the complete documentation index, see llms.txt. This page is also available as Markdown.

プロビジョニングおよび管理 API

OpenAPI仕様をダウンロード

Get Digital Card Bundle Data

post
/issuers/{issuerId}/wallets/{walletIndicator}/getDigitalCardBundleData

API used for fetching the data required to build the digital card bundle that will be provisioned into a device.

パスパラメータ
issuerIdstring · 最大: 10必須

Issuer unique identifier. Assigned by Thales during onboarding.

walletIndicatornumber必須

Indicates which digital wallet is involved in the use case.

ValueDescription
1Apple
2Google
3Samsung
本文
digitalCardIdstring · 最大: 64必須

Digital card unique identifier

Example: DGGLSW8D8AC610566D4EF09C22186B2A5ED756
cardAccountIdstring · 最大: 64必須

Card account unique identifier

Example: FAPLSW8D8AC610566D4EF09C22186B2A5ED793
userIdstring · 最大: 64オプション

User unique identifier.
Always provided for Apple.

Example: sSHfawfGsHUQjg8zaOHnPPgso5TF
walletIdstring · 最大: 64必須

Wallet unique identifier.
Corresponds to unique device identifier for Apple and Samsung.
Corresponds to unique identifier assigned for a given user and device for Google.

Example: 9i+KsSHjySa7Nxyzpvp6V/mL/fhwwZ7H/NEE9XCGjO6zzKiNnimDDAVHxOFa0jKF
deviceTypenumberオプション

Device type.

valuedescription
1Phone
2Tablet
3Watch
4-99RFU
レスポンス
200成功
application/json
post/issuers/{issuerId}/wallets/{walletIndicator}/getDigitalCardBundleData

Notify Digital Card Event

post
/issuers/{issuerId}/wallets/{walletIndicator}/notifyDigitalCardEvent

API used for notifying events:

  • provisioning

  • lifecycle

  • digital card bundle update (CBT only)

パスパラメータ
issuerIdstring · 最大: 10必須

Issuer unique identifier. Assigned by Thales during onboarding.

walletIndicatornumber必須

Indicates which digital wallet is involved in the use case.

ValueDescription
1Apple
2Google
3Samsung
本文
digitalCardIdstring · 最大: 64必須

Digital card unique identifier

Example: DGGLSW8D8AC610566D4EF09C22186B2A5ED756
cardAccountIdstring · 最大: 64必須

Card account unique identifier

Example: FAPLSW8D8AC610566D4EF09C22186B2A5ED793
walletIdstring · 最大: 64オプション

Wallet unique identifier.
Corresponds to unique device identifier for Apple and Samsung.
Corresponds to unique identifier assigned for a given user and device for Google.

Example: 9i+KsSHjySa7Nxyzpvp6V/mL/fhwwZ7H/NEE9XCGjO6zzKiNnimDDAVHxOFa0jKF
userIdstring · 最大: 64オプション

User unique identifier.
Always provided for Apple.

Example: sSHfawfGsHUQjg8zaOHnPPgso5TF
deviceTypenumberオプション

Device type.

valuedescription
1Phone
2Tablet
3Watch
4-99RFU
eventstring · enum必須可能な値:
eventDataobjectオプション

Object containing contextual information based on event value.
For Calypso card technology, in case of provisioning_success, it will contain the CSN: {"csn":"000000006818F4EB"}

In case of failure, it may contain statusCode and statusMessage to provide more details:
{"statusCode":431,"statusMessage":"Error XYZ"}

digitalCardBundlestringオプション

Last known state of the digital card bundle.
Applicable to CBT only.

レスポンス
200成功
application/json
post/issuers/{issuerId}/wallets/{walletIndicator}/notifyDigitalCardEvent

Manage Digital Card

post
/issuers/{issuerId}/wallets/{walletIndicator}/manageDigitalCard

API used for managing digital cards state change trigger by Digital Wallets.

パスパラメータ
issuerIdstring · 最大: 10必須

Issuer unique identifier. Assigned by Thales during onboarding.

walletIndicatornumber必須

Indicates which digital wallet is involved in the use case.

ValueDescription
1Apple
2Google
3Samsung
本文
digitalCardIdstring · 最大: 64必須

Digital card unique identifier

Example: DGGLSW8D8AC610566D4EF09C22186B2A5ED756
cardAccountIdstring · 最大: 64必須

Card account unique identifier

Example: FAPLSW8D8AC610566D4EF09C22186B2A5ED793
actionstring · enum必須可能な値:
initiatorstring · enumオプション

Indicates whether the action is initiated from the device or via cloud interface.
Applicable to 'unlink' action and CBT only.

可能な値:
レスポンス
200成功
application/json
post/issuers/{issuerId}/wallets/{walletIndicator}/manageDigitalCard

Get Card Account Metadata

post
/issuers/{issuerId}/wallets/{walletIndicator}/getCardAccountMetadata

API used for getting the metadata of an account.

パスパラメータ
issuerIdstring · 最大: 10必須

Issuer unique identifier. Assigned by Thales during onboarding.

walletIndicatornumber必須

Indicates which digital wallet is involved in the use case.

ValueDescription
1Apple
2Google
3Samsung
本文
cardAccountIdstring · 最大: 64必須

Card account unique identifier

Example: FAPLSW8D8AC610566D4EF09C22186B2A5ED793
レスポンス
200成功
application/json
displayCardValuestring · 最小: 1 · 最大: 20必須

Value of the card to be displayed to the user.

Example: 458965204578
cardArtsIdstring · 最大: 64オプション

Identifier referencing card arts configuration used for this card.
Default value configured during onboarding is used if this parameter is not provided.

Example: 046d8480-c229-49d3-b2b0-cfe135da1da4
post/issuers/{issuerId}/wallets/{walletIndicator}/getCardAccountMetadata

Purchase Products

post
/issuers/{issuerId}/wallets/{walletIndicator}/purchaseProducts

API used to request the purchase of products initiated from Digital Wallets.

パスパラメータ
issuerIdstring · 最大: 10必須

Issuer unique identifier. Assigned by Thales during onboarding.

walletIndicatornumber必須

Indicates which digital wallet is involved in the use case.

ValueDescription
1Apple
2Google
3Samsung
本文
userIdstring · 最大: 64オプション

User unique identifier

Example: sSHfawfGsHUQjg8zaOHnPPgso5TF
cardAccountIdstring · 最大: 64必須

Card account unique identifier

Example: FAPLSW8D8AC610566D4EF09C22186B2A5ED793
digitalCardIdstring · 最大: 64必須

Digital card unique identifier

Example: DGGLSW8D8AC610566D4EF09C22186B2A5ED756
orderIdstring · 最大: 64必須

Order unique identifier

paymentCredentialsobject必須

Payment credentials encrypted with PSP key.
Clear format is defined as per wallet specification here.

totalAmountnumber · float必須

Amount

Example: 12.9
currencyCodestring必須

The 3-letter currency code defined in ISO 4217

Example: EURPattern: ^[A-Za-z]{3}$
レスポンス
200成功
application/json
purchaseIdstring · 最大: 64オプション

Purchase unique identifier

Example: P20160107_123456
post/issuers/{issuerId}/wallets/{walletIndicator}/purchaseProducts

Get Purchasable Products

post
/issuers/{issuerId}/wallets/{walletIndicator}/getPurchasableProducts

API used for fetching the list of purchasable products.

パスパラメータ
issuerIdstring · 最大: 10必須

Issuer unique identifier. Assigned by Thales during onboarding.

walletIndicatornumber必須

Indicates which digital wallet is involved in the use case.

ValueDescription
1Apple
2Google
3Samsung
本文
cardAccountIdstring · 最大: 64オプション

Card account unique identifier.
Not provided when Google is fetching the list of purchasable products for initial provisionings (done on daily basis).
Always provided otherwise.

Example: FAPLSW8D8AC610566D4EF09C22186B2A5ED793
digitalCardIdstring · 最大: 64オプション

Digital card unique identifier

Example: DGGLSW8D8AC610566D4EF09C22186B2A5ED756
productIdstring · 最大: 64オプション

Unique identifier of a time based product.
Provided when checking renewal options of this product.

Example: 6489d6ae-231d-4260-afd6-5fa44ede0d59
digitalCardBundlestringオプション

Last known state of the digital card bundle.
Applicable to CBT only.

レスポンス
200成功
application/json
post/issuers/{issuerId}/wallets/{walletIndicator}/getPurchasableProducts

Register Card Account

post
/issuers/{issuerId}/wallets/{walletIndicator}/registerCardAccount

API used for registering a card account and binding it with an existing EMV tokenId. This API is only applicable to Google Transit Insights (GTI).

パスパラメータ
issuerIdstring · 最大: 10必須

Issuer unique identifier. Assigned by Thales during onboarding.

walletIndicatornumber必須

Indicates which digital wallet is involved in the use case.

ValueDescription
1Apple
2Google
3Samsung
本文
cardAccountIdstring · 最大: 64必須

Card account unique identifier

Example: FAPLSW8D8AC610566D4EF09C22186B2A5ED793
digitalCardIdstring · 最大: 64必須

Digital card unique identifier

Example: DGGLSW8D8AC610566D4EF09C22186B2A5ED756
tokenDatastring必須

Encrypted Token Data about the token the user wants to register.
It is encrypted using the JWE encryption (please refer to Encrypt Sensitive Data section for more details).
The JSON object that is encrypted is defined as follows:

JSON field parameter namedescription
panThe token PAN value (up to 19 numeric digits)
expiryMonthThe expiry month of the token in MM format
expiryYearThe expiry year of the token in YYYY format
tokenIdstring · 最大: 64オプション

Token unique identifier.
Provided only in case of re-registration.

Example: 63a0c6dd-2993-49f3-b6ac-9721fbe0877e
レスポンス
200成功
application/json
tokenIdstring · 最大: 64オプション

Token unique identifier.
It's the value identified by payment gateway thanks to tokenData provided as input.

Example: 63a0c6dd-2993-49f3-b6ac-9721fbe0877e
post/issuers/{issuerId}/wallets/{walletIndicator}/registerCardAccount

Get Digital Card Bundle Commands

post
/issuers/{issuerId}/wallets/{walletIndicator}/getDigitalCardBundleCommands

API used for fetching the commands required to update/read a digital card bundle provisioned within a device. Transit Issuer has to return the list of commands that needs to be executed on the device after checking the previous commands responses. This API is only applicable to CBT.

パスパラメータ
issuerIdstring · 最大: 10必須

Issuer unique identifier. Assigned by Thales during onboarding.

walletIndicatornumber必須

Indicates which digital wallet is involved in the use case.

ValueDescription
1Apple
2Google
3Samsung
本文
digitalCardIdstring · 最大: 64必須

Digital card unique identifier

Example: DGGLSW8D8AC610566D4EF09C22186B2A5ED756
cardAccountIdstring · 最大: 64必須

Card account unique identifier

Example: FAPLSW8D8AC610566D4EF09C22186B2A5ED793
incompletedExecutionbooleanオプション

Flag indicating that the commands from previous responses array were not all executed successfully.

レスポンス
200成功
application/json
post/issuers/{issuerId}/wallets/{walletIndicator}/getDigitalCardBundleCommands

Get Transactions

post
/issuers/{issuerId}/wallets/{walletIndicator}/getTransactions

API used to fetch transaction and balance details from the Transit Issuer. This API is only applicable to ABT.

パスパラメータ
issuerIdstring · 最大: 10必須

Issuer unique identifier. Assigned by Thales during onboarding.

walletIndicatornumber必須

Indicates which digital wallet is involved in the use case.

ValueDescription
1Apple
2Google
3Samsung
本文
digitalCardIdstring · 最大: 64オプション

Digital card unique identifier

Example: DGGLSW8D8AC610566D4EF09C22186B2A5ED756
cardAccountIdstring · 最大: 64必須

Card account unique identifier

Example: FAPLSW8D8AC610566D4EF09C22186B2A5ED793
lastUpdatedTimestring · date-timeオプション

Value that should be used to provide updates that occurred since that time.

レスポンス
200成功
application/json
post/issuers/{issuerId}/wallets/{walletIndicator}/getTransactions

Get Messages

post
/issuers/{issuerId}/wallets/{walletIndicator}/getMessages

API used to fetch messages from the Transit Issuer.

パスパラメータ
issuerIdstring · 最大: 10必須

Issuer unique identifier. Assigned by Thales during onboarding.

walletIndicatornumber必須

Indicates which digital wallet is involved in the use case.

ValueDescription
1Apple
2Google
3Samsung
本文
digitalCardIdstring · 最大: 64オプション

Digital card unique identifier

Example: DGGLSW8D8AC610566D4EF09C22186B2A5ED756
cardAccountIdstring · 最大: 64必須

Card account unique identifier

Example: FAPLSW8D8AC610566D4EF09C22186B2A5ED793
lastUpdatedTimestring · date-timeオプション

Value that should be used to provide updates that occurred since that time.

レスポンス
200成功
application/json
post/issuers/{issuerId}/wallets/{walletIndicator}/getMessages

最終更新

役に立ちましたか?