Create a new account

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
  }
}
'

package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"alias\": \"@treasury_checking\",\n  \"assetCode\": \"USD\",\n  \"blocked\": true,\n  \"entityId\": \"EXT-ACC-12345\",\n  \"holderId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"metadata\": {},\n  \"name\": \"Corporate Checking Account\",\n  \"parentAccountId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"portfolioId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"segmentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"status\": {\n    \"code\": \"ACTIVE\",\n    \"description\": \"Active status\"\n  },\n  \"type\": \"deposit\",\n  \"skip\": {\n    \"holder\": false\n  }\n}")

	req, _ := http.NewRequest("POST", 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: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    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}
  })
};

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

import requests

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

payload = {
    "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 }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(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",
  "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": "0065",
  "message": "<string>",
  "title": "Invalid Path Parameter",
  "entityType": "Account",
  "fields": {}
}

{
  "code": "0065",
  "message": "<string>",
  "title": "Invalid Path Parameter",
  "entityType": "Account",
  "fields": {}
}

{
  "code": "0065",
  "message": "<string>",
  "title": "Invalid Path Parameter",
  "entityType": "Account",
  "fields": {}
}

POST

organizations

{organization_id}

ledgers

{ledger_id}

accounts

Create a new account

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
  }
}
'

package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"alias\": \"@treasury_checking\",\n  \"assetCode\": \"USD\",\n  \"blocked\": true,\n  \"entityId\": \"EXT-ACC-12345\",\n  \"holderId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"metadata\": {},\n  \"name\": \"Corporate Checking Account\",\n  \"parentAccountId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"portfolioId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"segmentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"status\": {\n    \"code\": \"ACTIVE\",\n    \"description\": \"Active status\"\n  },\n  \"type\": \"deposit\",\n  \"skip\": {\n    \"holder\": false\n  }\n}")

	req, _ := http.NewRequest("POST", 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: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    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}
  })
};

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

import requests

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

payload = {
    "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 }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(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",
  "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": "0065",
  "message": "<string>",
  "title": "Invalid Path Parameter",
  "entityType": "Account",
  "fields": {}
}

{
  "code": "0065",
  "message": "<string>",
  "title": "Invalid Path Parameter",
  "entityType": "Account",
  "fields": {}
}

{
  "code": "0065",
  "message": "<string>",
  "title": "Invalid Path Parameter",
  "entityType": "Account",
  "fields": {}
}

Authorizations

Authorization

string

header

required

JWT bearer token issued by the identity provider.

Headers

Authorization

string

Bearer token (forwarded to the service)

Path Parameters

organization_id

string

required

Organization ID (UUID)

ledger_id

string

required

Ledger ID (UUID)

Body

application/json

alias

string | null

required

Maximum string length: 100

Example:

"@treasury_checking"

assetCode

string

required

Maximum string length: 100

Example:

"USD"

blocked

boolean | null

required

entityId

string | null

required

Maximum string length: 256

Example:

"EXT-ACC-12345"

holderId

string<uuid> | null

required

metadata

object

required

Show child attributes

name

string

required

Maximum string length: 256

Example:

"Corporate Checking Account"

parentAccountId

string<uuid> | null

required

portfolioId

string<uuid> | null

required

segmentId

string<uuid> | null

required

status

object

required

Show child attributes

type

string

required

Example:

"deposit"

skip

object

Show child attributes

Response

Created

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"

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

Account Types

Accounts

Asset Rates

Assets

Balances

Ledgers

Metadata Indexes

Operation Routes

Operations

Organizations

Portfolios

Segments

Transaction Routes

Transactions

Error handling

Create a new account

Authorizations

Headers

Path Parameters

Body

Response