Checkout/getCnpWalletReadiness
Wallet Readiness & Attempts
Check wallet capability and durably record Apple Pay / Google Pay attempts.
POST
/api/v1/cnp/public/checkout-sessions/{id}/wallet-readinessBrowser-safeCall from the customer’s browser with a publishable key — never your secret key.
The Drop-in and standalone wallet button Elements use these browser endpoints to check merchant wallet capability and record wallet payment attempts. Current builds persist a hash of the opaque wallet token payload and return UNSUPPORTED until live wallet authorization adapters are configured.
Path parameters
idstringRequiredCheckout session ID.
Request body
application/json
clientSecretstringRequiredCheckout session client secret.
walletTypeenumRequiredWallet type.
APPLE_PAYGOOGLE_PAYtokenobjectOpaque wallet token payload for wallet-payment-attempts. Stored as a hash plus safe metadata.
metadataobjectSafe browser/SDK metadata.
Response
application/json
walletTypeenumAPPLE_PAY or GOOGLE_PAY.
APPLE_PAYGOOGLE_PAYreadybooleanWhether the wallet is enabled for this merchant.
statusenumWallet attempt status when recording an attempt.
RECEIVEDUNSUPPORTEDFAILEDAUTHORIZEDfailureReasonstringReason wallet payment could not proceed.
configobjectMerchant wallet configuration returned by readiness.
cnpGatewayRouteIdstringSelected CNP credential route for wallet confirmation.
cnpGatewayRouteSupportsKepaTokenStoragebooleanWhether the selected route can produce portable Kepa-owned reusable credentials.
Good to know
- Apple Pay merchant validation endpoint: /api/v1/cnp/public/checkout-sessions/{id}/apple-pay/merchant-session.
- Wallet attempt endpoint: /api/v1/cnp/public/checkout-sessions/{id}/wallet-payment-attempts.
- Wallet confirm endpoint: /api/v1/cnp/public/checkout-sessions/{id}/wallet-confirm.
- If the payment intent has setupFutureUsage and the wallet authorizer returns a Kepa-owned reusable credential, wallet-confirm returns a merchant-owned paymentMethodId.
- Wallet confirm now resolves a CNP gateway route before authorization. If no route supports the wallet flow, or a saved-wallet flow selects a provider-bound route, confirmation fails closed and the attempt is marked UNSUPPORTED.
- Operator route-control endpoints: /v1/cnp/gateway-routes, /v1/cnp/gateway-routes/preview, and /v1/cnp/gateway-routes/{id}/disable.
- CNP gateway routes are separate from acquirer routes: they select credential-processing paths before durable acquirer authorization dispatch.
- Apple domain association file: /.well-known/apple-developer-merchantid-domain-association.
- Live Apple Pay still requires merchant validation credentials and domain association.
- Live Google Pay still requires gateway configuration and acquirer support for wallet tokens.
getCnpWalletReadiness