Skip to main content
GET
JavaScript

Authorizations

Authorization
string
header
required

Bearer token for authentication with Augustus Banking API

Response

200 - application/json

The authenticated API key

type
enum<string>
required

Resource type discriminator.

Available options:
api_key
id
string
required

Unique identifier of the API key.

merchant_id
string
required

Identifier of the merchant the key belongs to.

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,
webhook_subscriptions:read,
webhook_subscriptions:write,
events:read,
webhook_deliveries:read,
webhook_deliveries:write,
transactions: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.

expires_at
string<date-time> | null
required

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

created_at
string<date-time>
required

ISO 8601 UTC timestamp at which this key was created.

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.

api_version
string
required

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