Saltar al contenido principal
Crear un Activo
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": "Real Brasileño",
  "type": "currency",
  "code": "BRL",
  "status": {
    "code": "ACTIVE",
    "description": "Activo fiduciario principal para liquidación doméstica y saldos de clientes"
  },
  "metadata": {
    "symbol": "R$",
    "country": "Brasil",
    "isoNumeric": "986",
    "supportsFractions": true,
    "decimalPlaces": 2,
    "category": "fiat",
    "environment": "producción",
    "createdBy": "sistema",
    "notes": "Activo estándar de BRL para operaciones bancarias minoristas y transacciones Pix"
  }
}'
{
  "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"
}
Cuando creas un Activo, Midaz configura automáticamente una Cuenta Externa si aún no existe.Esto garantiza un respaldo fluido para todas las transacciones que ingresan o salen del Ledger.

Headers

​
Authorization
string

Token de autorización. Este encabezado es obligatorio si tu entorno tiene habilitado el Access Manager.

​
Content-Type
string
required

Tipo de medio del recurso. Debe ser <code>application/json</code>.

​
X-Request-Id
string

Identificador único usado para rastrear y seguir cada solicitud.

Path Parameters

​
organization_id
string
required

Identificador único de la organización asociada con el ledger.

​
ledger_id
string
required

Identificador único del ledger asociado.

Body

application/json
​
name
string
required

Nombre del activo, que debe ser <b>único</b>.

Maximum length: 256
​
type
enum<string>
required

Tipo de activo.

Opciones disponibles:
currency,
crypto,
commodity,
others
​
code
string
required

Código utilizado para referirse al activo según su tipo. <b>Importante:</b> No es posible crear activos con el mismo tipo y código. Además, si el activo es una moneda (<code>type</code> = currency), el código debe seguir los valores ISO 4217.

​
status
object

Objeto que contiene información sobre el estado. Importante: Si no se proporciona, el estado predeterminado será 'ACTIVE'.

​
metadata
object

Objeto que contiene pares clave-valor para agregar como metadatos, donde el campo <code>name</code> es la clave y el campo <code>value</code> es el valor. Por ejemplo, para agregar un centro de costos, usa 'costCenter': 'BR_11101997'.

Response

Indica que la solicitud se realizó correctamente y que la respuesta contiene los datos esperados.

​
id
string<uuid>

Identificador único del activo.

​
organizationId
string<uuid>

Identificador único de la organización.

​
ledgerId
string<uuid>

Identificador único del ledger.

​
name
string

Nombre del activo.

Maximum length: 256
​
type
enum<string>

Tipo de activo.

Opciones disponibles:
currency,
crypto,
commodity,
others
​
code
string

Código utilizado para referirse al activo.

​
status
object

Objeto que contiene información sobre el estado.

​
metadata
object

Objeto que contiene pares clave-valor para agregar como metadatos, donde el campo <code>name</code> es la clave y el campo <code>value</code> es el valor. Por ejemplo, para agregar un centro de costos, usa 'costCenter': 'BR_11101997'.

​
createdAt
string<date-time>

Marca temporal de creación (UTC).

​
updatedAt
string<date-time>

Marca temporal de la última actualización (UTC).

​
deletedAt
string<date-time> | null

Marca temporal de eliminación lógica, si aplica (UTC).