HomeAPI ReferenceVaultsGet Vault Details
GET/vaults/details

Get Vault Details

Outcome - Returns the vault your API key belongs to: name, type, category (CRYPTO or FIAT), allowed origins, webhook and fiat currency.

Responses

Response attributes

messagestring

Success message

dataobject

Vault details

Show child attributes (10)
idnumber

Vault ID

namestring

Vault name

photostring | null

URL of the vault image

vaultTypestring

api_segregated, api_consolidated, internal, escrow, payment, fiat_segregated or fiat_payment

categorystring

CRYPTO or FIAT

allowedOriginsstring[] | null

Browser origins allowed to call the API with this vault's credentials

webhookIdnumber | null

ID of the vault's webhook configuration, used by Create/Update Webhook Events

fiatCurrencyDetailsobject

Currency used to show fiat values: id, name, symbol, pricingId

createdAtstring

Creation date

updatedAtstring

Last update date

statusnumber

HTTP status code

Was this page helpful?