Instruction Management APIs
1. Create Instruction
A payroll system generates an instruction to process salary payments for multiple employees in one batch.
Creates a new instruction to move funds on the ledger.
Response to /api/v1/instruction/
default response to /api/v1/instruction/
POST /api/v1/instruction/ HTTP/1.1
Host:
Accept: */*
{
"@type": "cac_ledger_schema_element_ledger_instruction_elem",
"attributes": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"created_at": "2025-12-06T05:23:21.676Z",
"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.
Retrieves the data for a previously executed instruction.
Response to /api/v1/instruction/{id}
default response to /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:21.676Z"
},
"ordinal": 1
}
],
"attributes": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"created_at": "2025-12-06T05:23:21.676Z",
"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.
Queries previously executed instructions.
Response to /api/v1/instruction/
No content
default response to /api/v1/instruction/
GET /api/v1/instruction/?filter=text HTTP/1.1
Host:
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.
Deletes an instruction from the ledger.
Response to /api/v1/instruction/{id}
default response to /api/v1/instruction/{id}
DELETE /api/v1/instruction/{id} HTTP/1.1
Host:
Accept: */*
{
"@type": "cac_ledger_schema_element_ledger_instruction_elem",
"attributes": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"created_at": "2025-12-06T05:23:21.676Z",
"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.
Last updated