Skip to main content

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:

ParameterTypeDescription
agent_idstringUnique identifier for the agent

Request Body:

{
"phone_number": "+258830000000",
"amount": 5000.00,
"currency": "MZN"
}
FieldTypeRequiredDescription
phone_numberstringYesCustomer's phone number
amountnumberYesDeposit amount
currencystringYesISO 4217 currency code (3 letters, e.g., MZN)

Response:

{
"transaction_id": "ins_abc12345",
"status": "completed"
}
FieldTypeDescription
transaction_idstringUnique ID for the created instruction
statusstringStatus of the instruction: pending, processing, completed, or failed