Provisioning and Management API

Download OpenAPI specification

D1-Transit-API-OUT-Provisioning-Management-oas3.yaml

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.

Path parameters

issuerIdstring · max: 10Required

Issuer unique identifier. Assigned by Thales during onboarding.

walletIndicatornumberRequired

Indicates which digital wallet is involved in the use case.

Value	Description
1	Apple
2	Google
3	Samsung

Body

digitalCardIdstring · max: 64Required

Digital card unique identifier

Example: DGGLSW8D8AC610566D4EF09C22186B2A5ED756

cardAccountIdstring · max: 64Required

Card account unique identifier

Example: FAPLSW8D8AC610566D4EF09C22186B2A5ED793

userIdstring · max: 64Optional

User unique identifier.
Always provided for Apple.

Example: sSHfawfGsHUQjg8zaOHnPPgso5TF

walletIdstring · max: 64Required

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

deviceTypenumberOptional

Device type.

value	description
1	Phone
2	Tablet
3	Watch
4-99	RFU

Responses

200Success

application/json

500

An unexpected error occurred while processing the request.
The request cannot be retried.
Only used in cases where it's not be possible to provide more information about what went wrong with the request (i.e. return HTTP 200 with 'responseContext').

503

Indicates that the system is unavailable.
The request can be retried.

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

POST /d1/transit/api/v1/issuers/{issuerId}/wallets/{walletIndicator}/getDigitalCardBundleData HTTP/1.1
Host: CUSTOMER-PROD
Content-Type: application/json
Accept: */*
Content-Length: 373

{
  "requestContext": {
    "requestId": "493f7686-93a0-494a-a44f-867fcd10ce22",
    "correlationId": "bfd8450f-a605-4427-9714-1d620f14dda1"
  },
  "digitalCardId": "DGGLSW8D8AC610566D4EF09C22186B2A5ED756",
  "cardAccountId": "FAPLSW8D8AC610566D4EF09C22186B2A5ED793",
  "userId": "sSHfawfGsHUQjg8zaOHnPPgso5TF",
  "walletId": "9i+KsSHjySa7Nxyzpvp6V/mL/fhwwZ7H/NEE9XCGjO6zzKiNnimDDAVHxOFa0jKF",
  "deviceType": 1
}

{
  "responseContext": {
    "requestId": "a762c0a1-2ae7-42b1-a4d8-8d8ba09bdf30",
    "statusCode": 0,
    "statusMessage": "OK"
  },
  "persoData": [
    {
      "name": "text",
      "value": "text"
    }
  ],
  "metaData": {
    "displayCardValue": "458965204578",
    "cardArtsId": "046d8480-c229-49d3-b2b0-cfe135da1da4",
    "productsList": [
      {
        "productId": "6489d6ae-231d-4260-afd6-5fa44ede0d59",
        "productType": "stored-value",
        "displayName": {
          "defaultValue": "Default",
          "translatedValues": [
            {
              "value": "defaut",
              "language": "fr"
            }
          ]
        },
        "displayDetails": {
          "defaultValue": "Default",
          "translatedValues": [
            {
              "value": "defaut",
              "language": "fr"
            }
          ]
        },
        "fare": {
          "fareId": "Fare_abc",
          "fareClass": "first",
          "concession": "full fare",
          "concessionExpiry": "2026-07-11T15:14:50.766Z"
        },
        "validityParameters": {
          "numberOfTrips": 10,
          "timeLimits": {
            "startTime": "2026-07-11T15:14:50.766Z",
            "endTime": "2026-07-11T15:14:50.766Z"
          },
          "validityAfterTapIn": {
            "timeUnit": "second",
            "value": 1
          },
          "validityAfterTapOut": {
            "timeUnit": "second",
            "value": 1
          },
          "zoneLimits": {
            "fromZone": {
              "id": "text",
              "displayName": "text"
            },
            "toZone": {
              "id": "text",
              "displayName": "text"
            }
          },
          "stationLimits": {
            "fromStation": {
              "id": "Station_123",
              "displayName": "Marvelous Station"
            },
            "toStation": {
              "id": "Station_123",
              "displayName": "Marvelous Station"
            }
          },
          "topupLimits": {
            "minAmount": 5,
            "maxAmount": 50
          }
        },
        "eligibleForTopup": true,
        "renewalPeriod": {
          "startTime": "2026-07-11T15:14:50.766Z",
          "relativeStartTime": 1,
          "unavailableBeforeReason": "Too soon",
          "endTime": "2026-07-11T15:14:50.766Z",
          "relativeEndTime": 1,
          "unavailableAfterReason": "Too late"
        }
      }
    ]
  }
}

Notify Digital Card Event

post

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

API used for notifying events:

provisioning
lifecycle
digital card bundle update (CBT only)

Path parameters

issuerIdstring · max: 10Required

Issuer unique identifier. Assigned by Thales during onboarding.

walletIndicatornumberRequired

Indicates which digital wallet is involved in the use case.

Value	Description
1	Apple
2	Google
3	Samsung

Body

digitalCardIdstring · max: 64Required

Digital card unique identifier

Example: DGGLSW8D8AC610566D4EF09C22186B2A5ED756

cardAccountIdstring · max: 64Required

Card account unique identifier

Example: FAPLSW8D8AC610566D4EF09C22186B2A5ED793

walletIdstring · max: 64Optional

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 · max: 64Optional

User unique identifier.
Always provided for Apple.

Example: sSHfawfGsHUQjg8zaOHnPPgso5TF

deviceTypenumberOptional

Device type.

value	description
1	Phone
2	Tablet
3	Watch
4-99	RFU

eventstring · enumRequiredPossible values:

eventDataobjectOptional

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"}

digitalCardBundlestringOptional

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

Responses

200Success

application/json

500

503

Indicates that the system is unavailable.
The request can be retried.

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

POST /d1/transit/api/v1/issuers/{issuerId}/wallets/{walletIndicator}/notifyDigitalCardEvent HTTP/1.1
Host: CUSTOMER-PROD
Content-Type: application/json
Accept: */*
Content-Length: 446

