Create an Account Type

curl --request POST \
  --url https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/account-types \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Deposit Account",
  "description": "Deposit Account",
  "keyValue": "deposit",
  "metadata": {
    "supportsOverdraft": true,
    "minimumBalance": 0,
    "statementFrequency": "monthly",
    "category": "retail",
    "internalCode": "ACC_TYPE_TX_001"
  }
}
'

import requests

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

payload = {
    "name": "Deposit Account",
    "description": "Deposit Account",
    "keyValue": "deposit",
    "metadata": {
        "supportsOverdraft": True,
        "minimumBalance": 0,
        "statementFrequency": "monthly",
        "category": "retail",
        "internalCode": "ACC_TYPE_TX_001"
    }
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Deposit Account',
    description: 'Deposit Account',
    keyValue: 'deposit',
    metadata: {
      supportsOverdraft: true,
      minimumBalance: 0,
      statementFrequency: 'monthly',
      category: 'retail',
      internalCode: 'ACC_TYPE_TX_001'
    }
  })
};

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

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/account-types",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Deposit Account',
    'description' => 'Deposit Account',
    'keyValue' => 'deposit',
    'metadata' => [
        'supportsOverdraft' => true,
        'minimumBalance' => 0,
        'statementFrequency' => 'monthly',
        'category' => 'retail',
        'internalCode' => 'ACC_TYPE_TX_001'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"name\": \"Deposit Account\",\n  \"description\": \"Deposit Account\",\n  \"keyValue\": \"deposit\",\n  \"metadata\": {\n    \"supportsOverdraft\": true,\n    \"minimumBalance\": 0,\n    \"statementFrequency\": \"monthly\",\n    \"category\": \"retail\",\n    \"internalCode\": \"ACC_TYPE_TX_001\"\n  }\n}")

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

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

}

HttpResponse<String> response = Unirest.post("https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/account-types")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Deposit Account\",\n  \"description\": \"Deposit Account\",\n  \"keyValue\": \"deposit\",\n  \"metadata\": {\n    \"supportsOverdraft\": true,\n    \"minimumBalance\": 0,\n    \"statementFrequency\": \"monthly\",\n    \"category\": \"retail\",\n    \"internalCode\": \"ACC_TYPE_TX_001\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/account-types")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Deposit Account\",\n  \"description\": \"Deposit Account\",\n  \"keyValue\": \"deposit\",\n  \"metadata\": {\n    \"supportsOverdraft\": true,\n    \"minimumBalance\": 0,\n    \"statementFrequency\": \"monthly\",\n    \"category\": \"retail\",\n    \"internalCode\": \"ACC_TYPE_TX_001\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "ledgerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "description": "<string>",
  "keyValue": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "deletedAt": "2023-11-07T05:31:56Z",
  "metadata": {}
}

POST

organizations

{organization_id}

ledgers

{ledger_id}

account-types

Create an Account Type

curl --request POST \
  --url https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/account-types \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Deposit Account",
  "description": "Deposit Account",
  "keyValue": "deposit",
  "metadata": {
    "supportsOverdraft": true,
    "minimumBalance": 0,
    "statementFrequency": "monthly",
    "category": "retail",
    "internalCode": "ACC_TYPE_TX_001"
  }
}
'

import requests

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

