Paymob

Getting Started

Overview

Integration Checklist

Onboarding Wizard

Dashboard

New Dashboard

Integration Paths

No Code

APIs

Plugins

Mobile SDKs

Payments & Features

Payment Methods

Core Features

Managing Payments

Authentication Request (Generate Auth Token)

Intention APIs

Create Intention

Update Intention

Checkout Experiences

Unified Checkout (Redirection)

Pixel (Embedded)

Affordability Widget

IOS SDK

Android SDK

Flutter SDK

React Native SDK

Webhook (Callbacks) & HMAC

Transaction callbacks

HMAC 

Webhook Testing Tool

Manage Payment APIs

Refund

Void

Capture

Subscription

Create Subscription plan

Create Subscription

Plan actions

Subscription actions

Subscription Callback and HMAC Calculation

Pay With Saved Cards

Create Card Token

CIT (Customer Initiated Transaction)

MIT (Merchant Initiated Transaction)

QuickLink APIs

Create QuickLink

Cancel QuickLink

Transaction Inquiry APIs

Transaction Inquiry

Card Token Inquiry

Split Features Implementation

Payouts

How It Works

Disbursement Channels

Need Help?

Setup Guides

FAQs

Security & Privacy

Glossary

Payouts APIs

Auth

Cashin API

Inquires

Topup

Payout Callbacks

Model Context Protocol (MCP)

Draft Skills 3

AI Agent Skill

Wizard

Documentation

Developers

AI Solutions

Paymob-docs

Production

Sandbox

Add Secondary Card

Apple Pay [All regions]

Apple Pay - Certificates Creation

Apple Pay - Domain Verification

Apple Pay Setup

Auth/Cap

Bank Card Cashin

Bank Installments [EGY]

Bank Instant Cashin

Bank Wallet

BNPLs [EGY, KSA, UAE]

Bulk Transaction Inquiry banking

Bulk Transaction Inquiry by Reference

Bulk Transaction Inquiry non banking

By Order ID or Reference

By Transaction ID

Cancel Subscription

Cards [All regions]

Change Subscription Primary card

Convenience Fee

CS-Cart

Delete Secondary Card

Drupal

Egyptian POST

Etisalat Cash

Generate Auth Token

Getting Integration Credentials

Google Pay [KSA, UAE, OMN]

HMAC Card Token Callback:

HMAC Transaction Callback

PayMe

Payment Links

Joomla

Laravel-Bagisto

Magento 2

Odoo

OpenCart

OsCommerce

PrestaShop

Shopify

Staah

WHMCS

WordPress (WooCommerce)

ZenCart

Kiosk [EGY]

Last Transaction Subscription

List Subscription Cards

List Subscription Details

List Subscription Plans

List Subscription Transactions

Mobile Wallets [EGY]

Test Credentials

Orange Cashin

Split Features

Subscriptions

Transaction inquiry & Reports

Refresh Token

Vodafone Cashin

Topup Inquiry

User Budget Inquiry

Topup Request accept balance

Topup Request bank transfer

Register Webhook

Resume Subscription

Resume Subscription Plan

Suspend Subscription Plan

Update Subscription Plan

Suspend Subscription

Update Subscription