{
  "requestContext": {
    "requestId": "493f7686-93a0-494a-a44f-867fcd10ce22",
    "correlationId": "bfd8450f-a605-4427-9714-1d620f14dda1"
  },
  "digitalCardId": "DGGLSW8D8AC610566D4EF09C22186B2A5ED756",
  "cardAccountId": "FAPLSW8D8AC610566D4EF09C22186B2A5ED793",
  "walletId": "9i+KsSHjySa7Nxyzpvp6V/mL/fhwwZ7H/NEE9XCGjO6zzKiNnimDDAVHxOFa0jKF",
  "userId": "sSHfawfGsHUQjg8zaOHnPPgso5TF",
  "deviceType": 1,
  "event": "provisioning_success",
  "eventData": {},
  "digitalCardBundle": "text"
}

{
  "responseContext": {
    "requestId": "a762c0a1-2ae7-42b1-a4d8-8d8ba09bdf30",
    "statusCode": 0,
    "statusMessage": "OK"
  }
}

Manage Digital Card

post

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

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

Path parameters

issuerIdstring · max: 10Required

Issuer unique identifier. Assigned by Thales during onboarding.

walletIndicatornumberRequired

Indicates which digital wallet is involved in the use case.

Value	Description
1	Apple
2	Google
3	Samsung

Body

digitalCardIdstring · max: 64Required

Digital card unique identifier

Example: DGGLSW8D8AC610566D4EF09C22186B2A5ED756

cardAccountIdstring · max: 64Required

Card account unique identifier

Example: FAPLSW8D8AC610566D4EF09C22186B2A5ED793

actionstring · enumRequiredPossible values:

initiatorstring · enumOptional

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

Possible values:

Responses

200Success

application/json

500

503

Indicates that the system is unavailable.
The request can be retried.

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

