Ruralpass API

Financial History

A farmer's current debt exposure and money‑movement footprint across Riwe and the partner network. Covers three sections: outstanding_loans, transaction_volume, and (optionally granted) wallet and socioeconomic_profile.

Section key Fee (NGN) Available to
outstanding_loans 20 bank
transaction_volume 20 bank
wallet 15 optional (admin‑granted)
socioeconomic_profile 20 optional (admin‑granted)

Request

curl -X POST https://api.riwe.io/v1/rupa/lookup \
  -H "X-API-KEY: rk_live_YOUR_SECRET" \
  -H "Content-Type: application/json" \
  -d '{ "rupa_id": "rp-7lif9u", "sections": ["outstanding_loans", "transaction_volume"] }'

outstanding_loans

Current debt across Riwe loans and loans reported by partner lenders — the key affordability / over‑indebtedness check before extending new credit.

"outstanding_loans": {
  "total_outstanding": 0,
  "currency": "NGN",
  "riwe_loans": [],
  "partner_loans": [],
  "data_as_of": "2026-07-03T12:02:54+00:00"
}
Field Description
total_outstanding Total current outstanding balance (Riwe + partner)
riwe_loans[] Outstanding Riwe‑platform loans
partner_loans[] Outstanding loans reported by other partners via /report
data_as_of Snapshot time

transaction_volume

Money‑movement summary over rolling windows, aggregating Riwe wallet activity and partner‑reported flows.

"transaction_volume": {
  "currency": "NGN",
  "sources": ["riwe_platform", "partner_network"],
  "summary": {
    "last_30_days":  { "total_received": 0, "total_sent": 0, "transaction_count": 0 },
    "last_90_days":  { "total_received": 0, "total_sent": 0, "transaction_count": 0 },
    "last_12_months":{ "total_received": 0, "total_sent": 0, "transaction_count": 0 }
  },
  "data_as_of": "2026-07-03T12:02:54+00:00"
}
Field Description
sources Where the flows come from (riwe_platform, partner_network)
summary.<window>.total_received / total_sent Inflows / outflows in the window
summary.<window>.transaction_count Number of transactions

wallet (optional)

If Riwe grants your account the wallet section, a lookup can include the farmer's Riwe wallet balance and recent activity summary. Requested the same way (add "wallet" to sections).

socioeconomic_profile (optional)

A derived socioeconomic view (household, assets, group memberships, and related signals) where granted. Add "socioeconomic_profile" to sections.

Typical use

  • Bank — before lending, read credit_history + outstanding_loans + transaction_volume for a full affordability picture, then report the disbursement and repayments back so the shared record stays accurate.
Base URL https://api.riwe.io/v1/rupa  ·  Ruralpass home  ·  Powered by Riwe