Skip to main content

Retrieve Remita Loan Request by ID

Overview​

Retrieves detailed information about a specific loan request by its ID, including borrower details, bank details, loan terms, all status fields, and mandate information.

Migration note

This command replaces /api/Remitta/application?ApplicationId={id} from the original lending service. The response closely mirrors the original SalaryInformationRequestDTO, with alternate field names provided where the naming has changed.

Command Details​

  • Command: RetrieveRemitaLoanRequestByIdQuery
  • Type: Query

API Endpoint​

POST /api/bpm/cmd

Request Structure​

FieldTypeRequiredDescription
idlongYesID of the loan request to retrieve

Try It Out​

POST/api/bpm/cmdRetrieveRemitaLoanRequestByIdQuery
Request Body

Response Fields​

Customer & Account​

FieldAlternate NameDescription
id—Internal DB record ID
requestId—Remita request ID (format: {ts}/{ts}). Equivalent to RequestId in original
cif—Core Banking CIF number
accountNumber—Borrower's account number
accountNamecustomerNameBorrower's full name. Both keys returned
bvn—Bank Verification Number
phoneNumber—Borrower's phone number
email—Borrower's email address
remitaCustomerIdcustomerIdRemita customer ID (e.g. "10696857"). Equivalent to MandateCustomerRefId / CustomerRefId in original

Bank Details​

FieldAlternate NameDescription
bankCode—Borrower's bank code (e.g. "058" for GTBank)
bankName—Borrower's bank name. Stored at loan creation time. Equivalent to BankName in original DTO

Employer / Processing Company​

FieldAlternate NameDescription
companyName—Employer/company name from Remita
employerRegistrationNumber—Company registration number
organisationIdprocessingCompanyIdBankLingo processing organisation ID. Equivalent to BankLingoCompanyCode in original
organisationNameprocessingCompanyNameBankLingo processing organisation name. Equivalent to BankLingoCompanyName in original
location—Employer office location (e.g. "LAGOS COMM II"). Equivalent to LoanApplication.Location in original
referral—Referring officer name (e.g. "ADEYANJU ZAINAB"). Equivalent to LoanApplication.Referral in original

Loan Financial Details​

FieldAlternate NameDescription
loanAmount—Total approved loan amount
collectionAmountamountPerRepaymentMonthly repayment amount. Both keys returned. Equivalent to AmountPerRepayment / CollectionAmount in original
previousOutstandingAmountoutstandingLoanAmountOutstanding balance before this loan (used as penalty fee in disbursement). Equivalent to PreviousOutstandingAmount in original
interestRate—Annual interest rate
currencyCode—Currency (e.g. "NGN")
loanType—Loan type classification

Repayment Schedule​

FieldAlternate NameDescription
tenurenumberOfRepaymentsNumber of repayments. Both keys returned. Equivalent to NoOfRepayments / LoanTenor in original
tenorType—Tenor type enum value
tenorTypeDesc—Human-readable tenor type

Mandate Details​

FieldDescription
mandateReferenceRemita mandate reference
mandateCodeInternal mandate code

Status Fields​

Status field mapping from original

The original API returned three separate status strings. This response returns all of them with matching alias names for drop-in compatibility.

FieldAlternate NameOriginal EquivalentExample Value
statusDescstatusStrstatusStr — general application status"Processed" / "Pending"
mandateActivationStatusDescmandateActivationStrmandateActivationStr"Mandate Activated" / "Not Activated"
loanDisbursementStatusDescmandateLoanDisbursementStrmandateLoanDisbursementStr"Disbursed" / "Pending Disbursement"

Loan Account & Disbursement​

FieldDescription
loanAccountCore banking loan account number
disbursementChannelDisbursement channel enum value
disbursementChannelDescHuman-readable disbursement channel
disbursementReferenceDisbursement transaction reference
disbursementResponseMessageCBS response message from disbursement
disbursementDateDate and time of disbursement

Audit Fields​

FieldDescription
initiatedByStaff who initiated the loan
approvedByStaff who approved the loan
approvalDateApproval timestamp
approvalCommentApproval/rejection comment
statusMessageProcessing status message. Equivalent to StatusMessage in original
createdAtapplicationDate — record creation date. Both keys returned
tagCustom tag for categorisation
collectionBatchLinked batch details (if batch loan)

Sample Response​

{
  "isSuccessful": true,
  "statusCode": "00",
  "message": "Loan request retrieved.",
  "data": {
    "id": 5001,
    "requestId": "1742649600000/1742649600000",
    "cif": "CIF-001234",
    "accountNumber": "0012345678",
    "accountName": "John Doe",
    "customerName": "John Doe",
    "bvn": "22345678901",
    "phoneNumber": "08012345678",
    "email": "john@example.com",
    "remitaCustomerId": "10696857",
    "customerId": "10696857",
    "bankCode": "058",
    "bankName": "Guaranty Trust Bank",
    "companyName": "Acme Industries Ltd",
    "organisationId": 12,
    "processingCompanyId": 12,
    "organisationName": "BankLingo Finance",
    "processingCompanyName": "BankLingo Finance",
    "location": "LAGOS COMM II",
    "referral": "ADEYANJU ZAINAB",
    "loanAmount": 5000000.00,
    "collectionAmount": 416666.67,
    "amountPerRepayment": 416666.67,
    "previousOutstandingAmount": 250000.00,
    "outstandingLoanAmount": 250000.00,
    "interestRate": 18.5,
    "tenure": 12,
    "numberOfRepayments": 12,
    "tenorType": 1,
    "tenorTypeDesc": "Monthly",
    "mandateReference": "REM-MND-2026-0042",
    "status": 4,
    "statusDesc": "Disbursed",
    "statusStr": "Disbursed",
    "mandateActivationStatus": 1,
    "mandateActivationStatusDesc": "Mandate Activated",
    "mandateActivationStr": "Mandate Activated",
    "loanDisbursementStatusDesc": "Disbursed",
    "mandateLoanDisbursementStr": "Disbursed",
    "loanAccount": "LA-0012345678",
    "disbursementDate": "2026-01-17T14:00:00Z",
    "initiatedBy": "Admin-John(admin.john)",
    "approvedBy": "Manager-Jane(mgr.jane)",
    "approvalDate": "2026-01-16T09:00:00Z",
    "createdAt": "2026-01-15T10:30:00Z",
    "applicationDate": "2026-01-15T10:30:00Z",
    "collectionBatch": null
  }
}