Skip to main content
POST
Create an API key

Authorizations

X-API-Key
string
header
required

Body

application/json
name
string
required
Required string length: 1 - 80
mode
enum<string>
required
Available options:
test,
live
scopes
enum<string>[]
Maximum array length: 32
Available options:
payment_intents:write,
payment_intents:read,
invoices:write,
invoices:read,
webhooks:write,
webhooks:read,
api_keys:write,
connected_accounts:write,
connected_accounts:read,
buyer_kyc:write,
buyer_kyc:read

Response

API key created — secret carries the full key pk_<mode>_<id>.<secret> and is returned this one time only.

id
string
required
orgId
string
required
name
string
required
keyPrefix
string
required
testMode
boolean
required
scopes
string[]
required
lastUsedAt
string | null
required
revokedAt
string | null
required
createdAt
string
required
secret
string
required