Get Remita Salary History
Overview​
Returns the salary payment history for a borrower from the Remita platform. This query is used to verify a borrower's salary flow before creating or approving a loan request.
Command Details​
- Command:
GetRemitaSalaryHistoryQuery - Type: Query
API Endpoint​
POST /api/bpm/cmd
Request Structure​
| Field | Type | Required | Description |
|---|---|---|---|
firstName | string | No | Borrower's first name |
lastName | string | No | Borrower's last name |
middleName | string | No | Borrower's middle name |
accountNumber | string | No | Borrower's bank account number |
bankCode | string | No | CBN bank code |
bvn | string | No | Bank Verification Number |
phoneNumber | string | No | Borrower's phone number |
useMobileNumberForSearch | bool | No | Search by mobile number instead of BVN (default: false) |
authorisationChannel | string | No | Authorisation channel (default: "USSD") |
authorisationCode | string | No | Remita authorisation code |
Try It Out​
POST
/api/bpm/cmdGetRemitaSalaryHistoryQueryRequest Body
Response Structure​
{
"success": true,
"data": {
"bvn": "22345678901",
"employerName": "Acme Corporation",
"salaryHistory": [
{
"paymentDate": "2026-02-25",
"amount": 450000.00,
"accountNumber": "0012345678",
"bankCode": "058"
},
{
"paymentDate": "2026-01-25",
"amount": 450000.00,
"accountNumber": "0012345678",
"bankCode": "058"
}
],
"averageSalary": 450000.00,
"recordCount": 2
},
"message": "Salary history retrieved successfully"
}
Related Operations​
- Create Loan Request — Create a loan after verifying salary history
- Approve Loan — Use salary history to inform approval decisions
- Get Payment History — View repayment history for an existing loan