A Transaction
Endpoint
GET https://dashboard.mbiyo.africa/api/v1/transactions/{reference}
Headers
| Header |
Type |
Required |
Description |
| Authorization |
string |
✅ |
Bearer token with your merchant API key |
Path Parameters
| Parameter |
Type |
Required |
Description |
| reference |
string |
✅ |
Transaction reference |
Example Request
curl -X GET "https://dashboard.mbiyo.africa/api/v1/transactions/73116916-a88e-44ef-90e8-fce31862efc3" \
-H "Authorization: Bearer YOUR_API_KEY"
Response
{
"message": "Transaction details",
"status": "success",
"data": {
"id": "73116916-a88e-44ef-90e8-fce31862efc3",
"amount": "1000.00",
"human_readable_amount": 10,
"charge": "10.00",
"human_readable_charge": 0.1,
"status": "success",
"decline_reason": null,
"mode": "live",
"type": "debit",
"description": "payout",
"created_at": "2024-07-21T23:17:15.000000Z",
"recipient_first_name": "Jude",
"recipient_middle_name": null,
"recipient_last_name": "Obiora",
"recipient_country": "NG",
"recipient_email": "",
"recipient_phone": null,
"recipient_amount": "1584277.00",
"human_readable_recipient_amount": 15842.77,
"recipient_currency": "NGN",
"rate": 1584.27720297,
"transfer_purpose": "Education",
"delivery_method": "cash_pickup",
"agent": {
"id": "f62a1d1a-eb9c-42cc-aac2-0a1c6dd8c7ba",
"business_name": "Access Bank",
"first_name": "Access",
"last_name": "Bank",
"email": "contactcenter@accessbankplc.com",
"phone": "+234 1-2712005-7, 07003000000",
"address": "14/15, Prince Alaba Oniru Road,\nOniru, Victoria Island,\nLagos State, Nigeria.",
"image": "http://localhost:8888/whitelabels/remittance/storage/app/agents/wjCrf5Xe9QR3Mw5UUyoUxFIXaX208cAayoYutbEm.png"
}
}
}
Response Fields
| Field |
Type |
Description |
| id |
string |
Unique transaction identifier |
| amount |
string |
Transaction amount in lowest currency denomination |
| human_readable_amount |
number |
Amount divided by 100 for display |
| charge |
string |
Service fee charged |
| human_readable_charge |
number |
Fee divided by 100 for display |
| status |
string |
Transaction status |
| decline_reason |
string or null |
Reason if transaction was declined |
| mode |
string |
live or test |
| type |
string |
debit or credit |
| description |
string |
Transaction description |
| created_at |
string |
ISO 8601 timestamp |
| recipient_first_name |
string |
Recipient first name |
| recipient_middle_name |
string or null |
Recipient middle name |
| recipient_last_name |
string |
Recipient last name |
| recipient_country |
string |
2-letter ISO country code |
| recipient_email |
string |
Recipient email |
| recipient_phone |
string or null |
Recipient phone number |
| recipient_amount |
string |
Amount sent to recipient |
| human_readable_recipient_amount |
number |
Recipient amount divided by 100 |
| recipient_currency |
string |
3-letter ISO currency code |
| rate |
number |
Exchange rate applied |
| transfer_purpose |
string |
Purpose of the transfer |
| delivery_method |
string |
Delivery method (bank, cash_pickup, mobile_money) |
| agent |
object |
Agent/business handling the payout |