Skip to main content
POST
payments.account.session.create

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Account
string

Optional. One of your account ids (GET /v1/accounts): run on that account, whatever your routing rules say. The response header X-Pramaan-Account names the account that ran.

Pramaan-End-User
string

Optional. Your own tag for your end user: a sticky: end_user rule keeps them on the account that first served them.

Maximum string length: 256
Pramaan-End-User-Group
string

Optional. Your end user's group, matched by rules with endUserGroup.

Maximum string length: 64

Body

application/json
components
enum<string>[]

Components to enable. Account onboarding, account management and the notification banner are always included, even when omitted here.

Maximum array length: 7

An embedded account component.

Available options:
account_onboarding,
account_management,
notification_banner,
payouts,
payments,
balances,
documents

Response

The result

clientSecret
string
required

Short-lived credential returned once to your server. Pass only to the account owner's browser; never log or store it.

Required string length: 1 - 4096
Pattern: ^[A-Za-z0-9_-]+$
publishableKey
string
required

Public key to load the embedded components with in the browser, alongside clientSecret. Safe to show.

Pattern: ^pk_(test|live)_[A-Za-z0-9]{1,255}$
expiresAt
string<date-time>
required

When the session expires, in ISO 8601 UTC.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
components
enum<string>[]
required

Embedded components enabled for this session.

Maximum array length: 7

An embedded account component.

Available options:
account_onboarding,
account_management,
notification_banner,
payouts,
payments,
balances,
documents