Skip to main content
POST
payments.account.connect

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-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$
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
returnUrl
string
required

For older hosted onboarding, URL the user is sent to when finished; ignored for embedded onboarding. Accepts a public URL, or http on localhost for a local install.

refreshUrl
string
required

For older hosted onboarding, URL the user is sent to when the link expired or was already used; ignored for embedded onboarding. Call again from there. Accepts a public URL, or http on localhost for a local install.

country
string

Two-letter country code of the business, e.g. "US". Used when the account is first created; a project has one account, so a different country from its existing account's is refused.

Pattern: ^[a-zA-Z]{2}$

Response

The result

onboardingUrl
string

Hosted onboarding page to open, when returned. For embedded onboarding, call nextCapability instead.

onboardingMode
string

Use embedded account components in your app instead of a hosted link.

Allowed value: "embedded"
nextCapability
string

Call this superpower next to open embedded onboarding.

Allowed value: "payments.account.session.create"
expiresAt
string

When the link stops working, ISO 8601, when known.