{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"3b95320a-c157-416c-828f-1d4897dfad88","name":"IPS API Standards (IPS for FIs version) - v1.0","description":"Welcome to the IPS API Reference Guide, your comprehensive resource for understanding and integrating with the Instant Payment System (IPS), designed to facilitate secure, efficient, and real-time financial transactions. IPS serves as the bridge between various national banks, offering RESTful APIs for easy connectivity and fund transfers.\n\nThis guide provides detailed insights into the diverse range of APIs that offers to empower both financial institutions and their end-users.\n\nThis document is structured to assist developers, financial institutions, and service providers in successfully integrating with IPS. Whether you are a bank seeking interoperability with other financial entities, a developer creating seamless payment experiences, or an end-user with diverse banking needs, this guide offers comprehensive explanations of how IPS APIs work, ensuring that you can harness the full potential of the system.\n\n## Authentication\n\nThe IPS API uses Bearer Token Authentication for FIs.\n\n### Authentication error response\n\nIf an Token is missing, malformed, or invalid, you will receive an HTTP **401 Unauthorized** response code.\n\n## Rate and usage limits\n\nAPI access rate limits apply at a per-API key basis in unit time. The limit is 300 requests per minute. Also, depending on your plan, you may have usage limits. If you exceed either limit, your request will return an HTTP 429 Too Many Requests status code.\n\nEach API response returns the following set of headers to help you identify your use status:\n\n| Header | Description |\n| --- | --- |\n| `X-RateLimit-Limit` | The maximum number of requests that the consumer is permitted to make per minute. |\n| `X-RateLimit-Remaining` | The number of requests remaining in the current rate limit window. |\n| `X-RateLimit-Reset` | The time at which the current rate limit window resets in UTC epoch seconds. |\n\n## Internal Error Codes\n\nIn an Error event, The API response will return the error in the following format in the response body:\n\n``` json\n{\n    \"errors\": {\n        \"code\": \"[ERROR CODE XXX-XXX]\",\n        \"message\": \"[ERROR DESCRIPTION]\"\n    }\n}\n\n ```\n\nEach API response returns the following set of Error codes to help you identify your use status:\n\n| Code | Description |\n| --- | --- |\n| `TNX-XXX` | Errors related to transactions |\n| `SWT-XXX` | Errors related to Switch configuration |\n| `VAL-XXX` | All errors related to validations (Fileds names, invalid request body, etc) |\n| `AUT-XXX` | Authentication errors |","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"30951400","team":5760702,"collectionId":"3b95320a-c157-416c-828f-1d4897dfad88","publishedId":"2sA3JGfjN7","public":true,"publicUrl":"https://documenter-api.postman.tech/view/30951400/2sA3JGfjN7","privateUrl":"https://go.postman.co/documentation/30951400-3b95320a-c157-416c-828f-1d4897dfad88","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"426ff5"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":"Access the official LYPay API Version 1.0 documentation, the final release for seamless integration with Libya’s instant payment system. Explore detailed API specifications and integration guidelines for financial institutions and developers."},{"name":"title","value":"LYPay API Version 1.0 - Instant Payment System API Documentation"}],"appearance":{"default":"light","themes":[{"name":"dark","logo":"https://content.pstmn.io/f347f360-55b7-42fb-a70c-7ce8e797a223/dGhlLWNlbnRyYWwtYmFuay1vZi1saWJ5YS1sb2dvLnBuZw==","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"426ff5"}},{"name":"light","logo":"https://content.pstmn.io/f347f360-55b7-42fb-a70c-7ce8e797a223/dGhlLWNlbnRyYWwtYmFuay1vZi1saWJ5YS1sb2dvLnBuZw==","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"426ff5"}}]}},"version":"8.10.1","publishDate":"2024-09-18T18:15:12.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"LYPay API Version 1.0 - Instant Payment System API Documentation","description":"Access the official LYPay API Version 1.0 documentation, the final release for seamless integration with Libya’s instant payment system. Explore detailed API specifications and integration guidelines for financial institutions and developers."},"logos":{"logoLight":"https://content.pstmn.io/f347f360-55b7-42fb-a70c-7ce8e797a223/dGhlLWNlbnRyYWwtYmFuay1vZi1saWJ5YS1sb2dvLnBuZw==","logoDark":"https://content.pstmn.io/f347f360-55b7-42fb-a70c-7ce8e797a223/dGhlLWNlbnRyYWwtYmFuay1vZi1saWJ5YS1sb2dvLnBuZw=="}},"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/6e6b98b4981c7b7bdbadb98e09999bc9826f3656d1fdd5b776edb6617b911ec4","favicon":""},"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://documenter.gw.postman.com/view/metadata/2sA3JGfjN7"}