Instruction Service
Manages financial transaction instructions, primarily deposit operations through agents.
Register Deposit Instruction
POST /v1/partners/{agent_id}/deposit
Registers a new deposit instruction from an agent to a customer's account.
Path Parameters:
| Parameter | Type | Description |
|---|---|---|
agent_id | string | Unique identifier for the agent |
Request Body:
{
"phone_number": "+258830000000",
"amount": 5000.00,
"currency": "MZN"
}
| Field | Type | Required | Description |
|---|---|---|---|
phone_number | string | Yes | Customer's phone number |
amount | number | Yes | Deposit amount |
currency | string | Yes | ISO 4217 currency code (3 letters, e.g., MZN) |
Response:
{
"transaction_id": "ins_abc12345",
"status": "completed"
}
| Field | Type | Description |
|---|---|---|
transaction_id | string | Unique ID for the created instruction |
status | string | Status of the instruction: pending, processing, completed, or failed |