Update an account

PATCH /v2/organizations/{organization_id}/ledgers/{ledger_id}/accounts/{id}

Error

A valid request URL is required to generate request examples

200

{
  "alias": "@treasury_checking",
  "assetCode": "USD",
  "blocked": true,
  "createdAt": "2021-01-01T00:00:00Z",
  "deletedAt": "2021-01-01T00:00:00Z",
  "entityId": "EXT-ACC-12345",
  "holderCheckSkipped": false,
  "holderId": "00000000-0000-0000-0000-000000000000",
  "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": {}
}

Authorizations

Authorization · string · header · required

JWT bearer token issued by the identity provider.

Path Parameters

organization_id · string · required

Organization ID (UUID)

ledger_id · string · required

Ledger ID (UUID)

id · string · required

Account ID (UUID)

Body

application/json

blocked · boolean | null · required

entityId · string | null · required

Maximum string length: 256

Example:

"EXT-ACC-12345"

metadata · object · required

Show child attributes

name · string · required

Maximum string length: 256

Example:

"Primary Corporate Checking Account"

portfolioId · string<uuid> | null · required

segmentId · string<uuid> | null · required

status · object · required

Show child attributes

Response

200

application/json

OK

alias · string | null · required

Maximum string length: 100

Example:

"@treasury_checking"

assetCode · string · required

Maximum string length: 100

Example:

"USD"

blocked · boolean | null · required

createdAt · string<date-time> · required

Example:

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

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

Example:

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

entityId · string | null · required

Maximum string length: 256

Example:

"EXT-ACC-12345"

holderCheckSkipped · boolean · required

Example:

false

holderId · string<uuid> | null · required

Example:

"00000000-0000-0000-0000-000000000000"

id · string<uuid> · required

Example:

"00000000-0000-0000-0000-000000000000"

ledgerId · string<uuid> · required

Example:

"00000000-0000-0000-0000-000000000000"

name · string · required

Maximum string length: 256

Example:

"Corporate Checking Account"

organizationId · string<uuid> · required

Example:

"00000000-0000-0000-0000-000000000000"

parentAccountId · string<uuid> | null · required

Example:

"00000000-0000-0000-0000-000000000000"

portfolioId · string<uuid> | null · required

Example:

"00000000-0000-0000-0000-000000000000"

segmentId · string<uuid> | null · required

Example:

"00000000-0000-0000-0000-000000000000"

status · object · required

Show child attributes

type · string · required

Example:

"deposit"

updatedAt · string<date-time> · required

Example:

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

metadata · object

Show child attributes