Instruction Management APIs

1. Create Instruction

A payroll system generates an instruction to process salary payments for multiple employees in one batch.

post

Creates a new instruction to move funds on the ledger.

Body

Responses

200

Response to /api/v1/instruction/

application/json

An instruction that is submitted to the ledger by an agent for the purpose of recording postings.

default

default response to /api/v1/instruction/

application/json

post

/api/v1/instruction/

HTTPcURLJavaScriptPython

POST /api/v1/instruction/ HTTP/1.1
Accept: */*

{
  "@type": "cac_ledger_schema_element_ledger_instruction_elem",
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "created_at": "2026-03-10T13:20:28.809Z",
  "id": "123e4567-e89b-12d3-a456-426614174000"
}

---

2. Retrieve Instruction

A finance team retrieves an instruction to verify if all payments in a bulk transfer were successfully completed.

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

Information about an instruction and the activities it contains.

default

default response to /api/v1/instruction/{id}

application/json

get

/api/v1/instruction/{id}

HTTPcURLJavaScriptPython

GET /api/v1/instruction/{id}?data=text HTTP/1.1
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": "2026-03-10T13:20:28.809Z"
      },
      "ordinal": 1
    }
  ],
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "created_at": "2026-03-10T13:20:28.809Z",
  "id": "123e4567-e89b-12d3-a456-426614174000"
}

---

3. List Instructions

Use Case: Retrieves a list of all instructions with optional filtering and pagination for auditing and reporting.

• Example: A compliance officer lists all instructions from the past month to monitor high-value fund transfers.

get

Queries previously executed instructions.

Query parameters

filterstringRequired

page[size]stringOptional

page[number]stringOptional

sortstringOptional

Responses

200

Response to /api/v1/instruction/

No content

default

default response to /api/v1/instruction/

application/json

get

/api/v1/instruction/

HTTPcURLJavaScriptPython

GET /api/v1/instruction/?filter=text HTTP/1.1
Accept: */*

No content

---

4. Delete Instruction

Removes an instruction that is incorrect, failed, or no longer needed.

• Example: An admin deletes a payroll instruction that was submitted with incorrect employee account details to prevent duplicate payments.

delete

Deletes an instruction from the ledger.

Path parameters

idstringRequired

Responses

200

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

application/json

An instruction that is submitted to the ledger by an agent for the purpose of recording postings.

default

default response to /api/v1/instruction/{id}

application/json

delete

/api/v1/instruction/{id}

HTTPcURLJavaScriptPython

DELETE /api/v1/instruction/{id} HTTP/1.1
Accept: */*

{
  "@type": "cac_ledger_schema_element_ledger_instruction_elem",
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "created_at": "2026-03-10T13:20:28.809Z",
  "id": "123e4567-e89b-12d3-a456-426614174000"
}

---

Example Use Cases

• Bulk Payment Processing: Create instructions to execute multiple transactions in a single request, such as payroll or vendor payments.

• Fraud Monitoring & Compliance: List and retrieve instructions to track large or suspicious transactions.

• Financial Reconciliation: Retrieve instruction details to verify execution status and account impact.

• Automated Fund Transfers: Use instructions to automate batch settlements or scheduled transfers.