Add the agent's card to a digital wallet
Exchange the values an app on the cardholder’s phone received from Apple Pay, Google Pay or Samsung Pay for the encrypted payload that adds one of the agent’s STANDARD cards to that wallet (in-app push provisioning). The request and response are the same as POST /cards/{id}/tokenize. The payload is encrypted to the wallet provider’s keys; hand it straight to the wallet SDK and never store or log it.
Confirm with the cardholder before calling: a wallet token spends like the card. Every call is audit-logged with the agent as the actor, and calls are rate limited per agent and per card. Requires the MANAGE_CARDS permission.
Authorizations
Bearer token authentication for agent-scoped endpoints. The token is the accessToken returned when redeeming a device code via POST /agents/device-codes/redeem. Agent credentials are user-scoped: all requests are automatically bound to the agent's associated customer and subject to the agent's policy.
Path Parameters
Unique identifier of the card
Body
- Apple Pay Tokenization Request
- Google Pay Tokenization Request
- Samsung Pay Tokenization Request
Fields shared by every add-to-wallet request. The wallet SDK hands your app a set of values when the cardholder taps "Add to Wallet"; pass them here unchanged in the request shape for that wallet.
Discriminator value identifying an Apple Pay request.
APPLE_PAY "APPLE_PAY"
The leaf certificate from the certificates array Apple passes to your PKAddPaymentPassViewControllerDelegate, base64-encoded in PEM form.
"LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSUM="
The nonce Apple passes to your delegate, base64-encoded.
"MTIzNDU2Nzg="
The nonceSignature Apple passes to your delegate, base64-encoded.
"c2lnbmF0dXJl"
Response
Provisioning payload minted.
- Apple Pay Tokenization Response
- Google Pay Tokenization Response
- Samsung Pay Tokenization Response
Fields shared by every add-to-wallet response. The payload is encrypted to the wallet provider's keys: neither your app nor your servers can read the card data inside it. Hand it to the wallet SDK; it is valid for a single provisioning attempt.
Discriminator value identifying an Apple Pay response.
APPLE_PAY "APPLE_PAY"
The encrypted pass data for Apple Wallet. Pass the three fields straight into the PKAddPaymentPassRequest your delegate's completion handler expects.