GET /finance

GET/v1/finance
Returns a full finance object including bank account, mobile money provider, and a transaction record.
PARAMETERS
NameTypeDefaultDescription
countrystringrandomISO 3166-1 alpha-2 country code: GH, NG, KE, ZA, RW
countint1Number of records to return. Min 1, max 100.
EXAMPLE REQUEST
GET /v1/finance?country=NG&count=1
EXAMPLE RESPONSE
{
  "country": "NG",
  "count": 1,
  "data": [{
    "bank": "GTBank",
    "account_number": "0123456789",
    "account_name": "Chukwuemeka Obi",
    "bvn": "22198374651",
    "mobile_money": {
      "provider": "MTN MoMo",
      "phone": "08031234567"
    },
    "transaction": {
      "id": "TXN_8f3k2j9d1m",
      "amount": 45000,
      "currency": "NGN",
      "status": "success",
      "timestamp": "2024-11-08T14:23:01Z"
    }
  }]
}
GET/v1/finance/transaction
Returns a transaction record only.
PARAMETERS
NameTypeDefaultDescription
countrystringrandomISO 3166-1 alpha-2 country code: GH, NG, KE, ZA, RW
countint1Number of records to return. Min 1, max 100.
EXAMPLE REQUEST
GET /v1/finance/transaction?country=KE&count=1
EXAMPLE RESPONSE
{
  "country": "KE",
  "count": 1,
  "data": [{
    "id": "TXN_9a1b2c3d4e",
    "amount": 1500,
    "currency": "KES",
    "status": "success",
    "timestamp": "2024-11-09T08:14:22Z"
  }]
}
GET/v1/finance/account
Returns bank account and mobile money details only, without a transaction.
PARAMETERS
NameTypeDefaultDescription
countrystringrandomISO 3166-1 alpha-2 country code: GH, NG, KE, ZA, RW
countint1Number of records to return. Min 1, max 100.
EXAMPLE REQUEST
GET /v1/finance/account?country=GH&count=1
EXAMPLE RESPONSE
{
  "country": "GH",
  "count": 1,
  "data": [{
    "bank": "GCB Bank",
    "account_number": "1234567890",
    "account_name": "Kofi Asante",
    "mobile_money": {
      "provider": "MTN MoMo",
      "phone": "0241234567"
    }
  }]
}