Skip to main content
POST
Freeze account

Authorizations

Authorization
string
header
required

Bearer token for authentication with Augustus Banking API

Headers

Idempotency-Key
string
required

Idempotency key for safe retries. Reusing a key with an identical request body returns the cached response. Reusing a key with a different body returns 409.

Path Parameters

id
string<uuid>
required

Unique identifier of the account.

Example:

"550e8400-e29b-41d4-a716-446655440001"

Response

200 - application/json

Account frozen successfully

id
string
required

Unique identifier of the account.

Example:

"550e8400-e29b-41d4-a716-446655440001"

type
enum<string>
required

Resource type discriminator.

Available options:
account
currency
enum<string>
required

Currency code (ISO 4217 or crypto).

Available options:
EUR,
GBP,
USD,
USDC
Example:

"EUR"

status
enum<string>
required

Current status of the account.

Available options:
pending,
active,
frozen,
closed
Example:

"active"

asset_type
enum<string>
required

Asset type of the account.

Available options:
fiat,
crypto
label
string
required

Human-readable label for the account.

Example:

"Operating EUR account"

financial_addresses
(IBAN · object | UK Sort Code · object | ABA · object | BIC · object | Wallet · object)[]
required

Payment identifiers (e.g. IBAN, account number, wallet address) through which this account can send or receive funds.

Example:
created_at
string<date-time>
required

ISO 8601 UTC timestamp when the account was created.

Example:

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

updated_at
string<date-time>
required

ISO 8601 UTC timestamp when the account was last updated.

Example:

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

metadata
object
required

Set of up to 50 key-value string pairs you can attach to store structured information, such as correlating this resource with an object in your own system. Keys may be up to 40 characters and values up to 500 characters.

Example: