Skip to main content
POST
Start a card top-up (Stripe Elements)
Nothing is charged here: the payment happens when Stripe.js confirms it on your page. See Transparent checkout.

Authorizations

x-api-key
string
header
required

Your ps_ API key

Headers

Idempotency-Key
string

Optional. Up to 255 characters, no control characters.

Maximum string length: 255
x-workspace-id
string

Only with an account key (ps_account_): the workspace to act on, from GET /v1/workspaces. Without it an account key gets 400 WORKSPACE_ID_REQUIRED.

Body

application/json
purpose
enum<string>
required

Only wallet_topup today.

Available options:
wallet_topup
Example:

"wallet_topup"

amount
number
required

Positive, in the workspace's currency.

Example:

150

saveCard
boolean

Also save the card as the workspace's card. Default false.

Example:

true

Response

The intent