NPS Management API
Overview​
The NPS Management API provides commands for querying and managing NPS (NIBSS Payment System) ISO 20022 data — mandates, inward direct debit requests, account report requests (CAMT), and Request-to-Pay approvals. It also exposes lifecycle actions (cancel, amend) for outward mandates.
All commands are sent via POST /api/bpm/cmd with a JSON body containing cmd (command name) and data (payload).
These commands operate on the NPS ISO 20022 data (MandateSetup, InwardDebitTransferRequest, NpsAccountReportRequest, NpsRequestToPayApproval tables in the Nibss database). They are distinct from the legacy NIBSS Pay Gateway commands (CreateNibssMandateCommand, etc.) which use a separate mandate table.
Available Commands​
| # | Command | Description | Type |
|---|---|---|---|
| 1 | GetNpsMandatesQuery | Paginated list of NPS ISO 20022 mandates | Query |
| 2 | GetNpsMandateByIdQuery | Full detail of a single NPS mandate with linked debit requests | Query |
| 3 | CancelNpsMandateCommand | Cancel an active outward NPS mandate (pain.011) | Command |
| 4 | AmendNpsMandateCommand | Amend an existing outward NPS mandate (pain.010) | Command |
| 5 | GetNpsInwardDebitRequestsQuery | Paginated list of NPS inward direct debit requests | Query |
| 6 | GetNpsInwardDebitRequestByIdQuery | Full detail of a single inward debit request | Query |
| 7 | GetNpsAccountReportRequestsQuery | Paginated list of CAMT account report requests | Query |
| 8 | GetNpsAccountReportRequestByIdQuery | Single account report request with linked CAMT records | Query |
| 9 | GetNpsRequestToPayApprovalsQuery | Paginated list of Request-to-Pay inbound approvals | Query |
| 10 | GetNpsRequestToPayApprovalByIdQuery | Full detail of a single Request-to-Pay approval | Query |
NPS Credit Transfers​
Outward and inward NPS credit transfers are handled by the existing transfer commands. Pass sourceProvider: "nps" to filter for NPS records:
RetrieveOutwardTransactionsListQuery— outbound NPS credit transfersRetrieveInwardTransactionsListQuery— inbound NPS credit transfers
Mandate Directions​
The MandateSetup table stores both mandates we originate and mandates received from other banks. The direction is determined by DestinationInstitutionCode:
| DestinationInstitutionCode | Direction | CanCancel | CanAmend |
|---|---|---|---|
| Equals our bank code | Inward (we are the debtor bank) | No | No |
| Different bank code | Outward (we initiated the mandate) | Yes (if Active/Pending) | Yes (if Active) |
Related Documentation​
- NPS & NIP Payment Events — Process trigger events fired for every NPS message
- NIBSS Mandates API — Legacy NIBSS Pay Gateway mandate commands
- NIBSS Collections API — NIBSS collection batch commands