Skip to main content
POST
payments.account.status

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

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

No fields. The account is your connected payments account.

Response

The result

status
enum<string>
required

"ready": can take charges and receive payouts. "pending": identity checks are running or details are still due. "restricted": blocked until the details due are given, or refused.

Available options:
ready,
pending,
restricted
chargesEnabled
boolean
required

True when the account can take charges.

payoutsEnabled
boolean
required

True when the account can receive payouts.

detailsSubmitted
boolean
required

True when all onboarding details were submitted.

requirementsDue
string[]
required

Information still needed before the account is fully enabled, e.g. "external_account".