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.

The command supports three mutually exclusive search modes — supply the primary identifier for exactly one mode per call.

Command Details

• Command: GetRemitaSalaryHistoryQuery
• Type: Query

API Endpoint

POST /api/bpm/cmd

Search Modes

Mode 1 — By Account Number + Bank Code

The default mode. Pass the borrower's NUBAN account number and their bank's CBN code.

{
  "cmd": "GetRemitaSalaryHistoryQuery",
  "data": {
    "accountNumber": "0123456789",
    "bankCode": "057"
  }
}

Field	Type	Required	Description
accountNumber	string	Yes	Borrower's NUBAN account number
bankCode	string	Yes	CBN bank code (e.g. "057" for Zenith)
authorisationCode	string	No	Remita authorisation code
authorisationChannel	string	No	Default: "USSD"

---

Mode 2 — By BVN

Use when the account number alone is insufficient or you have the BVN. Providing name and account details alongside the BVN improves Remita match accuracy.

{
  "cmd": "GetRemitaSalaryHistoryQuery",
  "data": {
    "bvn": "22163699922",
    "accountNumber": "0123456789",
    "bankCode": "057",
    "firstName": "John",
    "lastName": "Doe",
    "middleName": "A"
  }
}

Field	Type	Required	Description
bvn	string	Yes	Bank Verification Number (11 digits)
accountNumber	string	Recommended	Borrower's account number
bankCode	string	Recommended	CBN bank code
firstName	string	Recommended	Improves Remita match accuracy
lastName	string	Recommended	Improves Remita match accuracy
middleName	string	No	Improves Remita match accuracy
authorisationCode	string	No	Remita authorisation code
authorisationChannel	string	No	Default: "USSD"

---

Mode 3 — By Phone Number

Use when only the borrower's mobile number is available. Must set useMobileNumberForSearch: true.

{
  "cmd": "GetRemitaSalaryHistoryQuery",
  "data": {
    "phoneNumber": "08012345678",
    "useMobileNumberForSearch": true
  }
}

Field	Type	Required	Description
phoneNumber	string	Yes	Borrower's mobile number
useMobileNumberForSearch	bool	Yes	Must be true to activate this mode
authorisationCode	string	No	Remita authorisation code
authorisationChannel	string	No	Default: "USSD"

---

Full Field Reference

Field	Type	Description
firstName	string	Borrower's first name (Mode 2 recommended)
lastName	string	Borrower's last name (Mode 2 recommended)
middleName	string	Borrower's middle name (Mode 2 optional)
accountNumber	string	NUBAN account number (Mode 1 required, Mode 2 recommended)
bankCode	string	CBN bank code (Mode 1 required, Mode 2 recommended)
bvn	string	Bank Verification Number — activates Mode 2
phoneNumber	string	Mobile number — used in Mode 3
useMobileNumberForSearch	bool	Set true to activate Mode 3 (default: false)
authorisationChannel	string	Remita auth channel (default: "USSD")
authorisationCode	string	Remita authorisation code

Try It Out

POST/api/bpm/cmdGetRemitaSalaryHistoryQuery

Base URL

Bearer Token

Request Body

{ "cmd": "GetRemitaSalaryHistoryQuery", "data": { "accountNumber": "0012345678", "bankCode": "058", "authorisationChannel": "USSD" } }

Response Structure

All three modes return the same response shape.

{
  "isSuccessful": true,
  "statusCode": "success",
  "message": "Salary history retrieved.",
  "data": {
    "customerName": "John A. Doe",
    "companyName": "Acme Corporation",
    "customerId": "REM-CUST-001",
    "salaryPaymentDetails": [
      {
        "paymentDate": "2026-02-25",
        "amount": 450000.00,
        "accountNumber": "0012345678",
        "bankCode": "058"
      },
      {
        "paymentDate": "2026-01-25",
        "amount": 450000.00,
        "accountNumber": "0012345678",
        "bankCode": "058"
      }
    ],
    "loanHistoryDetails": [
      {
        "loanProvider": "BankLingo MFB",
        "loanAmount": 200000.00,
        "outstandingAmount": 80000.00,
        "repaymentStatus": "Active"
      }
    ]
  }
}

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