{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"54c10c22-f214-4c1e-b805-17bdf2c635d9","name":"Edfapay New System","description":"## **EdfaPay Payment Gateway APIs**\n\nThis Postman collection provides a complete set of APIs to integrate with the **EdfaPay Payment Gateway**, enabling businesses to securely accept and manage online payments.\n\nEdfaPay is a unified payment platform that supports multiple integration methods, including **Hosted Checkout** and **Server-to-Server (S2S)**, allowing merchants to choose between ease of use and full control over the payment experience.\n\n---\n\n## **What This Collection Covers**\n\nThis collection includes APIs for:\n\n- Payment initiation (Hosted Checkout)\n    \n- Server-to-Server (S2S) direct payment processing\n    \n- Transaction operations (capture, refund, void)\n    \n- Recurring payments\n    \n- Payment status tracking\n    \n\n---\n\n## **Integration Types**\n\n### **Checkout Integration**\n\nA redirect-based flow where EdfaPay handles the payment UI, security, and compliance.\n\n### **Server-to-Server (S2S)**\n\nA full backend integration where merchants directly interact with APIs and manage the entire checkout experience.\n\n---\n\n## **Authentication**\n\nAll API requests must include a valid API key in the request header:\n\n```\nX-API-KEY: <Your API Key>\n\n ```\n\n### **Sandbox API Key (Testing Only)**\n\n```\nX-API-KEY: BF15E34275189913593F283D691E39C5849B514E41C8E7D6ACA8BB99319C08C2\n\n ```\n\n---\n\n## **Important Notes**\n\n- This key works **only in the sandbox environment**\n    \n- It will **NOT work in production**\n    \n- Intended for **testing and evaluation purposes only**\n    \n- Subject to **rate limiting, monitoring, and rotation**\n    \n- **Do NOT expose** this key in client-side applications\n    \n\nFor production usage, generate your own API key from the EdfaPay dashboard.\n\n---\n\n## **Environments**\n\n### **Sandbox (Demo Only)**\n\n```\nhttps://demo-api.edfapay.com\n\n ```\n\nUse this environment for all testing and validation.\n\n---\n\n### **Production**\n\n```\nhttps://app-api.edfapay.com\n\n ```\n\nSwitch to this URL when going live.\n\n---\n\n## **Best Practices**\n\n- Always test in the sandbox environment before going live\n    \n- Use **unique order IDs** for each transaction\n    \n- Configure **webhooks** to receive payment updates\n    \n- Ensure **PCI compliance** when handling card data in S2S integrations\n    \n\n---","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"28471702","team":15038872,"collectionId":"54c10c22-f214-4c1e-b805-17bdf2c635d9","publishedId":"2sBXitD81E","public":true,"publicUrl":"https://documenter-api.postman.tech/view/28471702/2sBXitD81E","privateUrl":"https://go.postman.co/documentation/28471702-54c10c22-f214-4c1e-b805-17bdf2c635d9","customColor":{"top-bar":"FFFFFF","right-sidebar":"0F1720","highlight":"00E6A0"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":"Integrate EdfaPay API v2 for secure payments via Hosted Checkout, Embedded S2S, Payment Gateway, and SoftPOS. Includes authentication, Apple Pay, transaction flows (auth, capture, refund, void), webhooks, and real-time processing for web and mobile apps."},{"name":"title","value":"EdfaPay API v2 – Checkout, S2S Payment Gateway &amp; SoftPOS Integration"}],"appearance":{"default":"light","themes":[{"name":"dark","logo":"https://content.pstmn.io/a2398f54-1f15-417d-8ab9-4f64e824d2fe/RWRmYXBheTEuanBn","colors":{"top-bar":"001B11","right-sidebar":"0F1720","highlight":"00E6A0"}},{"name":"light","logo":"https://content.pstmn.io/49ef59be-6ce0-480c-98b1-546bf3c94dfe/aW1hZ2VzLnBuZw==","colors":{"top-bar":"FFFFFF","right-sidebar":"0F1720","highlight":"00E6A0"}}]}},"version":"8.10.1","publishDate":"2026-04-15T17:54:51.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"EdfaPay API v2 – Checkout, S2S Payment Gateway &amp; SoftPOS Integration","description":"Integrate EdfaPay API v2 for secure payments via Hosted Checkout, Embedded S2S, Payment Gateway, and SoftPOS. Includes authentication, Apple Pay, transaction flows (auth, capture, refund, void), webhooks, and real-time processing for web and mobile apps."},"logos":{"logoLight":"https://content.pstmn.io/49ef59be-6ce0-480c-98b1-546bf3c94dfe/aW1hZ2VzLnBuZw==","logoDark":"https://content.pstmn.io/a2398f54-1f15-417d-8ab9-4f64e824d2fe/RWRmYXBheTEuanBn"}},"statusCode":200},"environments":[{"name":"Revamp","id":"cda36749-d5f3-4fe3-a6ec-65990516f94a","owner":"28471702","values":[{"key":"API Key","value":"","enabled":true,"type":"default"},{"key":"operation_hash","value":"","enabled":true,"type":"any"},{"key":"base_url","value":"","enabled":true,"type":"default"},{"key":"email","value":"","enabled":true,"type":"default"},{"key":"merchant_id","value":"","enabled":true,"type":"any"},{"key":"fullName","value":"","enabled":true,"type":"any"},{"key":"mobileNumber","value":"","enabled":true,"type":"any"},{"key":"session_hash","value":"","enabled":true,"type":"any"},{"enabled":true,"key":"bearer_token","value":"","type":"default"}],"published":true}],"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/3b34c221633b640a9770c6542fce0359716fbbf473b773af0e69f08d189a9c22","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"},{"label":"Revamp","value":"28471702-cda36749-d5f3-4fe3-a6ec-65990516f94a"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/2sBXitD81E"}