This repository contains the official Postman collections for integrating Paymob's Payment Gateway. These collections are designed to help developers quickly test and implement payment flows across Egypt, Saudi Arabia (KSA), United Arab Emirates (UAE), and Oman.
The Intention API is the modern way to initiate payments. It allows you to create a payment request that supports multiple payment methods (Cards, Wallets, Kiosk, etc.) through a single integration point.
- Unified Checkout: Redirect customers to a Paymob-hosted page where they can choose their preferred method.
- Customization: Supports overriding callback URLs and setting specific expiration times for each payment link.
Enable a seamless "One-Click" checkout experience by using tokenization.
- CIT (Customer Initiated): For returning customers who are present during checkout (requires CVV).
- MIT (Merchant Initiated): For automated charges like subscriptions or top-ups where the customer is not present.
- Security: Tokens are generated after a successful 3DS transaction, ensuring the card is valid and authorized.
A specialized tool for managing recurring billing and automated payment cycles.
- Flexible Cycles: Support for weekly, bi-weekly, monthly, quarterly, and annual billing.
- Plan Management: Create plans with specific retrial logic and reminder days for failed payments.
- Lifecycle APIs: Endpoints to suspend, resume, or cancel subscriptions programmatically.
Essential post-payment operations for financial management and order fulfillment.
- Refund: Full or partial reversal of a transaction (Merchant to Customer).
- Void: Instant cancellation of same-day transactions to avoid processing fees.
- Capture: Finalize an "Authorize-only" transaction. Note: Amounts not captured within 14 days are automatically voided.
Deep-dive into your transaction history for reconciliation or customer support.
- Search Flexibility: Query transactions using your own
merchant_order_id, Paymob'sorder_id, or the specifictransaction_id. - Technical Insights: Retrieve gateway response codes and detailed payment metadata.
Use the appropriate URL based on your merchant account region:
| Country | Base URL |
|---|---|
| Egypt | https://accept.paymob.com |
| Saudi Arabia | https://ksa.paymob.com |
| UAE | https://uae.paymob.com |
| Oman | https://oman.paymob.com |
- Import Collections: Download the
.jsonfiles from this repository and import them into your Postman Workspace. - Authentication:
- Secret Key: Used for Intentions and Post-pay APIs. Header format:
Authorization: Token <YOUR_SECRET_KEY>. - API Key: Used to generate a 60-minute Bearer Token for management APIs (like Subscriptions).
- Secret Key: Used for Intentions and Post-pay APIs. Header format:
- Variables: We recommend creating a Postman Environment with the following keys:
base_url,Secret_Key,api_key, andIntegration_ID.
| Error Code | Meaning | Action |
|---|---|---|
| 401 Unauthorized | Invalid Credentials | Check if you are using a Test Key in a Live environment or vice-versa. |
| 406 Not Acceptable | Amount Mismatch | Ensure the total amount equals the sum of individual items in the request. |
| 404 Not Found | Resource Missing | Verify the ID (Transaction/Order) exists in the specific region you are querying. |
- Official Docs: Paymob Developer Portal
- Support: For technical assistance, contact support@paymob.com or reach out to your account manager.
Maintained by the Paymob Technical Support Team.