Retrieve Income Data

Description: This endpoint is to retrieves income data for consenting customer.

baseUrl: https://demo.etranzact.com/drs-demo

merchant_Id: 20191103155772

Sample Request

Request Parameters

Field	Data Type	Required	Description
Reference	string	Yes	Unique request reference used to identify and track the request.
customer	object	Yes	Contains customer identification and consent details.
customer.bvn	string	Yes	Bank Verification Number (BVN) of the customer.
customer.accountNumber	string	Yes	Customer's bank account number.
customer.bankCode	string	Yes	Bank code identifying the financial institution (e.g., 058).
customer.isConsent	string	Yes	Indicates whether the customer has granted consent for the request. 1 = consent given.
Period	object	Yes	Defines the date range for the requested data.
period.from	date (YYYY-MM-DD)	Yes	Start date of the period for which information is being requested.
period.to	date (YYYY-MM-DD)	Yes	End date of the period for which information is being requested.

GET {baseurl}/api/v1/retrieve-data

curl `{baseurl}/api/v1/balance-enquiry`
 -H "x-Merchant-Id: your_merchant_id"
 -H "Authorization: Bearer Token"
 -H "Content-Type: application/json"
 -d '{
   "reference": "REQ-2026-05-11-001",
   "customer": {
      "bvn": "12345678901",
      "accountNumber": "2125347370",
      "bankCode": "058",
      "isConsent": "1"
   },
  "period": {
  "from": "2025-07-01",
  "to": "2026-07-30"
  }
}
'

Sample Response

Sample Success Response

POST {baseurl}/api/v1/retrieve-data

{
  "responseStatus": "SUCCESS",
  "responseMessage": "Successfully retrieved history",
  "responseCode": "00",
  "traceId": "899a8c71-bbcf-461a-a770-aeef0be76247",
  "data": {
    "incomeHistory": [
      {
        "amount": 100.78,
        "paymentDate": "2025-07-21T19:54:46",
        "source": "SWITCHIT_FT"
      },
      {
        "amount": 100.78,
        "paymentDate": "2025-07-21T19:54:37",
        "source": "SWITCHIT_FT"
      },
      {
        "amount": 100.78,
        "paymentDate": "2025-07-18T17:07:46",
        "source": "SWITCHIT_FT"
      },
      {
        "amount": 100.89,
        "paymentDate": "2025-07-11T19:31:54",
        "source": "SWITCHIT_FT"
      },
      {
        "amount": 100.89,
        "paymentDate": "2025-07-11T18:39:23",
        "source": "SWITCHIT_FT"
      },
      {
        "amount": 100.78,
        "paymentDate": "2025-07-11T18:02:54",
        "source": "SWITCHIT_FT"
      },
      {
        "amount": 100.89,
        "paymentDate": "2025-07-11T16:02:39",
        "source": "SWITCHIT_FT"
      }
    ],
    "reference": "REQ-2026-05-11-001",
    "summary": {
      "averageMonthlyIncome": 705.79,
      "paymentFrequency": "WEEKLY",
      "confidenceScore": 0.7
    }
  },
  "timestamp": "2026-05-18 11:02:21"
}