{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"6f6d334c-4923-44ca-a683-60614b144c6d","name":"NifiPayments-collection","description":"\"\"\n\n## **Introduction**\n\nThe API is built using RESTful endpoints and standard HTTP verbs.\n\n1. Response codes are used to indicate the status of the message and any error codes.\n \n2. JSON is returned on all our API responses, including errors, with a consistent structure for all messages.\n \n3. Authentication to the API is performed via Header based pair of api and encryption keys.\n \n4. All request and responses body should be encrypted with Advanced Encryption Standard and Cipher Block Chaining and key size will be 256 bit. cipher algorithm AES-256-CBC.\n \n5. Requests to our API should be made as Encrypted Body JSON, except when uploading documents.\n \n6. All API requests must be made over HTTPS. Calls made over plain HTTP will fail.\n \n7. All API requests must be expect a valid resource , so without a whitelisted IP you will not be able to access the api's. its mendotory for both Envoirements Production or UAT.\n \n8. All requests must use TLS 1.2 or above, with Server Name Indication enabled\n \n9. Text fields support UTF-8, but do not allow certain special characters that could be used maliciously.\n \n\n## API Status\n\nStatus for the API can be found at [developers.nifipayments.com](https://developers.nifipayments.com)!\n\n# Getting Started\n\n**NifiPayment's** API exposes the entire Business , Banking , KYC and travel infrastructure via a standardized programmatic interface. Using **Nifipayment's** API, you can avail all of our services, while using your programming language of choice. The **Nifipayment's** API is a RESTful API based on HTTP requests and JSON responses.\n\nThis version of the API, version 1. All requests work on HTTPS.\n\nThe easiest way to start using the **Nifipayment's** API is by clicking the **Run in Postman** button above. [Postman](https://www.getpostman.com/) is a free tool which helps developers run and debug API requests, and is the source of truth for this documentation. Every endpoint you see documented here is readily available by running our Postman collection.\n\n## Need help?\n\nThe **Nifipayment's** engineers are always around answering questions. The quickest way to get help is by contacting us at [developers@nifipayments.com](https://mailto:developers@nifipayments.com)\n\nAll the resources require Token Authentication. So all requests have to be provided with a header along with the client id and api-key\n\n```\nAccept:application/json\nContent-Type:application/json\nx-client-id:e26c92xxxxxxxxxxxxxxxxxxxxx4797c8e42d\nx-api-key:e99e31bbdxxxxxxxxxxxxxxxxxxxxxx877b20eb15a0\n\n ```\n\n### Registration Quickstart\n\nTo get a token for staging and then subsequently for production contact us at - [developers@nifipayments.com](https://mailto:developers@nifipayments.com)\n\n## Trial Usage\n\nThe Aadhaar API provides a trial for 3 days with a usage limit of 50 requests. Contact us at [developers@nifipayments.com](https://mailto:developers@nifipayments.com) to start your trial.\n\n# Endpoints\n\nThe API is accessed by making HTTP requests to a specific version endpoint URL, in which GET or POST variables contain information about what you wish to access. Every endpoint is accessed via an SSL-enabled HTTPS.\n\nEverything (methods, parameters, etc.) is fixed to a version number, and every call must contain one. Different Versions are available at different endpoint URLs. The latest version is Version 1.\n\nThe stable HTTP endpoint for the latest version is:\n\n```\n`https://nifipayment.online` For UAT purpose only\n\n ```\n\n## Responses\n\nEach response is wrapped in a data tag. This means if you have a response, it will always be within the data field. We also include a status code, success flag, type and message in the responseof each request.\n\n``` json\n{\n \"body\" : \"b57920b1675663201b6298c17bd4d156d8205251ee5f9ff63b0d5b5b8013d20f45cfa8c610bf113384730433ec512e60b49135adcf41e523964570e900ca8ffa\"\n}\n\n ```\n\n# Authentication\n\nThe API uses token-based authentication. You will be provided with a token which must be included in the header of all requests made to the API.\n\nAll API requests must be made over HTTPS. Any requests made over HTTP will fail.\n\nYou will be provided with both live and sandbox tokens. Requests made with the sandbox token can be used to test our API before going live. Requests made in sandbox-mode will return actual responses and trial credits capped at 50 will be deducted from your account.\n\n```\nAccept:application/json\nContent-Type:application/json\nx-client-id:e26c92xxxxxxxxxxxxxxxxxxxxx4797c8e42d\nx-api-key:e99e31bbdxxxxxxxxxxxxxxxxxxxxxx877b20eb15a0\n\n ```\n\n# Errors and Status Codes\n\nStandard HTTP error codes are returned in the case of a failure. 2xx codes indicate a successful message; 4xx codes indicate an error caused by information provided by the client; and 5xx codes indicate an error on AadhaarKYC’s servers.\n\n## Status Codes\n\n| Status Codes | Name | Meaning |\n| --- | --- | --- |\n| 200 | OK | Successful Request. |\n| 201 | Created | Resource successfully created. |\n| 202 | Accepted | Asynchronous Request. Response will be sent to configured Webhook. |\n| 204 | No Content | Successful with no Response. |\n\n## Error Codes\n\n| Error Code | Name | Meaning |\n| --- | --- | --- |\n| 400 | Bad Request | Malformed request |\n| 401 | Unauthorized | Invalid authorization credentials |\n| 403 | Forbidden | Action prohibited |\n| 404 | Not Found | Resource not found |\n| 422 | Unprocessable Entity | Validation error |\n| 429 | Too Many Requests | Rate limit reached |\n| 500 | Internal Server Error | An unexpected error occurred in our API |\n\n# Rate Limits\n\n**Nifipayment's** API enforces a maximum volume of requests per minute for all clients. Unless contractually agreed otherwise, the maximum rate is 100 requests per minute.\n\nAny request over the limit will return a 429 HTTP response.\n\n## Avoiding the limit\n\nThe tips below are some simple suggestions to help reduce the possibility of being rate limited. We recommend:\n\n1. running non essential or routine batch API jobs outside your peak hours.\n \n2. throttling batch jobs.\n \n3. implementing an exponential back-off approach for requests essential to your verification process, with an initial delay of 30 seconds.\n \n4. prioritising requests that are essential to verify an active user.\n \n5. setting up monitors and alerts for error responses on our API.\n \n\n## API Deprecation\n\nWhen an API endpoint is scheduled for deprecation the following actions will be taken:\n\n1. The endpoint documentation will be marked as deprececated and a migration plan will be added.\n \n2. The endpoint will have a `Sunset` header ([Sunset HTTP Header](https://tools.ietf.org/id/draft-wilde-sunset-header-03.html)) added to incidate the last date the endpoint should be relied upon.\n \n3. A email will be sent to active third party developers notifing of the deprecation.\n \n4. A entry to the API changelog table will be added.\n \n\nWhen the `Sunset` date has passed followup email will be sent to active third party developers notifing of the deprecation.\n\n## Backwards Compatibility\n\nThe following changes are considered backwards compatible:\n\n1. Adding new API endpoints.\n \n2. Adding new properties to the responses from existing API endpoints.\n \n3. Adding optional request parameters to existing API endpoints.\n \n4. Altering the format or length of IDs.\n \n5. Altering the message attributes returned by validation failures or other errors.\n \n6. Sending webhooks for new event types.\n \n7. Reordering properties returned from existing API endpoints.\n \n\n# API Changelog\n\n| Date Introduced | Available Until | Endpoint/ Resource Group |\n| --- | --- | --- |\n| 15-02-2019 | \\- | [Vehicle RC](#rc-model) |\n| 12-02-2019 | \\- | [Webhooks](#events-model) |\n| 11-02-2019 | \\- | [Aadhaar v2](#aadhaar-v2-model) |\n| 10-02-2019 | \\- | [Aadhaar Validation](#aadhaar-validation-model) |\n\n## Additional Information\n\nIf you have questions that aren't answered here, contact the Support Team - [developers@nifipayments.com](https://mailto:developers@nifipayments.com).","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"28319229","team":6512231,"collectionId":"6f6d334c-4923-44ca-a683-60614b144c6d","publishedId":"2sAYJ7gzNN","public":true,"publicUrl":"https://developers.nifipayment.com","privateUrl":"https://go.postman.co/documentation/28319229-6f6d334c-4923-44ca-a683-60614b144c6d","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.10.1","publishDate":"2025-01-02T07:49:42.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/f971842be1bbbc4e675660a4ee989ddea6b46313d111e5a6cc1090ca1d78c774","favicon":"https://nifipayment.com/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://developers.nifipayment.com/view/metadata/2sAYJ7gzNN"}