Skip to main content
POST

Authorizations

Authorization
string
header
required

API token authentication using format <api token id>:<api client secret>

Path Parameters

id
string
required

System-generated unique card identifier

Body

application/json

Fields shared by every web add-to-wallet request. Send them from your backend when the wallet provider's web button asks for the card.

wallet
enum<string>
required

Discriminator value identifying an Apple Pay request. Apple's web button needs nothing else from the page.

Available options:
APPLE_PAY
Example:

"APPLE_PAY"

Response

Provisioning payload minted.

Fields shared by every web add-to-wallet response. The payload is encrypted to the wallet provider's keys and signed for its web script: hand it to the script unchanged. It is valid for one attempt; do not store or log it.

wallet
enum<string>
required

Discriminator value identifying an Apple Pay response.

Available options:
APPLE_PAY
Example:

"APPLE_PAY"

applePay
object
required

What Apple's web script needs to add the card to Apple Wallet.