POST /d1/transit/api/v1/issuers/{issuerId}/wallets/{walletIndicator}/manageDigitalCard HTTP/1.1
Host: CUSTOMER-PROD
Content-Type: application/json
Accept: */*
Content-Length: 279

{
  "requestContext": {
    "requestId": "493f7686-93a0-494a-a44f-867fcd10ce22",
    "correlationId": "bfd8450f-a605-4427-9714-1d620f14dda1"
  },
  "digitalCardId": "DGGLSW8D8AC610566D4EF09C22186B2A5ED756",
  "cardAccountId": "FAPLSW8D8AC610566D4EF09C22186B2A5ED793",
  "action": "unlink",
  "initiator": "device"
}

{
  "responseContext": {
    "requestId": "a762c0a1-2ae7-42b1-a4d8-8d8ba09bdf30",
    "statusCode": 0,
    "statusMessage": "OK"
  }
}

Get Card Account Metadata

post

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

API used for getting the metadata of an account.

Path parameters

issuerIdstring · max: 10Required

Issuer unique identifier. Assigned by Thales during onboarding.

walletIndicatornumberRequired

Indicates which digital wallet is involved in the use case.

Value	Description
1	Apple
2	Google
3	Samsung

Body

cardAccountIdstring · max: 64Required

Card account unique identifier

Example: FAPLSW8D8AC610566D4EF09C22186B2A5ED793

Responses

200Success

application/json

displayCardValuestring · min: 1 · max: 20Required

Value of the card to be displayed to the user.

Example: 458965204578

cardArtsIdstring · max: 64Optional

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

500

503

Indicates that the system is unavailable.
The request can be retried.

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

POST /d1/transit/api/v1/issuers/{issuerId}/wallets/{walletIndicator}/getCardAccountMetadata HTTP/1.1
Host: CUSTOMER-PROD
Content-Type: application/json
Accept: */*
Content-Length: 183

{
  "requestContext": {
    "requestId": "493f7686-93a0-494a-a44f-867fcd10ce22",
    "correlationId": "bfd8450f-a605-4427-9714-1d620f14dda1"
  },
  "cardAccountId": "FAPLSW8D8AC610566D4EF09C22186B2A5ED793"
}

{
  "responseContext": {
    "requestId": "a762c0a1-2ae7-42b1-a4d8-8d8ba09bdf30",
    "statusCode": 0,
    "statusMessage": "OK"
  },
  "displayCardValue": "458965204578",
  "cardArtsId": "046d8480-c229-49d3-b2b0-cfe135da1da4",
  "productsList": [
    {
      "productId": "6489d6ae-231d-4260-afd6-5fa44ede0d59",
      "productType": "stored-value",
      "displayName": {
        "defaultValue": "Default",
        "translatedValues": [
          {
            "value": "defaut",
            "language": "fr"
          }
        ]
      },
      "displayDetails": {
        "defaultValue": "Default",
        "translatedValues": [
          {
            "value": "defaut",
            "language": "fr"
          }
        ]
      },
      "fare": {
        "fareId": "Fare_abc",
        "fareClass": "first",
        "concession": "full fare",
        "concessionExpiry": "2026-07-11T15:14:50.766Z"
      },
      "lastUpdatedTime": "2026-07-11T15:14:50.766Z",
      "purchaseDetails": {
        "purchaseId": "P20160107_123456",
        "purchaseTime": "2026-07-11T15:14:50.766Z",
        "price": 12.9,
        "currencyCode": "EUR",
        "repurchaseUrl": "https://mytransitoperator/repurchase",
        "refundUrl": "https://mytransitoperator/refund"
      },
      "validityParameters": {
        "numberOfTrips": 10,
        "timeLimits": {
          "startTime": "2026-07-11T15:14:50.766Z",
          "endTime": "2026-07-11T15:14:50.766Z"
        },
        "validityAfterTapIn": {
          "timeUnit": "second",
          "value": 1
        },
        "validityAfterTapOut": {
          "timeUnit": "second",
          "value": 1
        },
        "zoneLimits": {
          "fromZone": {
            "id": "text",
            "displayName": "text"
          },
          "toZone": {
            "id": "text",
            "displayName": "text"
          }
        },
        "stationLimits": {
          "fromStation": {
            "id": "Station_123",
            "displayName": "Marvelous Station"
          },
          "toStation": {
            "id": "Station_123",
            "displayName": "Marvelous Station"
          }
        },
        "topupLimits": {
          "minAmount": 5,
          "maxAmount": 50
        }
      },
      "renewalPeriod": {
        "startTime": "2026-07-11T15:14:50.766Z",
        "relativeStartTime": 1,
        "unavailableBeforeReason": "Too soon",
        "endTime": "2026-07-11T15:14:50.766Z",
        "relativeEndTime": 1,
        "unavailableAfterReason": "Too late"
      },
      "balanceDetails": {
        "amount": 12.9,
        "currencyCode": "EUR"
      },
      "eligibleForTopup": true
    }
  ]
}

