Skip to main content

Get Inward Debit Request by ID

Overview​

GetNpsInwardDebitRequestByIdQuery retrieves the full detail of a single NPS inward direct debit request including BVN, KYC level, and reversal information.

Command Details​

  • Command: GetNpsInwardDebitRequestByIdQuery
  • Type: Query

API Endpoint​

POST /api/bpm/cmd

Request Structure​

FieldTypeRequiredDescription
idintYesInternal ID of the inward debit request

Try It Out​

POST/api/bpm/cmdGetNpsInwardDebitRequestByIdQuery
Request Body

Response Structure​

{
"isSuccessful": true,
"statusCode": "00",
"data": {
"id": 501,
"sessionID": "SESS-20260201-001",
"mandateReferenceNumber": "MND0000000001",
"debitAccountName": "JOHN DOE",
"debitAccountNumber": "0123456789",
"debitBankVerificationNumber": "12345678901",
"debitKYCLevel": "3",
"beneficiaryAccountName": "ABC COMPANY",
"beneficiaryAccountNumber": "9876543210",
"beneficiaryBankVerificationNumber": "98765432101",
"beneficiaryKYCLevel": "3",
"originatorAccountName": "ABC COMPANY",
"originatorAccountNumber": "9876543210",
"originatorBankVerificationNumber": "98765432101",
"originatorKYCLevel": "3",
"narration": "Loan repayment",
"amount": 50000.00,
"transactionFee": 50.00,
"status": "Successful",
"responseCode": "00",
"responseDescription": "Approved",
"receiveResponseCode": "00",
"transactionTimeStamp": "2026-02-01T08:00:00Z",
"transactionId": "TXN123456",
"paymentReference": "PAY123456",
"destinationInstitutionCode": "090114",
"channelCode": "1",
"transactionLocation": null,
"sourceProvider": "nps",
"reversalAdviseSessionId": null,
"reversalAdviseTimeStamp": null
}
}

Additional Fields vs List​

FieldDescription
debitBankVerificationNumberDebtor BVN
debitKYCLevelDebtor KYC tier
beneficiaryBankVerificationNumberBeneficiary BVN
beneficiaryKYCLevelBeneficiary KYC tier
originatorBankVerificationNumberOriginator BVN
originatorKYCLevelOriginator KYC tier
destinationInstitutionCodeOur bank code (we are the destination/debtor)
channelCodeNPS channel code
transactionLocationPhysical location if provided
reversalAdviseSessionIdSession ID of the reversal, if reversed
reversalAdviseTimeStampTimestamp of reversal