Get Balance by id

curl --request GET \
  --url https://ledger.sandbox.lerian.net/v2/organizations/{organization_id}/ledgers/{ledger_id}/balances/{balance_id} \
  --header 'Authorization: Bearer <token>'

package main

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

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://ledger.sandbox.lerian.net/v2/organizations/{organization_id}/ledgers/{ledger_id}/balances/{balance_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}/balances/{balance_id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

{
  "accountId": "00000000-0000-0000-0000-000000000000",
  "accountType": "creditCard",
  "alias": "@person1",
  "allowReceiving": true,
  "allowSending": true,
  "assetCode": "USD",
  "available": "1500",
  "createdAt": "2021-01-01T00:00:00Z",
  "deletedAt": "2021-01-01T00:00:00Z",
  "id": "00000000-0000-0000-0000-000000000000",
  "key": "asset-freeze",
  "ledgerId": "00000000-0000-0000-0000-000000000000",
  "onHold": "500",
  "organizationId": "00000000-0000-0000-0000-000000000000",
  "overdraftUsed": "0",
  "updatedAt": "2021-01-01T00:00:00Z",
  "version": 1,
  "direction": "credit",
  "metadata": {},
  "settings": {
    "allowOverdraft": false,
    "overdraftLimitEnabled": false,
    "balanceScope": "transactional",
    "overdraftLimit": "1000.00"
  }
}

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

GET

organizations

{organization_id}

ledgers

{ledger_id}

balances

{balance_id}

Get Balance by id

curl --request GET \
  --url https://ledger.sandbox.lerian.net/v2/organizations/{organization_id}/ledgers/{ledger_id}/balances/{balance_id} \
  --header 'Authorization: Bearer <token>'

package main

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

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://ledger.sandbox.lerian.net/v2/organizations/{organization_id}/ledgers/{ledger_id}/balances/{balance_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}/balances/{balance_id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

{
  "accountId": "00000000-0000-0000-0000-000000000000",
  "accountType": "creditCard",
  "alias": "@person1",
  "allowReceiving": true,
  "allowSending": true,
  "assetCode": "USD",
  "available": "1500",
  "createdAt": "2021-01-01T00:00:00Z",
  "deletedAt": "2021-01-01T00:00:00Z",
  "id": "00000000-0000-0000-0000-000000000000",
  "key": "asset-freeze",
  "ledgerId": "00000000-0000-0000-0000-000000000000",
  "onHold": "500",
  "organizationId": "00000000-0000-0000-0000-000000000000",
  "overdraftUsed": "0",
  "updatedAt": "2021-01-01T00:00:00Z",
  "version": 1,
  "direction": "credit",
  "metadata": {},
  "settings": {
    "allowOverdraft": false,
    "overdraftLimitEnabled": false,
    "balanceScope": "transactional",
    "overdraftLimit": "1000.00"
  }
}

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

balance_id

string

required

Balance ID (UUID)

Response

accountId

string<uuid>

required

Example:

"00000000-0000-0000-0000-000000000000"

accountType

string

required

Maximum string length: 50

Example:

"creditCard"

alias

string

required

Maximum string length: 256

Example:

"@person1"

allowReceiving

boolean

required

Example:

true

allowSending

boolean

required

Example:

true

assetCode

string

required

Required string length: 2 - 10

Example:

"USD"

available

string

required

Example:

"1500"

createdAt

string<date-time>

required

Example:

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

deletedAt

string<date-time> | null

required

Example:

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

string<uuid>

required

Example:

"00000000-0000-0000-0000-000000000000"

key

string

required

Maximum string length: 100

Example:

"asset-freeze"

ledgerId

string<uuid>

required

Example:

"00000000-0000-0000-0000-000000000000"

onHold

string

required

Example:

"500"

organizationId

string<uuid>

required

Example:

"00000000-0000-0000-0000-000000000000"

overdraftUsed

string

required

Example:

"0"

updatedAt

string<date-time>

required

Example:

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

version

integer<int64>

required

Required range: x >= 1

Example:

1

direction

string

Example:

"credit"

metadata

object

Show child attributes

settings

object

Show child attributes

Getting started

Core

CRM

Fees

Error handling

Events

Get Balance by id

Authorizations

Path Parameters

Response