Purchase Products

post

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

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

Path parameters

issuerIdstring · max: 10Required

Issuer unique identifier. Assigned by Thales during onboarding.

walletIndicatornumberRequired

Indicates which digital wallet is involved in the use case.

Value	Description
1	Apple
2	Google
3	Samsung

Body

userIdstring · max: 64Optional

User unique identifier

Example: sSHfawfGsHUQjg8zaOHnPPgso5TF

cardAccountIdstring · max: 64Required

Card account unique identifier

Example: FAPLSW8D8AC610566D4EF09C22186B2A5ED793

digitalCardIdstring · max: 64Required

Digital card unique identifier

Example: DGGLSW8D8AC610566D4EF09C22186B2A5ED756

orderIdstring · max: 64Required

Order unique identifier

paymentCredentialsobjectRequired

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

totalAmountnumber · floatRequired

Amount

Example: 12.9

currencyCodestringRequired

The 3-letter currency code defined in ISO 4217

Example: EURPattern: ^[A-Za-z]{3}$

Responses

200Success

application/json

purchaseIdstring · max: 64Optional

Purchase unique identifier

Example: P20160107_123456

500

503

Indicates that the system is unavailable.
The request can be retried.

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

POST /d1/transit/api/v1/issuers/{issuerId}/wallets/{walletIndicator}/purchaseProducts HTTP/1.1
Host: CUSTOMER-PROD
Content-Type: application/json
Accept: */*
Content-Length: 457

{
  "requestContext": {
    "requestId": "493f7686-93a0-494a-a44f-867fcd10ce22",
    "correlationId": "bfd8450f-a605-4427-9714-1d620f14dda1"
  },
  "userId": "sSHfawfGsHUQjg8zaOHnPPgso5TF",
  "cardAccountId": "FAPLSW8D8AC610566D4EF09C22186B2A5ED793",
  "digitalCardId": "DGGLSW8D8AC610566D4EF09C22186B2A5ED756",
  "orderId": "text",
  "purchaseItems": [
    {
      "purchasableProductId": "6489d6ae-231d-4260-afd6-5fa44ede0d59",
      "amount": 12.9
    }
  ],
  "paymentCredentials": {},
  "totalAmount": 12.9,
  "currencyCode": "EUR"
}

{
  "responseContext": {
    "requestId": "a762c0a1-2ae7-42b1-a4d8-8d8ba09bdf30",
    "statusCode": 0,
    "statusMessage": "OK"
  },
  "purchaseId": "P20160107_123456"
}

Get Purchasable Products

post

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

API used for fetching the list of purchasable products.

Path parameters

issuerIdstring · max: 10Required

Issuer unique identifier. Assigned by Thales during onboarding.

walletIndicatornumberRequired

Indicates which digital wallet is involved in the use case.

Value	Description
1	Apple
2	Google
3	Samsung

Body

cardAccountIdstring · max: 64Optional

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 · max: 64Optional

Digital card unique identifier

Example: DGGLSW8D8AC610566D4EF09C22186B2A5ED756

productIdstring · max: 64Optional

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

Example: 6489d6ae-231d-4260-afd6-5fa44ede0d59

digitalCardBundlestringOptional

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

Responses

200Success

application/json

500

503

Indicates that the system is unavailable.
The request can be retried.

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

POST /d1/transit/api/v1/issuers/{issuerId}/wallets/{walletIndicator}/getPurchasableProducts HTTP/1.1
Host: CUSTOMER-PROD
Content-Type: application/json
Accept: */*
Content-Length: 318

