Add a card to a digital wallet
Exchange the values your app received from Apple Pay, Google Pay, or Samsung Pay for the encrypted provisioning payload that completes adding the card to that wallet (in-app push provisioning). Call it from your backend inside the wallet SDK’s credentials callback and hand the response straight back to the SDK.
The payload is encrypted to the wallet provider’s keys, so neither your app nor your servers ever see card data. Do not store or log it; it is valid for one provisioning attempt.
Cardholders can always add a card to a wallet by typing its details in manually — that path needs nothing from you. This endpoint is for the in-app “Add to Wallet” button, which additionally requires approval from each wallet provider. See Digital wallet tokenization.
Only ACTIVE cards can be added. Every call is audit-logged with the requesting actor and the target wallet.
Authorizations
API token authentication using format <api token id>:<api client secret>
Path Parameters
System-generated unique card identifier
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.