Skip to main content
​
type
enum<string>
required

Resource type discriminator.

Available options:
api_key
​
id
string
required

Unique identifier of the API key.

Example:

"550e8400-e29b-41d4-a716-44665544000e"

​
merchant_id
string
required

Identifier of the merchant the key belongs to.

Example:

"68e0a1b2c3d4e5f607182940"

​
scopes
enum<string>[]
required

The effective set of scopes for this key. Stored aliases (e.g. full_access, read_only) are always expanded to concrete resource:action scopes against the current registry before they appear here.

Available options:
payouts:read,
payouts:write,
deposits:read,
returns:read,
returns:write,
conversions:read,
conversions:write,
quotes:read,
accounts:read,
accounts:write,
account_programs:read,
account_holders:read,
account_holders:write,
counterparties:read,
counterparties:write,
webhook_subscriptions:read,
webhook_subscriptions:write,
events:read,
webhook_deliveries:read,
webhook_deliveries:write,
transactions:read,
simulations:write,
payout_tracking_events:read
​
ip_allow_list
string[]
required

IP addresses or CIDR ranges this key is permitted to authenticate from. An empty array means the key is not IP-restricted.

Example:
​
expires_at
string<date-time> | null
required

ISO 8601 UTC timestamp at which this key expires. null if the key has no expiry.

Example:

"2027-01-15T10:30:00Z"

​
created_at
string<date-time>
required

ISO 8601 UTC timestamp at which this key was created.

Example:

"2026-01-15T10:30:00Z"

​
updated_at
string<date-time> | null
required

ISO 8601 UTC timestamp of the last update to this key (e.g. roll, IP allowlist change, revoke). null if the key has not been updated since creation.

Example:

"2026-01-15T10:35:00Z"

​
api_version
string
required

Effective API version for the request (header value or merchant pin).

Example:

"2026-05-01"