API docs · 11 of 14
The transaction object
Collections, payouts, transaction checks and webhooks all return this object.
| Field | Meaning |
|---|---|
id | Our id for the transaction. |
reference | Unique reference like PRN-8F3K2Q91. Use it to look the transaction up. |
type | "collection" or "payout". |
status | "pending", "success", "failed" or "reversed". Only "success" means the money has moved. |
currency | The wallet currency. |
amount | The amount you asked for. |
provider_fee | The network charge added on top. |
platform_fee | The Paranthropus fee added on top. |
total | amount + provider_fee + platform_fee. |
method | "mobile_money". |
phone | The phone number in international format. |
description | Your description, or "Collection" / "Payout". |
idempotency_key | The Idempotency-Key you sent, if any. |
mode | "test" or "live", matching the key you used. |
created_at | When it was created (ISO 8601, UTC). |
completed_at | When it finished, or null while pending. |
Example
{
"success": true,
"data": {
"id": "6f1c2a7e-3b0d-4d7a-9a51-2f6e8c1d4b90",
"reference": "PRN-8F3K2Q91",
"type": "collection",
"status": "pending",
"currency": "UGX",
"amount": 25000,
"provider_fee": 500,
"platform_fee": 0,
"total": 25500,
"method": "mobile_money",
"phone": "+256701234567",
"description": "Order 1042",
"idempotency_key": "order-1042",
"mode": "test",
"created_at": "2026-11-19T09:30:00.000Z",
"completed_at": null
}
}A few more fields may appear (for example for transfers in your dashboard). Ignore fields you do not need.