PayTabs API Documentation
This is the complete API documentation for connecting to the PayTabs API using MindCloud's Universal API. If you are new to MindCloud, start with the Introduction to see how one API can sit in front of many different apps.
MindCloud is an integration company that offers one normalized API to access 3,100+ apps from a single place. It cleans up provider-specific quirks, keeps requests and responses consistent, and centralizes authentication so you do not need to manage separate flows for every app. Browse other apps.
Meet PayTabs: PayTabs PT2 payment gateway app for creating payment requests, managing transactions, tokenizing cards, and managing invoices in the global test environment. Keep reading to get started.
Quickstart
Before you run your first PayTabs request, you need three things:
- A MindCloud account — sign in or create an account at MindCloud.
- A MindCloud API Key — create one in API Keys. Keep it on your server.
- At least one PayTabs connection — create or choose one in Connections. Note its
connectionId.
Every PayTabs action uses the same URL pattern:
https://connect.mindcloud.co/v1/universal/payTabs/latest/actions/{actionSlug}You need a MindCloud API Key and a PayTabs connection. Then call an action such as Query Transaction by Reference:
curl --request GET \
--url "https://connect.mindcloud.co/v1/universal/payTabs/latest/actions/query-transaction-by-reference" \
--header "Authorization: Bearer $MINDCLOUD_API_KEY" \
--get \
--data-urlencode "connectionId=$CONNECTION_ID"Every response comes back in the same envelope, with your rows in a data array:
{
"success": true,
"data": [
{ "id": "1042", "name": "Ava" }
],
"meta": {}
}After your first request works, use Shape your requests to control arguments, pagination, filtering, fields, and errors.
Authenticate with a MindCloud API Key plus a connectionId for your PayTabs account. See PayTabs API Authentication for the full flow and how to get your connection credentials.
PayTabs actions
All 58 published actions for this PayTabs version. Each page documents the endpoint, arguments, and response controls.
- PUTCancel Invoice
- PUTCancel Invoice by Path
- PUTCapture Transaction
- POSTCreate ADCB TouchPoints Payment Page
- POSTCreate Alternate Currency Payment Page
- POSTCreate Aman Payment Page
- POSTCreate Apple Pay Payment
- POSTCreate Donation Payment Page
- POSTCreate Framed Hosted Payment Page
- POSTCreate Halan Payment Page
- POSTCreate Hosted Payment Page
- POSTCreate Hosted Payment Page with Card Approval
- POSTCreate Hosted Payment Page with Card Discounts Amount
- POSTCreate Hosted Payment Page with Card Discounts Percent and Flat Amount
- POSTCreate Hosted Payment Page with Card Filter
- POSTCreate Hosted Payment Page with Custom Parameters
- POSTCreate Hosted Payment Page with Hidden Shipping
- POSTCreate Hosted Payment Page with iFrame PostMessage
- POSTCreate Hosted Payment Page with Invoice
- POSTCreate Hosted Payment Page with Theme
- POSTCreate Hosted Payment Page with Token Info
- POSTCreate Invoice
- POSTCreate Invoice with Payment Methods
- POSTCreate KNET Payment Page
- POSTCreate Managed Form Payment
- POSTCreate MOTO Non-3DS Non-CVV Payment
- POSTCreate MOTO Non-3DS Payment
- POSTCreate MOTO Payment
- POSTCreate Optional Tokenizing Hosted Payment Page
- POSTCreate Own Form Payment
- POSTCreate PayPal Payment Page
- POSTCreate Recurring Payment
- POSTCreate Sadad Payment Request
- POSTCreate Sadad Split Payout Payment Request
- POSTCreate Samsung Pay Payment
- POSTCreate Tabby Payment Page
- POSTCreate Tamara Payment Page
- POSTCreate Token-Based Payment
- POSTCreate Token-Based Payment with Token Info
- POSTCreate Tokenized Invoice
- POSTCreate Tokenizing Hosted Payment Page
- DELETEDelete Token
- GETDownload Invoice PDF
- PUTExtend Authorization
- GETGet Invoice Status
- GETGet Invoice Status by Path
- GETGet Token Status
- PUTMark Invoice as Paid
- GETQuery Shopify Transaction by Reference
- GETQuery Transaction by Cart ID
- GETQuery Transaction by Reference
- PUTRefund Transaction
- GETSadad Inquiry
- GETSearch Invoices
- PUTSend Invoice SMS
- POSTTokenize Card
- GETValU Inquiry
- PUTVoid Transaction
Related apps
More Commerce apps on the Universal API, behind the same REST shape. Or browse all apps.