Retrieve a collection
curl -X GET https://api.wearemarz.com/v1/collections/MZ_COL_20240115_abc123 \
-H "Authorization: Bearer YOUR_SECRET_KEY"
{
"status": "success",
"data": {
"reference": "MZ_COL_20240115_abc123",
"amount": 10000,
"currency": "UGX",
"phone": "+256700123456",
"network": "MTN",
"status": "success",
"fee": 150,
"net_amount": 9850,
"checkout_url": "https://wallet.wearemarz.com/checkout/MZ_COL_20240115_abc123",
"created_at": "2024-01-15T10:30:00Z",
"completed_at": "2024-01-15T10:32:15Z",
"callback_url": "https://your-app.com/webhooks/collections"
}
}
Retrieve a disbursement
curl -X GET https://api.wearemarz.com/v1/disbursements/MZ_DISB_20240115_abc123 \
-H "Authorization: Bearer YOUR_SECRET_KEY"
{
"status": "success",
"data": {
"reference": "MZ_DISB_20240115_abc123",
"amount": 5000,
"currency": "UGX",
"phone": "+256700123456",
"network": "MTN",
"status": "success",
"fee": 50,
"net_amount": 4950,
"created_at": "2024-01-15T10:30:00Z",
"completed_at": "2024-01-15T10:32:15Z"
}
}
Retrieve a card payment
curl -X GET https://api.wearemarz.com/v1/payments/cards/MZ_CARD_20240115_abc123 \
-H "Authorization: Bearer YOUR_SECRET_KEY"
{
"status": "success",
"data": {
"reference": "MZ_CARD_20240115_abc123",
"amount": 10000,
"currency": "UGX",
"card_last_four": "4242",
"card_type": "visa",
"status": "success",
"fee": 290,
"net_amount": 9710,
"created_at": "2024-01-15T10:30:00Z",
"completed_at": "2024-01-15T10:32:15Z"
}
}
List transactions
curl -X GET "https://api.wearemarz.com/v1/collections?limit=10&offset=0&status=success" \
-H "Authorization: Bearer YOUR_SECRET_KEY"
{
"status": "success",
"data": {
"transactions": [
{
"reference": "MZ_COL_20240115_abc123",
"amount": 10000,
"currency": "UGX",
"status": "success",
"created_at": "2024-01-15T10:30:00Z"
}
],
"total": 1,
"limit": 10,
"offset": 0
}
}
Query parameters
| Parameter | Description |
|---|---|
limit | Number of transactions to return (default: 10, max: 100) |
offset | Number of transactions to skip (for pagination) |
status | Filter by status (pending, success, failed, expired) |
start_date | Filter transactions from this date (ISO 8601) |
end_date | Filter transactions to this date (ISO 8601) |
Transaction statuses
| Status | Meaning |
|---|---|
| pending | Transaction initiated, awaiting completion |
| success | Transaction completed successfully |
| failed | Transaction failed |
| expired | Transaction expired before completion |
Transaction fields
| Field | Description |
|---|---|
reference | Unique transaction reference |
amount | Transaction amount in smallest currency unit |
currency | Currency code (UGX, KES, RWF, CDF, USD, ZMW, XAF, XOF, SLE) |
status | Current transaction status |
fee | Transaction fee charged |
net_amount | Amount after fee deduction |
created_at | Transaction creation timestamp |
completed_at | Transaction completion timestamp |
Always check the
status field before fulfilling orders. A pending transaction is not yet complete.API Playground - Transaction Details - Test transaction detail endpoints live