{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"2e537068-7954-4c96-ac6d-8a93940937af","name":"PT-2 Direct API","description":"

PayTabs-PT2 Direct APIs

\n\nThe official PayTabs API postman collection\n\n

Getting Started

\n

In order to use the below API you need to have a PayTabs account. You can sign up for a free account here.

\n

Once you complete sign up and Log in to you PayTabs dashboard, Go to Developers page > Key management, where you can find the profile id and server key using in this collection.

\n

Target Audience

\n

This document is intended for software engineers who needs to integrate a payment gateway for online payment acceptance

\n

Assistance

\n

If you require assistance, please email us at cs@paytabs.com

\n

Documentation

\n

For further documentation, you can find all technical documentation once you sign up to PayTabs account, in Developers Section.

\n

Integration Solutions

\n
    \n
  1. eCommerce Plugins: Shopify, Magento, WooCommerce, OpenCart, CSCart, Xero, Zoho, Expand Cart, Zid, Salla
    2. \n
  2. Mobile SDK: Android, IOS, React, Flutter
    3. \n
  3. API Integrations: PayTabs Hosted Payment Page, Managed Form, Merchant Own form
    4. \n
\n

Available Services

\n\n

 

\n

Payment Methods

\n
    \n
  1. Credit Cards: Visa, MasterCard, American express, UnionPay
    2. \n
  2. Debit Cards: mada (KSA), meeza (Egypt), Omannet(Oman), Knet (Kuwait)
    3. \n
  3. Mobile Wallets: STCpay (KSA), Meeza Wallets (Egypt), Apple pay, Samsung pay
    4. \n
  4. BuyNow, Pay Later: valU (Egypt)
    5. \n
  5. Cash: Fawry (Egypt)
    6. \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

"payment_methods": ["card","applepay"]

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
\n

Payment Method

\n 		\n

Description

\n
\n

card

\n 		\n

Credit Card payment method

\n
\n

creditcard

\n 		\n

Credit Card payment method

\n
\n

mada

\n 		\n

MADA payment method in KSA

\n
\n

amex

\n 		\n

AMEX payment method

\n
\n

unionpay

\n 		\n

Union Pay payment method

\n
\n

stcpay

\n 		\n

STC Pay payment method in KSA

\n
\n

valu

\n 		\n

ValU payment method in Egypt

\n
\n

meeza

\n 		\n

Meeza payment method in Egypt

\n
\n

meezaqr

\n 		\n

Meeza QR payment method in Egypt

\n
\n

omannet

\n 		\n

Omannet payment method in Oman

\n
\n

knet

\n 		\n

KNET payment method

\n
\n

applepay

\n 		\n

Apple pay payment method

\n
\n

samsungpay

\n 		\n

Samsung Pay payment method

\n
\n

fawry

\n 		\n

Fawry Payment method in Egypt

\n
\n

Testing

\n

Test Cards

\n

Test Cards can be found in PayTabs merchant dashboard > Developers > Testing > API debug log

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
\n

Number

\n		\n

Scheme

\n		\n

CVV

\n		\n

3D enrolled

\n
\n

4000000000000002

\n		\n

Visa

\n		\n

123

\n		\n

Yes

\n
\n

4111111111111111

\n		\n

Visa

\n		\n

123

\n		\n

No

\n
\n

4012001036983332

\n		\n

Visa

\n		\n

530

\n		\n

Yes

\n
\n

5498383801606532

\n		\n

MasterCard

\n		\n

977

\n		\n

Yes

\n
\n

5200000000000007

\n		\n

MasterCard

\n		\n

977

\n		\n

Yes

\n
\n

5200000000000114

\n		\n

MasterCard

\n		\n

977

\n		\n

No

\n
\n

 

\n

Debugging

\n

To help you troubleshoot your integration, API Debug logs can be found in PayTabs merchant dashboard > Developers > Testing > API debug log

\n

Hosted Payment Page UI Customization

\n

Hosted Payment Page can be fully customized from PayTabs Merchant Dashboard > Developers > Paypage Settings, you can apply any of the following controls to match the hosted payment page UI with your websites theme:

\n\n

Hide Billing/Shipping details

\n

To hide billing and shipping details, refer to the Post request sample in this collection (Create payment page - Hide billing & shipping)

\n

Framed Option

\n

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)

\n

Transaction API

\n

The main transaction request API is used to process all payments, regardless of if they are through either your own payment pages, the managed payment pages, or if your are using the hosted payment pages.

\n

All requests are made using server-to-server calls, with JSON format data.

\n

The transaction request API must not be used from within a browser.

\n

All requests must be sent using HTTP POST to the PayTabs transaction API endpoint

\n

Authorization Header

\n

You will need your server key 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 managed payment pages. Authentication is done by including your server key in the 'Authorization:' header for the request.

(Authorization Type: API key)\n

Server key is available in your PayTabs Merchant Dashboard > Developers Section > Key Management

","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"14575178","collectionId":"2e537068-7954-4c96-ac6d-8a93940937af","publishedId":"U16kqjx7","public":true,"publicUrl":"https://documenter-api.postman.tech/view/14575178/U16kqjx7","privateUrl":"https://go.postman.co/documentation/14575178-2e537068-7954-4c96-ac6d-8a93940937af","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.10.1","publishDate":"2021-09-11T10:37:50.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[{"name":"SAU","id":"007a9375-603c-44f5-8872-86b5f20843c9","owner":"14575178","values":[{"key":"domain","value":"secure.paytabs.sa","enabled":true},{"key":"profile_id","value":"48264","enabled":true},{"key":"server_key","value":"SRJNL96L6L-HZLTLHTHD6-299ZBGBBNZ","enabled":true},{"key":"currency","value":"SAR","enabled":true},{"key":"return_url","value":"","enabled":true},{"key":"callback_url","value":"","enabled":true},{"key":"invoice_id","value":"","enabled":true,"type":"any"},{"key":"account_id","value":"5154","enabled":true,"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/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"},{"label":"SAU","value":"14575178-007a9375-603c-44f5-8872-86b5f20843c9"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/U16kqjx7"}