Provisioning and Management API

Download OpenAPI specification

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

Prepare Push Provisioning Bundle

post

https://THALES-PROD/d1/transit/api/v1https://THALES-STG/d1/transit/api/v1

/issuers/{issuerId}/wallets/{walletIndicator}/preparePushProvisioningBundle

API used for requesting D1 Transit to prepare a push provisioning bundle that is going to be provided by Transit Issuer mobile app to Digital Wallet SDK eventually. This request can be used in 3 different cases: 1) initial provisioning: in such case, Transit Issuer shall neither provide cardAccountId nor digitalCardId. D1 Transit will create and return these identifiers in the response. 2) retry failed provisioning: in case of provisioning failure, Transit Issuer may retry the provisioning, assuming there was no refund/cancellation of customer card account. In such case, both cardAccountId and digitalCardId shall be provided. 3) restoring an existing cardAccount: in such case, Transit Issuer shall provide cardAccountId only. D1 Transit will assign new digitalCardId and return it along with cardAccountId in the response.

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

application/json

cardAccountIdstring · max: 64Optional

Card account unique identifier

Example: FAPLSW8D8AC610566D4EF09C22186B2A5ED793

digitalCardIdstring · max: 64Optional

Digital card unique identifier

Example: DGGLSW8D8AC610566D4EF09C22186B2A5ED756

pushDetailsone ofRequired

pushDetails shall be consistent with the 'wallet indicator' parameter.
I.e. ApplePushDetails shall be provided when 'wallet indicator' = 1, GooglePushDetails shall be provided when 'wallet indicator' = 2

or

Responses

200Success

application/json

cardAccountIdstring · max: 64Optional

Unique identifier of an account.
Not provided in case of error.

Example: FAPLSW8D8AC610566D4EF09C22186B2A5ED793

digitalCardIdstring · max: 64Optional

Unique identifier of a digital card.
Not provided in case of error.

Example: DGGLSW8D8AC610566D4EF09C22186B2A5ED756

pushProvisioningBundlestringOptional

Bundle generated as per Digital Wallet format specified in the request.
It shall be used by the transit issuer app to trigger the provisioning.

Apple format

This is the string representation of JSON object defined as below:

Parameter name	Type	Description
activationData	string	See https://developer.apple.com/documentation/passkit/pkaddpaymentpassrequest/activationdata
encryptedPassData	string	See https://developer.apple.com/documentation/passkit/pkaddpaymentpassrequest/encryptedpassdata
ephemeralPublicKey	string	See https://developer.apple.com/documentation/passkit/pkaddpaymentpassrequest/ephemeralpublickey

Google format

This is the OpaquePaymentCard (OPC) as described in https://developers.google.com/pay/issuers/apis/push-provisioning/android/wallet-operations

Not provided in case of error.

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}/preparePushProvisioningBundle

HTTPcURLJavaScriptPython

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

{
  "requestContext": {
    "requestId": "493f7686-93a0-494a-a44f-867fcd10ce22",
    "correlationId": "bfd8450f-a605-4427-9714-1d620f14dda1"
  },
  "cardAccountId": "FAPLSW8D8AC610566D4EF09C22186B2A5ED793",
  "digitalCardId": "DGGLSW8D8AC610566D4EF09C22186B2A5ED756",
  "pushDetails": {
    "certificates": [
      "text"
    ],
    "nonce": "text",
    "nonceSignature": "text"
  }
}

{
  "responseContext": {
    "requestId": "a762c0a1-2ae7-42b1-a4d8-8d8ba09bdf30",
    "statusCode": 0,
    "statusMessage": "OK"
  },
  "cardAccountId": "FAPLSW8D8AC610566D4EF09C22186B2A5ED793",
  "digitalCardId": "DGGLSW8D8AC610566D4EF09C22186B2A5ED756",
  "pushProvisioningBundle": "text"
}

Cancel Card Account

post

https://THALES-PROD/d1/transit/api/v1https://THALES-STG/d1/transit/api/v1

/issuers/{issuerId}/wallets/{walletIndicator}/cancelCardAccount

API used for cancelling a card account. Card Account will be removed from Digital Wallet systems as well.

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

application/json

cardAccountIdstring · max: 64Required

Card account unique identifier

Example: FAPLSW8D8AC610566D4EF09C22186B2A5ED793

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}/cancelCardAccount

HTTPcURLJavaScriptPython

POST /d1/transit/api/v1/issuers/{issuerId}/wallets/{walletIndicator}/cancelCardAccount HTTP/1.1
Host: THALES-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"
  }
}

Get Card Account Info

post

https://THALES-PROD/d1/transit/api/v1https://THALES-STG/d1/transit/api/v1

/issuers/{issuerId}/wallets/{walletIndicator}/getCardAccountInfo

API used for getting card account information.

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

application/json

cardAccountIdstring · max: 64Required

Card account unique identifier

Example: FAPLSW8D8AC610566D4EF09C22186B2A5ED793

Responses

200Success

application/json

cardAccountStatestring · enumOptional

Card account state

Possible values:

userIdstring · max: 64Optional

User unique identifier

Example: sSHfawfGsHUQjg8zaOHnPPgso5TF

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}/getCardAccountInfo

HTTPcURLJavaScriptPython

POST /d1/transit/api/v1/issuers/{issuerId}/wallets/{walletIndicator}/getCardAccountInfo HTTP/1.1
Host: THALES-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"
  },
  "cardAccountState": "active",
  "userId": "sSHfawfGsHUQjg8zaOHnPPgso5TF",
  "digitalCards": [
    {
      "digitalCardId": "DGGLSW8D8AC610566D4EF09C22186B2A5ED756",
      "digitalCardState": "created",
      "walletId": "9i+KsSHjySa7Nxyzpvp6V/mL/fhwwZ7H/NEE9XCGjO6zzKiNnimDDAVHxOFa0jKF",
      "deviceType": 1,
      "csn": "text"
    }
  ]
}

Manage Digital Card

post

https://THALES-PROD/d1/transit/api/v1https://THALES-STG/d1/transit/api/v1

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

API used for managing the state of a digital card 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

application/json

digitalCardIdstring · max: 64Required

Digital card unique identifier

Example: DGGLSW8D8AC610566D4EF09C22186B2A5ED756

cardAccountIdstring · max: 64Required

Card account unique identifier

Example: FAPLSW8D8AC610566D4EF09C22186B2A5ED793

actionstring · enumRequiredPossible values:

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}/manageDigitalCard

HTTPcURLJavaScriptPython

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

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

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