Update an account

curl --request PATCH \
  --url https://ledger.sandbox.lerian.net/v2/organizations/{organization_id}/ledgers/{ledger_id}/accounts/{account_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "blocked": true,
  "entityId": "EXT-ACC-12345",
  "metadata": {},
  "name": "Primary Corporate Checking Account",
  "portfolioId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "segmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://ledger.sandbox.lerian.net/v2/organizations/{organization_id}/ledgers/{ledger_id}/accounts/{account_id}"

	payload := strings.NewReader("{\n  \"blocked\": true,\n  \"entityId\": \"EXT-ACC-12345\",\n  \"metadata\": {},\n  \"name\": \"Primary Corporate Checking Account\",\n  \"portfolioId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"segmentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    blocked: true,
    entityId: 'EXT-ACC-12345',
    metadata: {},
    name: 'Primary Corporate Checking Account',
    portfolioId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    segmentId: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  })
};

fetch('https://ledger.sandbox.lerian.net/v2/organizations/{organization_id}/ledgers/{ledger_id}/accounts/{account_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://ledger.sandbox.lerian.net/v2/organizations/{organization_id}/ledgers/{ledger_id}/accounts/{account_id}"

payload = {
    "blocked": True,
    "entityId": "EXT-ACC-12345",
    "metadata": {},
    "name": "Primary Corporate Checking Account",
    "portfolioId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "segmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

{
  "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",
  "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": {}
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

Update an 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. Metadata is applied as an RFC 7396 merge patch: a body without metadata, or with an empty metadata object, leaves the stored metadata as it is; a key sent as null is deleted; any other key is added or replaced; metadata sent as null also leaves the stored metadata as it is, so keys are deleted one at a time.

PATCH

organizations

{organization_id}

ledgers

{ledger_id}

accounts

{account_id}

Update an account

curl --request PATCH \
  --url https://ledger.sandbox.lerian.net/v2/organizations/{organization_id}/ledgers/{ledger_id}/accounts/{account_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "blocked": true,
  "entityId": "EXT-ACC-12345",
  "metadata": {},
  "name": "Primary Corporate Checking Account",
  "portfolioId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "segmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://ledger.sandbox.lerian.net/v2/organizations/{organization_id}/ledgers/{ledger_id}/accounts/{account_id}"

	payload := strings.NewReader("{\n  \"blocked\": true,\n  \"entityId\": \"EXT-ACC-12345\",\n  \"metadata\": {},\n  \"name\": \"Primary Corporate Checking Account\",\n  \"portfolioId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"segmentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    blocked: true,
    entityId: 'EXT-ACC-12345',
    metadata: {},
    name: 'Primary Corporate Checking Account',
    portfolioId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    segmentId: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  })
};

fetch('https://ledger.sandbox.lerian.net/v2/organizations/{organization_id}/ledgers/{ledger_id}/accounts/{account_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://ledger.sandbox.lerian.net/v2/organizations/{organization_id}/ledgers/{ledger_id}/accounts/{account_id}"

payload = {
    "blocked": True,
    "entityId": "EXT-ACC-12345",
    "metadata": {},
    "name": "Primary Corporate Checking Account",
    "portfolioId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "segmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

{
  "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",
  "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": {}
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

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)

account_id

string

required

Account ID (UUID)

Body

application/json

blocked

boolean | null

entityId

string | null

Maximum string length: 256

Example:

"EXT-ACC-12345"

metadata

object

Show child attributes

name

string

Maximum string length: 256

Example:

"Primary Corporate Checking Account"

portfolioId

string<uuid> | null

segmentId

string<uuid> | null

status

object

Show child attributes

Response

alias

string | null

required

Maximum string length: 100

Example:

"@treasury_checking"

assetCode

string

required

Maximum string length: 100

Example:

"USD"

blocked

boolean | null

required

closedAt

string<date-time> | null

required

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

Example:

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

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"

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

Getting started

Core

CRM

Fees

Error handling

Events

Update an account

Authorizations

Path Parameters

Body

Response