GET
/
v1
/
organizations
/
{organization_id}
/
ledgers
/
{ledger_id}
/
accounts
/
alias
/
{alias}
Retrieve an Account by Alias
curl --request GET \
  --url http://127.0.0.1:3000/v1/organizations/{organization_id}/ledgers/{ledger_id}/accounts/alias/{alias} \
  --header 'Content-Type: <content-type>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "ledgerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "assetCode": "<string>",
  "name": "<string>",
  "alias": "<string>",
  "type": "deposit",
  "parentAccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "entityId": "<string>",
  "portfolioId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "segmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": {
    "status": {
      "description": "<string>",
      "code": "<string>"
    }
  },
  "metadata": {},
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "deletedAt": "2023-11-07T05:31:56Z"
}

Headers

​
Content-Type
string
required

The type of media of the resource. Must be <code>application/json</code>.

​
X-Request-Id
string

A unique identifier used to trace and track each request.

Path Parameters

​
organization_id
string
required

The unique identifier of the Organization associated with the Ledger.

​
ledger_id
string
required

The unique identifier of the associated Ledger.

​
alias
string
required

The alias for the account used in the operation.

Response

Indicates that the request was successful and the response contains the expected data.

​
id
string<uuid>

The unique identifier of the Account.

​
organizationId
string<uuid>

The unique identifier of the Organization.

​
ledgerId
string<uuid>

The unique identifier of the Ledger.

​
assetCode
string

The code that identifies the Asset used in the Account.

​
name
string

The name of the Account.

Maximum length: 256
​
alias
string

A unique, user-friendly identifier for the account. Used to reference the account in transactions and other operations.

​
type
enum<string>

The type of account.

Available options:
deposit,
savings,
loans,
marketplace,
cerditCard,
external
​
parentAccountId
string<uuid> | null

The unique identifier of the Parent Account.

​
entityId
string | null

The unique identifier of the Entity responsible for the Account.

​
portfolioId
string<uuid> | null

The unique identifier of the associated Portfolio.

​
segmentId
string<uuid> | null

The unique identifier of the Segment which is used to cluster the Account.

​
status
object

An object containing information about the status.

​
metadata
object

An object containing key-value pairs to add as metadata, where the field <code>name</code> is the key and the field <code>value</code> is the value. For example, to add a Cost Center, use 'costCenter': 'BR_11101997'.

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