Retrieve an account by external code

curl --request GET \
  --url https://ledger.sandbox.lerian.net/v2/organizations/{organization_id}/ledgers/{ledger_id}/accounts/external/{code} \
  --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}/accounts/external/{code}"

	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}/accounts/external/{code}', 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/external/{code}"

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

response = requests.get(url, 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"
  }
}

GET

organizations

{organization_id}

ledgers

{ledger_id}

accounts

external

{code}

Retrieve an account by external code

curl --request GET \
  --url https://ledger.sandbox.lerian.net/v2/organizations/{organization_id}/ledgers/{ledger_id}/accounts/external/{code} \
  --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}/accounts/external/{code}"

	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}/accounts/external/{code}', 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/external/{code}"

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

response = requests.get(url, 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)

code

string

required

Account external code (e.g. BRL)

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

Retrieve an account by external code

Authorizations

Path Parameters

Response