{
  "requestContext": {
    "requestId": "493f7686-93a0-494a-a44f-867fcd10ce22",
    "correlationId": "bfd8450f-a605-4427-9714-1d620f14dda1"
  },
  "cardAccountId": "FAPLSW8D8AC610566D4EF09C22186B2A5ED793",
  "digitalCardId": "DGGLSW8D8AC610566D4EF09C22186B2A5ED756",
  "productId": "6489d6ae-231d-4260-afd6-5fa44ede0d59",
  "digitalCardBundle": "text"
}

{
  "responseContext": {
    "requestId": "a762c0a1-2ae7-42b1-a4d8-8d8ba09bdf30",
    "statusCode": 0,
    "statusMessage": "OK"
  },
  "purchasableProducts": [
    {
      "productId": "6489d6ae-231d-4260-afd6-5fa44ede0d59",
      "productType": "stored-value",
      "displayName": {
        "defaultValue": "Default",
        "translatedValues": [
          {
            "value": "defaut",
            "language": "fr"
          }
        ]
      },
      "displayDetails": {
        "defaultValue": "Default",
        "translatedValues": [
          {
            "value": "defaut",
            "language": "fr"
          }
        ]
      },
      "salePeriod": {
        "startDate": "2026-07-11T15:14:50.766Z",
        "endDate": "2026-07-11T15:14:50.766Z"
      },
      "prices": {
        "totalCost": 29.7,
        "currencyCode": "EUR",
        "receiptItems": [
          {
            "costType": "tax",
            "amount": 12.9
          }
        ]
      },
      "fare": {
        "fareId": "Fare_abc",
        "fareClass": "first",
        "concession": "full fare",
        "concessionExpiry": "2026-07-11T15:14:50.766Z"
      },
      "validityParameters": {
        "numberOfTrips": 10,
        "timeLimits": {
          "startTime": "2026-07-11T15:14:50.766Z",
          "endTime": "2026-07-11T15:14:50.766Z"
        },
        "validityAfterTapIn": {
          "timeUnit": "second",
          "value": 1
        },
        "validityAfterTapOut": {
          "timeUnit": "second",
          "value": 1
        },
        "zoneLimits": {
          "fromZone": {
            "id": "text",
            "displayName": "text"
          },
          "toZone": {
            "id": "text",
            "displayName": "text"
          }
        },
        "stationLimits": {
          "fromStation": {
            "id": "Station_123",
            "displayName": "Marvelous Station"
          },
          "toStation": {
            "id": "Station_123",
            "displayName": "Marvelous Station"
          }
        },
        "topupLimits": {
          "minAmount": 5,
          "maxAmount": 50
        }
      },
      "eligibleForTopup": true
    }
  ]
}

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).

Path parameters

issuerIdstring · max: 10Required

Issuer unique identifier. Assigned by Thales during onboarding.

walletIndicatornumberRequired

Indicates which digital wallet is involved in the use case.

Value	Description
1	Apple
2	Google
3	Samsung

Body

cardAccountIdstring · max: 64Required

Card account unique identifier

Example: FAPLSW8D8AC610566D4EF09C22186B2A5ED793

digitalCardIdstring · max: 64Required

Digital card unique identifier

Example: DGGLSW8D8AC610566D4EF09C22186B2A5ED756

tokenDatastringRequired

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 name	description
pan	The token PAN value (up to 19 numeric digits)
expiryMonth	The expiry month of the token in MM format
expiryYear	The expiry year of the token in YYYY format

tokenIdstring · max: 64Optional

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

Example: 63a0c6dd-2993-49f3-b6ac-9721fbe0877e

Responses

200Success

application/json

tokenIdstring · max: 64Optional

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

Example: 63a0c6dd-2993-49f3-b6ac-9721fbe0877e

500

503

Indicates that the system is unavailable.
The request can be retried.

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

