Skip to main content
GET
What this key may use

Authorizations

Authorization
string
header
required

Your API key, issued by us and shown once at creation.

Response

What this key may use, by product.

What this key may use and how each product is configured here: the key's products and ceiling, then one section per product - crypto (the catalogue narrowed to the key), card, bank, virtualAccounts. A product section is present only when that vertical is configured on this deployment; presence says nothing about the key's permission (read products for that).

environment
enum<string>
required

Which environment answered. sandbox: at least one money upstream is the provider's sandbox - no real money moves there, and the card corridor is the sandbox's asset (read GET /v1/config), not the documented production one. production: every configured upstream is real. Derived from the configured upstream hosts at boot, never a flag.

Available options:
sandbox,
production
Example:

"sandbox"

products
enum<string>[]
required

The products THIS key may call, exactly as granted: deposits (the crypto product), cards, bank, virtual-accounts. A product not listed answers 403 permission_denied on its endpoints. Keys issued before per-product permissions carry deposits only.

Available options:
deposits,
cards,
bank,
virtual-accounts
Example:
maxExecutionUsd
integer | null
required

This key's execution ceiling: the largest transfer it may BUILD, in USD (the catalogue is USD-pegged stablecoins). null means no ceiling. Quoting is never capped; over it, /v1/deposit/transaction answers 403 execution_capped.

Required range: 0 < x <= 9007199254740991
Example:

null

crypto
object
required

The crypto deposit product: the catalogue narrowed to the calling key.

card
object

The configured card corridor. Absent when this deployment has no card vertical configured (the /v1/card/* lookups answer 503 not_configured there).

bank
object

The configured bank corridor. Absent when this deployment has no bank vertical configured.

virtualAccounts
object

The virtual-account product. Absent when this deployment has no bank vertical configured (virtual accounts open on the bank corridor).