Wallet Management APIs

The Wallet Management APIs enable the creation, retrieval, updating, and management of wallets in the Ledger system. These APIs help organizations maintain wallet balances, manage transactions, and enforce accounting rules for assets, liabilities, and revenue.

1. Create or Update a Wallet

This allows users to create or update wallets with specific attributes like currency and balance rules. For example, a company can create a USD wallet for customer transactions and later update its attributes to add a spending limit.

put

Creates or updates a customer wallet.

Path parameters
groupNamestringRequired
referencestringRequired
Body

Agent supplied information about a wallet.

@typestring · enumRequiredPossible values:
accounting_typestring · enumRequired

Indicates the accounting element to which the wallet contributes; alters the treatment of postings on wallet balances.

Possible values:
currencystringRequired

The currency in which the wallet funds are denominated. Generally, but not required to be, a 3 letter currency code.

decimal_placesinteger · int32Required

The maximum number of decimal places that can be assigned to any balances attached to this wallet.

namestringRequired

The name assigned as part of the wallet's address.

Responses
200

Response to /api/v1/group/{groupName}/{reference}

application/json
put
/api/v1/group/{groupName}/{reference}
PUT /api/v1/group/{groupName}/{reference} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 182

{
  "@type": "cac_ledger_schema_info_ledger_wallet_info",
  "accounting_type": "LIABILITY",
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "currency": "text",
  "decimal_places": 1,
  "name": "text"
}
{
  "@type": "cac_ledger_schema_element_ledger_wallet_elem",
  "account": {
    "@type": "cac_ledger_schema_element_ledger_account_elem",
    "chart": {
      "@type": "cac_ledger_schema_element_ledger_chart_elem",
      "created_at": "2025-12-06T04:36:39.950Z",
      "id": 1,
      "info": {
        "@type": "cac_ledger_schema_info_ledger_chart_info",
        "name": "text"
      },
      "updated_at": "2025-12-06T04:36:39.950Z"
    },
    "created_at": "2025-12-06T04:36:39.950Z",
    "group": {
      "@type": "cac_ledger_schema_element_ledger_group_elem",
      "created_at": "2025-12-06T04:36:39.950Z",
      "id": 1,
      "info": {
        "@type": "cac_ledger_schema_info_ledger_group_info",
        "name": "text"
      },
      "updated_at": "2025-12-06T04:36:39.950Z"
    },
    "id": 1,
    "info": {
      "@type": "cac_ledger_schema_info_ledger_account_info",
      "attributes": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "reference": "text",
      "tags": [
        "text"
      ]
    },
    "revision": 1,
    "status": "CLOSED",
    "updated_at": "2025-12-06T04:36:39.950Z"
  },
  "created_at": "2025-12-06T04:36:39.950Z",
  "id": 1,
  "info": {
    "@type": "cac_ledger_schema_info_ledger_wallet_info",
    "accounting_type": "LIABILITY",
    "attributes": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "currency": "text",
    "decimal_places": 1,
    "name": "text"
  },
  "revision": 1,
  "status": "VALID",
  "updated_at": "2025-12-06T04:36:39.950Z"
}

2. Retrieve Wallet

Retrieve wallet details such as balance, transaction history, and status. For example, a finance team can check the balance and activity of a corporate expenses wallet before approving new transactions.

get

Retrieves an account wallet.

Path parameters
groupstringRequired
accountstringRequired
walletstringRequired
currencystringRequired
Responses
200

Response to /api/v1/group/{group}/{account}/{wallet}/{currency}

application/json
get
/api/v1/group/{group}/{account}/{wallet}/{currency}
GET /api/v1/group/{group}/{account}/{wallet}/{currency} HTTP/1.1
Host: 
Accept: */*

{
  "@type": "cac_ledger_schema_element_ledger_wallet_elem",
  "account": {
    "@type": "cac_ledger_schema_element_ledger_account_elem",
    "chart": {
      "@type": "cac_ledger_schema_element_ledger_chart_elem",
      "created_at": "2025-12-06T04:36:39.950Z",
      "id": 1,
      "info": {
        "@type": "cac_ledger_schema_info_ledger_chart_info",
        "name": "text"
      },
      "updated_at": "2025-12-06T04:36:39.950Z"
    },
    "created_at": "2025-12-06T04:36:39.950Z",
    "group": {
      "@type": "cac_ledger_schema_element_ledger_group_elem",
      "created_at": "2025-12-06T04:36:39.950Z",
      "id": 1,
      "info": {
        "@type": "cac_ledger_schema_info_ledger_group_info",
        "name": "text"
      },
      "updated_at": "2025-12-06T04:36:39.950Z"
    },
    "id": 1,
    "info": {
      "@type": "cac_ledger_schema_info_ledger_account_info",
      "attributes": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "reference": "text",
      "tags": [
        "text"
      ]
    },
    "revision": 1,
    "status": "CLOSED",
    "updated_at": "2025-12-06T04:36:39.950Z"
  },
  "created_at": "2025-12-06T04:36:39.950Z",
  "id": 1,
  "info": {
    "@type": "cac_ledger_schema_info_ledger_wallet_info",
    "accounting_type": "LIABILITY",
    "attributes": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "currency": "text",
    "decimal_places": 1,
    "name": "text"
  },
  "revision": 1,
  "status": "VALID",
  "updated_at": "2025-12-06T04:36:39.950Z"
}

PreviousAccount Management APIsNextTransaction Management APIs

Last updated