POST /d1/transit/api/v1/issuers/{issuerId}/wallets/{walletIndicator}/registerCardAccount HTTP/1.1
Host: CUSTOMER-PROD
Content-Type: application/json
Accept: */*
Content-Length: 308

{
  "requestContext": {
    "requestId": "493f7686-93a0-494a-a44f-867fcd10ce22",
    "correlationId": "bfd8450f-a605-4427-9714-1d620f14dda1"
  },
  "cardAccountId": "FAPLSW8D8AC610566D4EF09C22186B2A5ED793",
  "digitalCardId": "DGGLSW8D8AC610566D4EF09C22186B2A5ED756",
  "tokenData": "text",
  "tokenId": "63a0c6dd-2993-49f3-b6ac-9721fbe0877e"
}

{
  "responseContext": {
    "requestId": "a762c0a1-2ae7-42b1-a4d8-8d8ba09bdf30",
    "statusCode": 0,
    "statusMessage": "OK"
  },
  "tokenId": "63a0c6dd-2993-49f3-b6ac-9721fbe0877e"
}

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.

Path parameters

issuerIdstring · max: 10Required

Issuer unique identifier. Assigned by Thales during onboarding.

walletIndicatornumberRequired

Indicates which digital wallet is involved in the use case.

Value	Description
1	Apple
2	Google
3	Samsung

Body

digitalCardIdstring · max: 64Required

Digital card unique identifier

Example: DGGLSW8D8AC610566D4EF09C22186B2A5ED756

cardAccountIdstring · max: 64Required

Card account unique identifier

Example: FAPLSW8D8AC610566D4EF09C22186B2A5ED793

incompletedExecutionbooleanOptional

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

Responses

200Success

application/json

500

503

Indicates that the system is unavailable.
The request can be retried.

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

POST /d1/transit/api/v1/issuers/{issuerId}/wallets/{walletIndicator}/getDigitalCardBundleCommands HTTP/1.1
Host: CUSTOMER-PROD
Content-Type: application/json
Accept: */*
Content-Length: 311

{
  "requestContext": {
    "requestId": "493f7686-93a0-494a-a44f-867fcd10ce22",
    "correlationId": "bfd8450f-a605-4427-9714-1d620f14dda1"
  },
  "digitalCardId": "DGGLSW8D8AC610566D4EF09C22186B2A5ED756",
  "cardAccountId": "FAPLSW8D8AC610566D4EF09C22186B2A5ED793",
  "responses": [
    {
      "id": "text",
      "value": "text"
    }
  ],
  "incompletedExecution": true
}

{
  "responseContext": {
    "requestId": "a762c0a1-2ae7-42b1-a4d8-8d8ba09bdf30",
    "statusCode": 0,
    "statusMessage": "OK"
  },
  "commands": [
    {
      "id": "text",
      "value": "text"
    }
  ]
}

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.

Path parameters

issuerIdstring · max: 10Required

Issuer unique identifier. Assigned by Thales during onboarding.

walletIndicatornumberRequired

Indicates which digital wallet is involved in the use case.

Value	Description
1	Apple
2	Google
3	Samsung

Body

digitalCardIdstring · max: 64Optional

Digital card unique identifier

Example: DGGLSW8D8AC610566D4EF09C22186B2A5ED756

cardAccountIdstring · max: 64Required

Card account unique identifier

Example: FAPLSW8D8AC610566D4EF09C22186B2A5ED793

lastUpdatedTimestring · date-timeOptional

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

Responses

200Success

application/json

500

503

Indicates that the system is unavailable.
The request can be retried.

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

