Skip to main content
Create an Asset
curl --request POST \
  --url http://127.0.0.1:3000/v1/organizations/{organization_id}/ledgers/{ledger_id}/assets \
  --header 'Content-Type: <content-type>' \
  --data '{
  "name": "Brazilian Real",
  "type": "currency",
  "code": "BRL",
  "status": {
    "code": "ACTIVE",
    "description": "Primary fiat asset used for domestic settlement and customer balances"
  },
  "metadata": {
    "symbol": "R$",
    "country": "Brazil",
    "isoNumeric": "986",
    "supportsFractions": true,
    "decimalPlaces": 2,
    "category": "fiat",
    "environment": "production",
    "createdBy": "system",
    "notes": "Standard BRL currency asset for retail banking and Pix operations"
  }
}'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "ledgerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "type": "currency",
  "code": "<string>",
  "status": {
    "status": {
      "description": "<string>",
      "code": "<string>"
    }
  },
  "metadata": {},
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "deletedAt": "2023-11-07T05:31:56Z"
}
When you create an Asset, Midaz automatically sets up an External Account if one doesn’t already exist.This ensures seamless backing for all transactions flowing in and out of the Ledger.

Headers

​
Authorization
string

The authorization token. This header is required if your environment has the Access Manager enabled.

​
Content-Type
string
required

The type of media of the resource. Must be application/json.

​
X-Request-Id
string

A unique identifier used to trace and track each request.

Path Parameters

​
organization_id
string
required

The unique identifier of the Organization associated with the Ledger.

​
ledger_id
string
required

The unique identifier of the associated Ledger.

Body

application/json
​
name
string
required

The name of the Asset, which must be <b>unique</b>.

Maximum length: 256
​
type
enum<string>
required

The type of Asset.

Available options:
currency,
crypto,
commodity,
others
​
code
string
required

The code used to refer to the Asset, according to its type. <b>Important:</b> It's not possible to create assets with the same type and code. Also, if the Asset is a currency (type = currency), the code must follow the ISO 4217 values.

​
status
object

An object containing information about the status. Important: If not provided, the default status will be 'ACTIVE'.

​
metadata
object

An object containing key-value pairs to add as metadata, where the field name is the key and the field value is the value. For example, to add a Cost Center, use 'costCenter': 'BR_11101997'.

Response

Indicates that the request was successful and the response contains the expected data.

​
id
string<uuid>

The unique identifier of the Asset.

​
organizationId
string<uuid>

The unique identifier of the Organization.

​
ledgerId
string<uuid>

The unique identifier of the Ledger.

​
name
string

The name of the Asset.

Maximum length: 256
​
type
enum<string>

The type of Asset.

Available options:
currency,
crypto,
commodity,
others
​
code
string

The code used to refer to the Asset.

​
status
object

An object containing information about the status.

​
metadata
object

An object containing key-value pairs to add as metadata, where the field name is the key and the field value is the value. For example, to add a Cost Center, use 'costCenter': 'BR_11101997'.

​
createdAt
string<date-time>

Timestamp of creation (UTC).

​
updatedAt
string<date-time>

Timestamp of last update (UTC).

​
deletedAt
string<date-time> | null

Timestamp of soft deletion, if applicable (UTC).