POST
/
v1
/
organizations
/
{organization_id}
/
ledgers
/
{ledger_id}
/
accounts
Create an Account
curl --request POST \
  --url https://onboarding.sandbox.midaz.io/v1/organizations/{organization_id}/ledgers/{ledger_id}/accounts \
  --header 'Content-Type: <content-type>' \
  --data '{
  "assetCode": "BRL",
  "name": "Brazilian Real Account",
  "alias": "@brl_wallet",
  "type": "deposit",
  "parentAccountId": "e1ed3a74-654a-4b44-ad7d-37a9fac46d71",
  "portfolioId": "e1ed3a74-654a-4b44-ad7d-37a9fac46d72",
  "entityId": "e1ed3a74-654a-4b44-ad7d-37a9fac46d88",
  "segmentId": "e1ed3a74-654a-4b44-ad7d-37a9fac46d90",
  "status": {
    "code": "ACTIVE",
    "description": "Account Created"
  },
  "metadata": {
    "accountNumber": "450987",
    "accountBranch": "4433"
  }
}'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "ledgerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "assetCode": "<string>",
  "name": "<string>",
  "alias": "<string>",
  "type": "<string>",
  "parentAccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "entityId": "<string>",
  "portfolioId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "segmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": {
    "code": "<string>",
    "description": "<string>"
  },
  "metadata": {},
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "deletedAt": "2023-11-07T05:31:56Z"
}

Headers

​
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
​
assetCode
string
required

The code that identifies the Asset used in the Account. Important: Must be an Asset that you've already created using the Create an Asset endpoint.

​
alias
string
required

A unique, user-friendly identifier for the account. Used to reference the account in transactions and other operations. If not provided, the system will use the account's ID as the alias.

Maximum length: 100
​
name
string

The name of the Account.

Maximum length: 256
​
type
string

Specifies the Account Type associated with the account. Important: When Account Type validation is enabled for your Organization and Ledger, this field becomes mandatory and must match an existing keyValue defined in your Account Types configuration. However, when validation is disabled (default behavior), this field is optional and accepts any free-form string without validation.

​
parentAccountId
string<uuid> | null

The unique identifier of the Parent Account. If the account does not have a parent account, this field will be null.

​
entityId
string | null

The unique identifier of the Entity responsible for the Account.

​
portfolioId
string<uuid> | null

The unique identifier of the associated Portfolio.

​
segmentId
string<uuid> | null

The unique identifier of the Segment which is used to cluster the Account.

​
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'.

Response

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

​
id
string<uuid>

The unique identifier of the Account.

​
organizationId
string<uuid>

The unique identifier of the Organization.

​
ledgerId
string<uuid>

The unique identifier of the Ledger.

​
assetCode
string

The code that identifies the Asset used in the Account.

​
name
string

The name of the Account.

Maximum length: 256
​
alias
string

A unique, user-friendly identifier for the account. Used to reference the account in transactions and other operations.

​
type
string

Specifies the Account Type associated with the account.

​
parentAccountId
string<uuid> | null

The unique identifier of the Parent Account.

​
entityId
string | null

The unique identifier of the Entity responsible for the Account.

​
portfolioId
string<uuid> | null

The unique identifier of the associated Portfolio.

​
segmentId
string<uuid> | null

The unique identifier of the Segment which is used to cluster the Account.

​
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).