Skip to main content
POST
Prepare a wallet one-click purchase

Path Parameters

org_id
string
required

Organization ID

Body

application/json
external_id
string
required

Your unique identifier for the user

Maximum string length: 256
pp_ident
string
required

Unique identifier of the price point

Maximum string length: 256
Pattern: ^[-A-Za-z_0-9]{1,256}$
client_metadata
Client Metadata · object

Custom metadata from your client application

Response

200 - application/json

Wallet session

wallet
enum<string> | null
required

The wallet to show the button for. null means no wallet confirmation for this customer and price point: use a regular one-click purchase.

Available options:
APPLE_PAY,
GOOGLE_PAY
reason
enum<string> | null

Why wallet is null.

Available options:
no_previous_order,
not_primer,
not_wallet,
unsupported_price_point
client_token
string | null

Primer client token for the wallet button.

session_id
string<uuid> | null

Send it with the wallet's token to POST /checkout/one_click.

order_id
string<uuid> | null

The ID the order gets when the customer pays.

amount
integer | null

Amount in minor units shown in the wallet sheet and charged, tax included when collected.

currency
string | null

Currency code in lower case (ISO 4217).

expires_at
string<date-time> | null

When the session expires (UTC). Call this endpoint again after it.