Get Request-to-Pay Approval by ID

Overview

GetNpsRequestToPayApprovalByIdQuery retrieves the full detail of a single inbound NPS Request-to-Pay approval record.

Command Details

• Command: GetNpsRequestToPayApprovalByIdQuery
• Type: Query

API Endpoint

POST /api/bpm/cmd

Request Structure

Field	Type	Required	Description
id	int	Yes	Internal ID of the Request-to-Pay approval record

Try It Out

POST/api/bpm/cmdGetNpsRequestToPayApprovalByIdQuery

Base URL

Bearer Token

Request Body

{ "cmd": "GetNpsRequestToPayApprovalByIdQuery", "data": { "id": 401 } }

Response Structure

{
  "isSuccessful": true,
  "statusCode": "00",
  "data": {
    "id": 401,
    "paymentInformationId": "PMTINF-001",
    "requestMessageId": "MSG-20260301-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": "Approved",
    "reasonCode": null,
    "expiryDateTime": "2026-03-02T08:00:00Z",
    "requestCreDtTm": "2026-03-01T08:00:00Z",
    "requestReceivedAt": "2026-03-01T08:00:05Z",
    "decisionedAt": "2026-03-01T09:30:00Z",
    "lastPain014SentAt": "2026-03-01T09:30:05Z",
    "lastPain014ResponseStatus": "Success",
    "hasRawXml": true
  }
}

Additional Fields vs List

Field	Description
requestMessageId	GrpHdr MsgId from the original pain.013
hasRawXml	true if the raw pain.013 XML is stored in the database

Related Operations

• Get NPS Request-to-Pay Approvals — Search and list all RTP approvals