> For the complete documentation index, see [llms.txt](https://docs.xyb.co/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.xyb.co/xyb-platform-1/xyb-ledger/api-reference-guides/transaction-management-apis/instruction-management-apis.md).

# Instruction Management APIs

### **1. Create Instruction**

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

{% openapi src="/files/5af2rdQ5h4ZxHvDZfiyJ" path="/api/v1/instruction/" method="post" %}
[openapi-ledger.json](https://content.gitbook.com/content/akJn6TxWIBAbZwLlYoVP/blobs/S917VQZQHm6OZGrj1mf5/openapi-ledger.json)
{% endopenapi %}

***

### **2. Retrieve Instruction**

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

{% openapi src="/files/5af2rdQ5h4ZxHvDZfiyJ" path="/api/v1/instruction/{id}" method="get" %}
[openapi-ledger.json](https://content.gitbook.com/content/akJn6TxWIBAbZwLlYoVP/blobs/S917VQZQHm6OZGrj1mf5/openapi-ledger.json)
{% endopenapi %}

***

### **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.

{% openapi src="/files/5af2rdQ5h4ZxHvDZfiyJ" path="/api/v1/instruction/" method="get" %}
[openapi-ledger.json](https://content.gitbook.com/content/akJn6TxWIBAbZwLlYoVP/blobs/S917VQZQHm6OZGrj1mf5/openapi-ledger.json)
{% endopenapi %}

***

### **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.

{% openapi src="/files/5af2rdQ5h4ZxHvDZfiyJ" path="/api/v1/instruction/{id}" method="delete" %}
[openapi-ledger.json](https://content.gitbook.com/content/akJn6TxWIBAbZwLlYoVP/blobs/S917VQZQHm6OZGrj1mf5/openapi-ledger.json)
{% endopenapi %}

***

#### **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.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.xyb.co/xyb-platform-1/xyb-ledger/api-reference-guides/transaction-management-apis/instruction-management-apis.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.