Movement Management APIs


1. Retrieve Movement Details

Fetches details of a specific movement, including debit/credit accounts, amount, and status.

  • Example: A finance manager retrieves a movement record to confirm whether a customer refund was correctly processed.

get

Retrieves the data for a previously executed instruction.

Path parameters
idstringRequired
Query parameters
datastringRequired
Responses
200

Response to /api/v1/instruction/{id}

application/json
get
/api/v1/instruction/{id}
GET /api/v1/instruction/{id}?data=text HTTP/1.1
Host: 
Accept: */*
{
  "@type": "cac_ledger_schema_data_ledger_instruction_data",
  "activities": [
    {
      "info": {
        "@type": "cac_ledger_schema_info_ledger_activity_info",
        "adjust_value": true,
        "amount": 1,
        "attrs_changed": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "credit_wallet_address": "text",
        "debit_wallet_address": "text",
        "decimal_places": 1,
        "finalize": true,
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "tags_added": [
          "text"
        ],
        "value_date": "2025-12-06T05:23:22.222Z"
      },
      "ordinal": 1
    }
  ],
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "created_at": "2025-12-06T05:23:22.222Z",
  "id": "123e4567-e89b-12d3-a456-426614174000"
}

2. Track Wallet Movement

Tracks fund transfers between wallets to ensure accurate ledger entries.

  • Example: A retail company verifies movement between customer accounts when processing store credits for product returns.

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-06T05:23:22.222Z",
      "id": 1,
      "info": {
        "@type": "cac_ledger_schema_info_ledger_chart_info",
        "name": "text"
      },
      "updated_at": "2025-12-06T05:23:22.222Z"
    },
    "created_at": "2025-12-06T05:23:22.222Z",
    "group": {
      "@type": "cac_ledger_schema_element_ledger_group_elem",
      "created_at": "2025-12-06T05:23:22.222Z",
      "id": 1,
      "info": {
        "@type": "cac_ledger_schema_info_ledger_group_info",
        "name": "text"
      },
      "updated_at": "2025-12-06T05:23:22.222Z"
    },
    "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-06T05:23:22.222Z"
  },
  "created_at": "2025-12-06T05:23:22.222Z",
  "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-06T05:23:22.222Z"
}

Example Use Cases

  • Transaction Auditing: Retrieve movement details to track fund transfers and verify financial accuracy.

  • Fraud Detection: Monitor wallet movements to flag suspicious activities, such as large unexpected withdrawals.

  • Real-Time Fund Tracking: Fetch movement records for live transaction monitoring, ensuring timely processing.

  • Financial Reconciliation: Compare movement records with postings to verify balance updates and detect discrepancies.

These APIs provide essential tracking capabilities for managing fund transfers, improving transparency, and maintaining ledger accuracy.

Last updated