payload = {
    "name": "Deposit Account",
    "description": "Deposit Account",
    "keyValue": "deposit",
    "metadata": {
        "supportsOverdraft": True,
        "minimumBalance": 0,
        "statementFrequency": "monthly",
        "category": "retail",
        "internalCode": "ACC_TYPE_TX_001"
    }
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Deposit Account',
    description: 'Deposit Account',
    keyValue: 'deposit',
    metadata: {
      supportsOverdraft: true,
      minimumBalance: 0,
      statementFrequency: 'monthly',
      category: 'retail',
      internalCode: 'ACC_TYPE_TX_001'
    }
  })
};

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

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/account-types",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Deposit Account',
    'description' => 'Deposit Account',
    'keyValue' => 'deposit',
    'metadata' => [
        'supportsOverdraft' => true,
        'minimumBalance' => 0,
        'statementFrequency' => 'monthly',
        'category' => 'retail',
        'internalCode' => 'ACC_TYPE_TX_001'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"name\": \"Deposit Account\",\n  \"description\": \"Deposit Account\",\n  \"keyValue\": \"deposit\",\n  \"metadata\": {\n    \"supportsOverdraft\": true,\n    \"minimumBalance\": 0,\n    \"statementFrequency\": \"monthly\",\n    \"category\": \"retail\",\n    \"internalCode\": \"ACC_TYPE_TX_001\"\n  }\n}")

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

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

}

HttpResponse<String> response = Unirest.post("https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/account-types")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Deposit Account\",\n  \"description\": \"Deposit Account\",\n  \"keyValue\": \"deposit\",\n  \"metadata\": {\n    \"supportsOverdraft\": true,\n    \"minimumBalance\": 0,\n    \"statementFrequency\": \"monthly\",\n    \"category\": \"retail\",\n    \"internalCode\": \"ACC_TYPE_TX_001\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/account-types")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Deposit Account\",\n  \"description\": \"Deposit Account\",\n  \"keyValue\": \"deposit\",\n  \"metadata\": {\n    \"supportsOverdraft\": true,\n    \"minimumBalance\": 0,\n    \"statementFrequency\": \"monthly\",\n    \"category\": \"retail\",\n    \"internalCode\": \"ACC_TYPE_TX_001\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "ledgerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "description": "<string>",
  "keyValue": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "deletedAt": "2023-11-07T05:31:56Z",
  "metadata": {}
}

Headers

Content-Type

string

The type of media of the resource. Recommended value is application/json.

X-Request-Id

string<uuid>

A unique identifier used to trace and track each request.

Authorization

string

Bearer JWT token for authentication. Required when PLUGIN_AUTH_ENABLED=true (enforced in multi-tenant deployments). Optional in default OSS single-tenant mode. Format: Bearer <token>

Path Parameters

organization_id

string<uuid>

required

The unique identifier of the Organization associated with the Ledger.

ledger_id

string<uuid>

required

The unique identifier of the associated Ledger.

Body

application/json

name

string

required

Name of the Account Type.

Maximum string length: 100

keyValue

string

required

Unique identifier for the Account Type being created. Important: If the Account Types feature is enabled, this value becomes mandatory when creating accounts — only previously registered keyValues will be accepted in the type field of the Accounts API. Accepted characters: alphanumeric (uppercase and lowercase), dashes (-), and underscores (_).

Maximum string length: 50

Pattern: ^[a-zA-Z0-9_-]+$

description

string

Description of the Account Type.

Maximum string length: 500

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

Constraints: keys must be at most 100 characters; string values at most 2000 characters. Nested objects are not allowed (values must be string, number, or boolean), the structure may not exceed a maximum depth of 10, and a maximum of 100 keys is permitted.

Show child attributes

Response

Indicates that the resource was successfully created and the operation was completed as expected.

string<uuid>

The unique identifier of the Account Type.

organizationId

string<uuid>

The unique identifier of the Organization.

ledgerId

string<uuid>

The unique identifier of the Ledger.

name

string

Name of the Account Type.

description

string

Description of the Account Type.

keyValue

string

Unique identifier for the Account Type created.

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

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

Show child attributes

Delete an Asset

List Account Types

Getting started

Organizations API

Ledgers API

Assets API

Account Types API

Accounts API

Portfolios API

Segments API

Balances API

Transactions API

Operations API

Operation Routes API

Transaction Routes API

Metadata Indexes API

Holders API

Instruments API

Billing Packages API

Packages API

Billing Calculation API

Estimation API

Encryption API

Protection API

Asset Rates API

Error handling

Fees Engine

Create an Account Type

Headers

Path Parameters

Body

Response