Create a new account

The closing instant is output only: a body naming closedAt or closed_at at its root is refused with 400 whatever the value it carries, and the stored instant is only ever written by the close command.

POST /v1/organizations/{organization_id}/ledgers/{ledger_id}/accounts

Create a new account

cURL

curl --request POST \
  --url https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/accounts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "alias": "@treasury_checking",
  "assetCode": "USD",
  "blocked": true,
  "entityId": "EXT-ACC-12345",
  "holderId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "metadata": {},
  "name": "Corporate Checking Account",
  "parentAccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "portfolioId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "segmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": {
    "code": "ACTIVE",
    "description": "Active status"
  },
  "type": "deposit",
  "skip": {
    "holder": false
  }
}
'

201

{
  "alias": "@treasury_checking",
  "assetCode": "USD",
  "blocked": true,
  "closedAt": "2021-01-01T00:00:00Z",
  "createdAt": "2021-01-01T00:00:00Z",
  "deletedAt": "2021-01-01T00:00:00Z",
  "entityId": "EXT-ACC-12345",
  "id": "00000000-0000-0000-0000-000000000000",
  "ledgerId": "00000000-0000-0000-0000-000000000000",
  "name": "Corporate Checking Account",
  "organizationId": "00000000-0000-0000-0000-000000000000",
  "parentAccountId": "00000000-0000-0000-0000-000000000000",
  "portfolioId": "00000000-0000-0000-0000-000000000000",
  "segmentId": "00000000-0000-0000-0000-000000000000",
  "status": {
    "code": "ACTIVE",
    "description": "Active status"
  },
  "type": "deposit",
  "updatedAt": "2021-01-01T00:00:00Z",
  "metadata": {}
}

Autorizaciones

Authorization · string · header · requerido

JWT bearer token issued by the identity provider.

Encabezados

Authorization · string

Bearer token (forwarded to the service)

Parámetros de ruta

organization_id · string · requerido

Organization ID (UUID)

ledger_id · string · requerido

Ledger ID (UUID)

Cuerpo

application/json

alias · string | null · requerido

Maximum string length: 100

Ejemplo:

"@treasury_checking"

assetCode · string · requerido

Maximum string length: 100

Ejemplo:

"USD"

blocked · boolean | null · requerido

entityId · string | null · requerido

Maximum string length: 256

Ejemplo:

"EXT-ACC-12345"

holderId · string<uuid> | null · requerido

metadata · object · requerido

Show child attributes

name · string · requerido

Maximum string length: 256

Ejemplo:

"Corporate Checking Account"

parentAccountId · string<uuid> | null · requerido

portfolioId · string<uuid> | null · requerido

segmentId · string<uuid> | null · requerido

status · object · requerido

Show child attributes

type · string · requerido

Ejemplo:

"deposit"

skip · object

Show child attributes

Respuesta

201

application/json

Created

alias · string | null · requerido

Maximum string length: 100

Ejemplo:

"@treasury_checking"

assetCode · string · requerido

Maximum string length: 100

Ejemplo:

"USD"

blocked · boolean | null · requerido

closedAt · string<date-time> | null · requerido

Instant the account was closed, null while it is still open. Output only: it is written exclusively by the close command and is refused as an input field on create and update

Ejemplo:

"2021-01-01T00:00:00Z"

createdAt · string<date-time> · requerido

Ejemplo:

"2021-01-01T00:00:00Z"

deletedAt · string<date-time> | null · requerido

Ejemplo:

"2021-01-01T00:00:00Z"

entityId · string | null · requerido

Maximum string length: 256

Ejemplo:

"EXT-ACC-12345"

id · string<uuid> · requerido

Ejemplo:

"00000000-0000-0000-0000-000000000000"

ledgerId · string<uuid> · requerido

Ejemplo:

"00000000-0000-0000-0000-000000000000"

name · string · requerido

Maximum string length: 256

Ejemplo:

"Corporate Checking Account"

organizationId · string<uuid> · requerido

Ejemplo:

"00000000-0000-0000-0000-000000000000"

parentAccountId · string<uuid> | null · requerido

Ejemplo:

"00000000-0000-0000-0000-000000000000"

portfolioId · string<uuid> | null · requerido

Ejemplo:

"00000000-0000-0000-0000-000000000000"

segmentId · string<uuid> | null · requerido

Ejemplo:

"00000000-0000-0000-0000-000000000000"

status · object · requerido

Show child attributes

type · string · requerido

Ejemplo:

"deposit"

updatedAt · string<date-time> · requerido

Ejemplo:

"2021-01-01T00:00:00Z"

metadata · object

Show child attributes