Sign in

v3

latestOpenAPI 3.0.3Apache 2.02026-07-312637031.3 MB
Digital Wallet Tokens

Create digital wallet token provision request for Apple Pay

post/cards/{card_id}/digital_wallet_tokens/applepay

Path parameters

card_idstring uuid required

The unique identifier of a card

Example:7d943c51-e4ff-4e57-9558-08cab6b963c7

Headers

Idempotency-Keystring
Example:7d943c51-e4ff-4e57-9558-08cab6b963c7

An idempotency key is an arbitrary unique value generated by client to detect subsequent retries of the same request. It is recommended that a UUID or a similar random identifier be used as an idempotency key. A different key must be used for each request, unless it is a retry.

Request body

certificatesstring[] required

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.

device_type'MOBILE_PHONE' | 'TABLET' | 'WATCH' required

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

noncestring required

One-time-use nonce provided by Apple for security purposes.

nonce_signaturestring required

Apple-provided signature to the nonce.

provisioning_app_versionstring required

Version of the application making the provisioning request.

Response

Digital wallet token provision request data

activation_datastring
card_idstring uuid

The unique identifier of a card

created_timestring date-time
encrypted_pass_datastring
ephemeral_public_keystring
last_modified_timestring date-time

Example response

{
  "card_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "created_time": "2010-05-06T12:23:34.321Z",
  "last_modified_time": "2010-05-06T12:23:34.321Z"
}