v1

latestOpenAPI 3.0.32026-07-264414182.7 KB
Financial Account

Create Financial Account

Creates a new financial account for holding or managing funds within a Space.

post/v1/financial-accounts

Headers

Idempotency-Keystring required

This header is used to uniquely identify a logical request, ensuring that it is not processed more than once during retries.

This header is used to uniquely identify a logical request, ensuring that it is not processed more than once during retries.

Monime-Version'caph.2025-08-23' | 'caph.2025-06-20' nullable

Specifies which version of the Monime API will handle this request.

Specifies which version of the Monime API will handle this request.

Monime-Space-Idstring required

The value is the tenancy parameter that Monime uses to determine which space the request is intended for.

The value is the tenancy parameter that Monime uses to determine which space the request is intended for.

Request body

namestring required

Label for the financial account, e.g., 'Main Wallet' or 'Reserved Account'.

currencystring required

ISO 4217 currency code (e.g., 'SLE', 'USD') indicating the account's currency.

referencestring nullable

Optional external reference ID for this account. Must be unique across financial accounts in the same Space.

descriptionstring nullable

Optional note about the account’s usage or purpose.

metadataobject nullable

Updated metadata for storing additional context about the account.

Response

OK

successboolean

Represents the status of the query operation, confirming if it was successful. This field is always true