<p class="slate-p " ><strong class="slate-bold">Outcome </strong>​- Generate an Auth token to use for authentication across multiple API endpoints (e.g., Subscription APIs, create QuickLink).</p><p class="slate-p " ><span style="color:rgb(204, 204, 204)"><strong class="slate-bold">Last Updated Date </strong></span>​<span style="color:rgb(204, 204, 204)">- </span>​June 1, 2026</p><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><p class="slate-p " ></p><p class="slate-p " >You&apos;ll need to pass your ​<strong class="slate-bold">API Key </strong>​in the body of the request.</p><div style="width:100%;
	min-width:100%;" class="callout-widget" data-type=info ><div class="callout-icon"><svg width="20" height="20" viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M10.0628 14.1676C10.2434 14.1676 10.3927 14.1086 10.5107 13.9905C10.6288 13.8725 10.6878 13.7232 10.6878 13.5426V9.77177C10.6878 9.6051 10.6253 9.46274 10.5003 9.34469C10.3753 9.22663 10.2295 9.1676 10.0628 9.1676C9.88227 9.1676 9.73296 9.22663 9.61491 9.34469C9.49685 9.46274 9.43783 9.61205 9.43783 9.7926V13.5634C9.43783 13.7301 9.50033 13.8725 9.62533 13.9905C9.75033 14.1086 9.89616 14.1676 10.0628 14.1676ZM10.0003 7.62594C10.1948 7.62594 10.358 7.56344 10.4899 7.43844C10.6219 7.31344 10.6878 7.15371 10.6878 6.95927C10.6878 6.76482 10.6219 6.59816 10.4899 6.45927C10.358 6.32038 10.1948 6.25094 10.0003 6.25094C9.80588 6.25094 9.64269 6.32038 9.51074 6.45927C9.3788 6.59816 9.31283 6.76482 9.31283 6.95927C9.31283 7.15371 9.3788 7.31344 9.51074 7.43844C9.64269 7.56344 9.80588 7.62594 10.0003 7.62594ZM10.0003 18.3343C8.81977 18.3343 7.72255 18.1225 6.70866 17.6989C5.69477 17.2752 4.81283 16.6884 4.06283 15.9384C3.31283 15.1884 2.72602 14.3065 2.30241 13.2926C1.8788 12.2787 1.66699 11.1815 1.66699 10.0009C1.66699 8.83427 1.8788 7.74399 2.30241 6.7301C2.72602 5.71621 3.31283 4.83427 4.06283 4.08427C4.81283 3.33427 5.69477 2.74399 6.70866 2.31344C7.72255 1.88288 8.81977 1.6676 10.0003 1.6676C11.167 1.6676 12.2573 1.88288 13.2712 2.31344C14.285 2.74399 15.167 3.33427 15.917 4.08427C16.667 4.83427 17.2573 5.71621 17.6878 6.7301C18.1184 7.74399 18.3337 8.83427 18.3337 10.0009C18.3337 11.1815 18.1184 12.2787 17.6878 13.2926C17.2573 14.3065 16.667 15.1884 15.917 15.9384C15.167 16.6884 14.285 17.2752 13.2712 17.6989C12.2573 18.1225 11.167 18.3343 10.0003 18.3343ZM10.0003 17.0843C11.9448 17.0843 13.6114 16.3898 15.0003 15.0009C16.3892 13.612 17.0837 11.9454 17.0837 10.0009C17.0837 8.05649 16.3892 6.38982 15.0003 5.00094C13.6114 3.61205 11.9448 2.9176 10.0003 2.9176C8.05588 2.9176 6.38921 3.61205 5.00033 5.00094C3.61144 6.38982 2.91699 8.05649 2.91699 10.0009C2.91699 11.9454 3.61144 13.612 5.00033 15.0009C6.38921 16.3898 8.05588 17.0843 10.0003 17.0843Z" fill="#3960B4"></path></svg></div><div ><p class="slate-p " >To know how to get your API key, please check the <a href="https://developers.paymob.com/paymob-docs/need-help/faq/getting-integration-credentials" target=""><strong class="slate-bold">Getting Integration Credentials</strong></a> page.</p></div></div><p class="slate-p " ></p><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

- Generate an Auth token to use for authentication across multiple API endpoints (e.g., Subscription APIs, create QuickLink).

Sections

Authentication Request (Generate Auth Token)

Body Parameters

Response

Response Attributes

Language Box

Response

Sections

Authentication Request (Generate Auth Token)

Body Parameters

ResponseExpand all

Response Attributes

Language Box

Response

Ask an AI

Code with AI

Response