Create an Apple digital wallet token beta

Creates a digital wallet token that can be added to an Apple wallet. This token represents a specific card, wallet, and device token. The card's data is encrypted using Apple’s own encryption key, meaning your PCI compliance overhead is reduced.

After your request is successfully processed, you'll receive a DigitalWalletTokenTransition webhook containing the digital wallet token. You'll also be able to retrieve it using the List digital wallet tokens endpoint.

SecurityCommonAuth
Request
path Parameters
cardId
required
string <uuid> <= 36 characters

The ID of the card to work with.

Example: e9293471-5eb3-4dbc-916c-dbaf9e2deefd
query Parameters
accountId
required
string

The ID of the account to work with.

Example: accountId=F50091
personId
string <uuid> <= 36 characters

The ID of the person to work with.

Example: personId=775596ae-2624-40af-a9dc-9756110a4a04
Request Body schema: application/json

Body

deviceType
required
string

The type of device into which the digital wallet token is provisioned.

Enum: "MOBILE_PHONE" "TABLET" "WATCH"
provisioningAppVersion
required
string <= 50 characters

The version of the application making the provisioning request. This is used for debugging and fraud prevention.

certificates
required
Array of strings

The Base64-encoded leaf and sub-CA certificates provided by Apple. The first element of the array should be the leaf certificate, followed by the sub-CA.

nonce
required
string

The single-use nonce provided by Apple for security purposes.

nonceSignature
required
string

The signature to the nonce provided by Apple.

Responses
201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

405

Method Not Allowed

415

Unsupported Media Type

429

Too Many Requests

500

Internal Server Error

post/cards/{cardId}/apple-wallet
Request samples
application/json
{
  • "deviceType": "WATCH",
  • "provisioningAppVersion": "2.11.1",
  • "certificates": "['MIIEPDCCA+KgAwIBAgICEAAwCQYHKoZIzj', 'MIIDZjCCAw2gAwIBAgIJAJx22AGaEPSgMA']",
  • "nonce": "vXWJaBidcTLaJJCF",
  • "nonceSignature": "jD4Aphu+93N2wbBn"
}
Response samples
application/json
{
  • "deviceType": "WATCH",
  • "provisioningAppVersion": "2.11.1",
  • "certificates": "['MIIEPDCCA+KgAwIBAgICEAAwCQYHKoZIzj', 'MIIDZjCCAw2gAwIBAgIJAJx22AGaEPSgMA']",
  • "nonce": "vXWJaBidcTLaJJCF",
  • "nonceSignature": "jD4Aphu+93N2wbBn",
  • "encryptedPassData": "w9NGKYa3OkPGeQ+FmAKGga",
  • "activationData": "TUJQQUMtMS1GSy03NDgwNTIuMS0tVERF",
  • "ephemeralPublicKey": "BMop3NufgKwy/r0GX1muvomvw"
}