POST /d1/transit/api/v1/issuers/{issuerId}/wallets/{walletIndicator}/getTransactions HTTP/1.1
Host: CUSTOMER-PROD
Content-Type: application/json
Accept: */*
Content-Length: 285

{
  "requestContext": {
    "requestId": "493f7686-93a0-494a-a44f-867fcd10ce22",
    "correlationId": "bfd8450f-a605-4427-9714-1d620f14dda1"
  },
  "digitalCardId": "DGGLSW8D8AC610566D4EF09C22186B2A5ED756",
  "cardAccountId": "FAPLSW8D8AC610566D4EF09C22186B2A5ED793",
  "lastUpdatedTime": "2026-07-11T15:14:50.766Z"
}

{
  "responseContext": {
    "requestId": "a762c0a1-2ae7-42b1-a4d8-8d8ba09bdf30",
    "statusCode": 0,
    "statusMessage": "OK"
  },
  "transactions": [
    {
      "transactionId": "9272c57d-e911-460b-9be8-6ceb6f21fcf7",
      "transactionDateTime": "2026-07-11T15:14:50.766Z",
      "transactionStatus": "pending",
      "transactionType": "purchase",
      "merchantName": "My Transit Operator",
      "rawMerchantName": "MY_TRANSIT_OPER",
      "zipCode": "15899",
      "countryCode": "FR",
      "city": "Nice",
      "address": "Welcome street, 125",
      "totalAmount": 12.9,
      "currencyCode": "EUR",
      "productId": "6489d6ae-231d-4260-afd6-5fa44ede0d59",
      "localizedTitle": {
        "defaultValue": "Default",
        "translatedValues": [
          {
            "value": "defaut",
            "language": "fr"
          }
        ]
      },
      "localizedDescription": {
        "defaultValue": "Default",
        "translatedValues": [
          {
            "value": "defaut",
            "language": "fr"
          }
        ]
      },
      "rideDetails": [
        {
          "eventDateTime": "2026-07-11T15:14:50.766Z",
          "transitType": "bus",
          "eventType": "tap",
          "station": {
            "id": "Station_123",
            "displayName": "Marvelous Station"
          },
          "discounts": [
            "route"
          ],
          "amount": 12.9,
          "originalAmount": 12.9,
          "incompleteJourneyStatus": "resolved"
        }
      ]
    }
  ]
}

Get Messages

post

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

API used to fetch messages from the Transit Issuer.

Path parameters

issuerIdstring · max: 10Required

Issuer unique identifier. Assigned by Thales during onboarding.

walletIndicatornumberRequired

Indicates which digital wallet is involved in the use case.

Value	Description
1	Apple
2	Google
3	Samsung

Body

digitalCardIdstring · max: 64Optional

Digital card unique identifier

Example: DGGLSW8D8AC610566D4EF09C22186B2A5ED756

cardAccountIdstring · max: 64Required

Card account unique identifier

Example: FAPLSW8D8AC610566D4EF09C22186B2A5ED793

lastUpdatedTimestring · date-timeOptional

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

Responses

200Success

application/json

500

503

Indicates that the system is unavailable.
The request can be retried.

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

POST /d1/transit/api/v1/issuers/{issuerId}/wallets/{walletIndicator}/getMessages HTTP/1.1
Host: CUSTOMER-PROD
Content-Type: application/json
Accept: */*
Content-Length: 285

{
  "requestContext": {
    "requestId": "493f7686-93a0-494a-a44f-867fcd10ce22",
    "correlationId": "bfd8450f-a605-4427-9714-1d620f14dda1"
  },
  "digitalCardId": "DGGLSW8D8AC610566D4EF09C22186B2A5ED756",
  "cardAccountId": "FAPLSW8D8AC610566D4EF09C22186B2A5ED793",
  "lastUpdatedTime": "2026-07-11T15:14:50.766Z"
}

{
  "responseContext": {
    "requestId": "a762c0a1-2ae7-42b1-a4d8-8d8ba09bdf30",
    "statusCode": 0,
    "statusMessage": "OK"
  },
  "messages": [
    {
      "messageId": "text",
      "startDateTime": "2026-07-11T15:14:50.766Z",
      "endDateTime": "2026-07-11T15:14:50.766Z",
      "messageType": "alert",
      "localizedHeader": {
        "defaultValue": "Default",
        "translatedValues": [
          {
            "value": "defaut",
            "language": "fr"
          }
        ]
      },
      "localizedMessage": {
        "defaultValue": "Default",
        "translatedValues": [
          {
            "value": "defaut",
            "language": "fr"
          }
        ]
      },
      "navigationTarget": "text"
    }
  ]
}

PreviousOutbound API (from D1 Transit)NextSet up TLS mutual authentication

Last updated 4 months ago

Was this helpful?