๐๏ธ 1. Introduction
1.1 BACKGROUND
๐๏ธ 2. API Security
2.1 API Authentication and Authorization
๐๏ธ 3.Account Validation
Account validation is used for validating creditor/beneficiary account before initiating the actual financial transaction. Validating creditor account beforehand reduces the transactions rejection ratio. After the account is validated the actual fund transfer APIs are required to be called. It validates the existence of the account, status and account name match details etc. Additionally, the account name validation ensures beneficiary Know Your Customer (KYC) requirement while sending the remittance transactions from different jurisdiction of across the globe. This section describes the required information for account validation through NPI.
๐๏ธ 4.Real Time Transaction Posting API
This API is used for posting remittance fund transfer transaction in Real-Time Payment System in real time basis. Since the nature of transaction is real time, this method can contain only single transaction in a batch. The execution of both debit and credit legs happens in a real time and provides the response accordingly within a single session.
๐๏ธ 5. Non-Real Time Remittance Posting API
This API is used for posting the Non-Real time Remittance Fund transfer transactions through NCHL-IPS System. It handles both one to one and batch-based credit transactions .The debit of the payment batch shall be executed instantly however the credit leg shall be done in deferred basis. And once the debit is successful, transaction will be posted to NCHL-IPS system for credit legs by a batch process.
๐๏ธ 6. Transaction Reporting APIs
For reporting and reconciliation of the transactions which are processed through NPI, the following APIs will be provided. These APIs will also require the access token to access the resources and the token generation process will be same as for the transaction processing.
๐๏ธ 7.Annexure
Below are the lists of other supporting APIs to extract the list and/or setups from the core system.
๐๏ธ 8.Handling of Response Codes
Following are the list of response codes used in NPI that could be technical and business. HTTP Reason codes OK, FORBIDDEN, BAD REQUEST and INTERNAL SERVER ERROR are exceptional cases which requires the exact technical setups and message structures mentioned in the document. These HTTP statuses contain same response message format as mentioned below with response code. All technically valid messages will be responded with HTTP status OK which has a fixed format and doesnโt change.