Get NPS Request-to-Pay Approvals

Overview

GetNpsRequestToPayApprovalsQuery returns a paginated list of inbound NPS Request-to-Pay approvals — these are pain.013 messages received from another bank asking our customer to approve or reject a payment.

Command Details

• Command: GetNpsRequestToPayApprovalsQuery
• Type: Query

API Endpoint

POST /api/bpm/cmd

Request Structure

Field	Type	Required	Description
pageNumber	int	No	Page number (default: 1)
pageSize	int	No	Records per page (default: 20)
status	string	No	Filter by decision status (e.g., "Pending", "Approved", "Rejected")
searchText	string	No	Search by account number, end-to-end ID, or name
startDate	string	No	Filter by requestReceivedAt ≥ this date (yyyy-MM-dd)
endDate	string	No	Filter by requestReceivedAt ≤ this date (yyyy-MM-dd)
isExport	bool	No	true to export all results as Excel

Try It Out

POST/api/bpm/cmdGetNpsRequestToPayApprovalsQuery

Base URL

Bearer Token

Request Body

{ "cmd": "GetNpsRequestToPayApprovalsQuery", "data": { "pageNumber": 1, "pageSize": 20, "isExport": false } }

Response Structure

{
  "isSuccessful": true,
  "statusCode": "00",
  "count": 1,
  "data": [
    {
      "id": 401,
      "paymentInformationId": "PMTINF-001",
      "endToEndId": "E2E-20260301-001",
      "debtorAccountNumber": "0123456789",
      "debtorName": "JOHN DOE",
      "debtorBankCode": "090114",
      "creditorAccountNumber": "9876543210",
      "creditorName": "ABC COMPANY",
      "creditorBankCode": "000014",
      "amount": 25000.00,
      "narration": "Invoice payment",
      "status": "Pending",
      "reasonCode": null,
      "expiryDateTime": "2026-03-02T08:00:00Z",
      "requestCreDtTm": "2026-03-01T08:00:00Z",
      "requestReceivedAt": "2026-03-01T08:00:05Z",
      "decisionedAt": null,
      "lastPain014SentAt": null,
      "lastPain014ResponseStatus": null
    }
  ]
}

Key Fields

Field	Description
paymentInformationId	pain.013 PmtInfId
endToEndId	End-to-end transaction reference
status	Pending → waiting for customer decision; Approved / Rejected → decided
expiryDateTime	When the request expires if not actioned
decisionedAt	When our customer made the decision
lastPain014SentAt	When the pain.014 response was last sent to the creditor bank
lastPain014ResponseStatus	HTTP/NPS status of the last pain.014 transmission

Related Operations

• Get Request-to-Pay Approval by ID — Full detail including raw XML flag
• NPS & NIP Payment Events — OnRequestToPayReceived (2600), OnRequestToPayDecided (2602)