{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"81083972-8ba2-4d43-b05a-856021e9b1af","name":"Ecommerce API Documentation Simple","description":"## Base URL\n\nThe base URL for accessing the API is:\n\n`Test - https://txpgtst.kapitalbank.az/api`\n\n`Prod - https://e-commerce.kapitalbank.az/api`\n\n## **Authentication**\n\nAll operations require BasicAuth-formatted header for authentication. This header contains the merchant's username and password, which are encoded in base64. This is a more secure way to authenticate merchants, as it prevents the username and password from being sent in plain text.\n\nMore information about BasicAuth :\n\n[https://www.twilio.com/docs/glossary/what-is-basic-authentication](https://www.twilio.com/docs/glossary/what-is-basic-authentication)\n\nBasicAuth in PostMan\n\n[https://learning.postman.com/docs/sending-requests/authorization/authorization-types/](https://learning.postman.com/docs/sending-requests/authorization/authorization-types/)\n\nJava : [https://www.baeldung.com/java-httpclient-basic-auth](https://www.baeldung.com/java-httpclient-basic-auth)\n\nASP.NET : [https://code-maze.com/aspnetcore-basic-authentication-with-httpclient/](https://code-maze.com/aspnetcore-basic-authentication-with-httpclient/)\n\nPhp : [https://www.gavsblog.com/blog/how-to-use-basic-authentication-with-php-curl](https://www.gavsblog.com/blog/how-to-use-basic-authentication-with-php-curl)\n\nNodeJS : [https://www.geeksforgeeks.org/basic-authentication-in-node-js-using-http-header/](https://www.geeksforgeeks.org/basic-authentication-in-node-js-using-http-header/)\n\n## Operation Flow\n\n**NON-PSP Transaction flow (Common payment)**\n\n1. Send create order request (Purchase). If success response go to step 2\n    \n2. Redirect to URL with values from Create Order response (point 1): Url Sample: [{{order.hppUrl}}/flex?id={{order.id}}&password={{order.password](https://null)}}\n    \n3. Redirect client with several (described below) transaction fields to redirect (callback ) url after transaction completion on PC (Processing center side). Transaction flow completed.Callback url sample:{{callback.url}}?ID=1234&STATUS=FullyPaid  \n    **Note** that STATUS parameter value can be temporary. So you have to verify transaction status using a Transaction details request.\n    \n\n**Preauthorization Transaction flow (Preauthorization + Clearing)**\n\n1. Send create order request (Order_DMS). If success response go to step 2\n    \n2. Redirect to URL with values from Create Order response (point 1): Url Sample:\n    \n    {{order.hppUrl}}/flex?id={{[order.id](http://order.id)}}&password={{order.password}}\n    \n3. Redirect client with several (described below) transaction fields to redirect (callback ) url after transaction completion on PC (Processing center side). preauthorization first step completed and amount will be in hold.\n    \n4. When the service or product has been provided, you need to send a Execution Transaction Clearing request (Second step of preauthorization transaction). Transaction flow is completed\n    \n\n**Recurrent payment flow (no cvv2 and no 3d checks).**\n\n1. Send recurrent payment create order (Recurring) request. If success response go to step 2\n    \n2. Send Set Source Token request. If success response go to step 3\n    \n3. Send Execute transaction (Purchase with saved card). If success response, transaction completed\n    \n\n**Order Credit Transaction flow (Send funds to card)**\n\n1. Send recurrent payment create order (Order Credit transaction) request. If success response go to step 2\n    \n2. Send Set Destination Token request. If success response go to step 3\n    \n3. Send Execute Transaction request (Execute Credit Operation). If success response, transaction completed\n    \n\n## Test card data\n\nPAN: 4169741330151778\n\nExpDate: 11/26\n\nCVV: 119","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"14817621","collectionId":"81083972-8ba2-4d43-b05a-856021e9b1af","publishedId":"2sA3dxCB1b","public":true,"publicUrl":"https://documenter-api.postman.tech/view/14817621/2sA3dxCB1b","privateUrl":"https://go.postman.co/documentation/14817621-81083972-8ba2-4d43-b05a-856021e9b1af","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"B61D29"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":"https://content.pstmn.io/2718c359-17a4-4c87-abfb-a3297eadac65/YTJJdGJHOW5ieTF0WVdsdUxYZG9hWFJsTG5CdVp3PT0ucG5n","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"B61D29"}},{"name":"light","logo":"https://content.pstmn.io/ccff24cd-521f-4761-8bc2-7f6063470f9f/YTJJdGJHOW5ieTF0WVdsdUxuQnVadz09LnBuZw==","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"B61D29"}}]}},"version":"8.10.0","publishDate":"2024-07-02T12:56:35.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":"https://content.pstmn.io/ccff24cd-521f-4761-8bc2-7f6063470f9f/YTJJdGJHOW5ieTF0WVdsdUxuQnVadz09LnBuZw==","logoDark":"https://content.pstmn.io/2718c359-17a4-4c87-abfb-a3297eadac65/YTJJdGJHOW5ieTF0WVdsdUxYZG9hWFJsTG5CdVp3PT0ucG5n"}},"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/768118b36f06c94b0306958b980558e6915839447e859fe16906e29d683976f0","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/2sA3dxCB1b"}