{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"1511c7b5-194d-4366-ae6e-1a9feaa97654","name":"Clickpay Direct API","description":"<h1>ClickPay Direct API</h1>\n\nThe official ClickPay API postman collection\n\n<h2>Getting Started</h2>\n\n<p>In order to use the below API you need to have a ClickPay account. You can sign up for a free account<a href=\"https://merchant.clickpay.com.sa/merchant/register\">here</a>.</p>\n\n<p>Once you complete sign up and Log in to you ClickPay dashboard, Go to Developers page &gt; Key management, where you can find the profile id and server key using in this collection.</p>\n\n<h2>Target Audience</h2>\n\n<p>This document is intended for software engineers who needs to integrate a payment gateway for online payment acceptance</p>\n\n<h2>Assistance</h2>\n\n<p>If you require assistance, please email us at support@clickpay.sa</p>\n\n<h2>Documentation</h2>\n\n<p>For further documentation, you can find all technical documentation once you<a href=\"https://merchant.clickpay.com.sa/merchant/register\">sign up</a>to ClickPay account, in Developers Section.</p>\n\n<h2>Integration Solutions</h2>\n\n<ol><li><div><b>eCommerce Plugins</b>: Shopify, Magento, WooCommerce, OpenCart, CSCart, Expand Cart, Salla</div></li><li><div><b>Mobile SDK</b>: Android, IOS, React, Flutter</div></li><li><div><b>API Integrations: </b>ClickPay Hosted Payment Page, Managed Form, Merchant Own form</div></li></ol>\n\n<h2>Available Services</h2>\n\n<ul><li><div>Authorization and capture</div></li><li><div>eCommerce, MoTo, Recurring</div></li><li><div>Invoicing</div></li><li><div>Payment Notification (Callback service, Instant Payment Notifications)</div></li><li><div>Customer emails receipts (Send Grid)</div></li></ul>\n\n<h2>Payment Methods</h2>\n\n<ol><li><div>Credit Cards: Visa, MasterCard</div></li><li><div>Debit Cards: mada</div></li><li><div>Mobile Wallets: Apple pay</div></li></ol>\n\nIf the below tag is passed in the request for hosted payment page the relevant payment method is displayed if enabled for the merchant else all the applicable payment methods are displayed on the payment page.\n\n\"payment_methods\": \\[\"card\",\"applepay\"\\]\n\n<table><tbody><tr><td><div><p><b>Payment Method</b></p></div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div><p><b>Description</b></p></div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div><p>card</p></div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div><p>Credit Card payment method</p></div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div><p>creditcard</p></div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div><p>Credit Card payment method</p></div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div><p>mada</p></div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div><p>MADA payment method in KSA</p></div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div><p>stcpay</p></div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div><p>STC Pay payment method in KSA</p></div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div><p>applepay</p></div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div><p>Apple pay payment method</p></div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr></tbody></table>\n\n<h2>Testing</h2>\n\n<h3>Test Cards</h3>\n\n<p>Test Cards can be found in ClickPay merchant dashboard &gt; Developers &gt; Testing &gt; API debug log</p>\n\n<table><tbody><tr><td><div><p><b>Number</b></p></div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div><p><b>Scheme</b></p></div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div><p><b>CVV</b></p></div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div><p><b>3D enrolled</b></p></div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div><p>4000000000000002</p></div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div><p>Visa</p></div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div><p>123</p></div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div><p>Yes</p></div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div><p>4111111111111111</p></div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div><p>Visa</p></div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div><p>123</p></div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div><p>No</p></div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div><p>4012001036983332</p></div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div><p>Visa</p></div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div><p>530</p></div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div><p>Yes</p></div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div><p>5498383801606532</p></div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div><p>MasterCard</p></div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div><p>977</p></div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div><p>Yes</p></div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div><p>5200000000000007</p></div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div><p>MasterCard</p></div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div><p>977</p></div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div><p>Yes</p></div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div><p>5200000000000114</p></div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div><p>MasterCard</p></div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div><p>977</p></div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div><p>No</p></div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr></tbody></table>\n\n<h3>Debugging</h3>\n\n<p>To help you troubleshoot your integration, API Debug logs can be found in ClickPay merchant dashboard &gt; Developers &gt; Testing &gt; API debug log</p>\n\n<h2>Hosted Payment Page UI Customization</h2>\n\n<p>Hosted Payment Page can be fully customized from ClickPay Merchant Dashboard &gt; Developers &gt; Paypage Settings, you can apply any of the following controls to match the hosted payment page UI with your websites theme:</p>\n\n<ul><li><div>Logo Image (Upload Image Logo)</div></li><li><div>Header Image (Upload Header Image)</div></li><li><div>Disable Merchant Name: Yes/No( Hide Merchant name under the Merchant logo )</div></li><li><div>Header Image Repeat: Yes/No</div></li><li><div>Header Image Position: (Left/Center/Right)</div></li><li><div>Header background color</div></li><li><div>Page background color</div></li><li><div>Page background grey transparent: (Y/N)</div></li><li><div>PayButton Background color</div></li><li><div>PayButton Hover color</div></li><li><div>PayButton Text color</div></li></ul>\n\n<h3>Hide Billing/Shipping details</h3>\n\n<p>To hide billing and shipping details, refer to the Post request sample in this collection (Create payment page - Hide billing &amp; shipping)</p>\n\n<h3>Framed Option</h3>\n\n<p>You can load the payment page in a frame on your checkout page avoiding the redirection of your customers to a new page, refer to the Post request sample in this collection (Create payment page – Framed)</p>\n\n<h2>Transaction API</h2>\n\n<p>The main transaction request API is used to process all payments, regardless of if they are through either&nbsp;your own payment pages, the&nbsp;managed payment pages, or if your are using the&nbsp;hosted payment pages.</p>\n\n<p>All requests are made using server-to-server calls, with JSON format data.</p>\n\n<p>The transaction request API must not be used from within a browser.</p>\n\n<p>All requests must be sent using HTTP POST to the ClickPay transaction API endpoint</p>\n\n<h3>Authorization Header</h3>\n\n<p>You will need your&nbsp;server key&nbsp;in order to make any of the API requests in this collection. This is not the same as the client key that is used within the&nbsp;managed payment pages. Authentication is done by including your server key in the 'Authorization:' header for the request.</p>\n\n(Authorization Type: API key)\n\n<p>Server key is available in your ClickPay Merchant Dashboard &gt; Developers Section &gt; Key Management</p>","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"20069242","team":4290682,"collectionId":"1511c7b5-194d-4366-ae6e-1a9feaa97654","publishedId":"UVyn2e7i","public":true,"publicUrl":"https://documenter-api.postman.tech/view/20069242/UVyn2e7i","privateUrl":"https://go.postman.co/documentation/20069242-1511c7b5-194d-4366-ae6e-1a9feaa97654","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"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":"EF5B25"}}]}},"version":"8.10.1","publishDate":"2025-09-08T07:53:29.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/47379dac835adfce31112e6d786fdac50cf7bd84e90b9e893a021c967e870ff1","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/UVyn2e7i"}