Paymob

Getting Started - KSA

Accept Dashboard

Profile

Payment Integrations

Orders

Transactions

Checkout Customization

API Checkout Experience

Basics of API

API Setup - (Secret and Public Key)

Unified Intention API Experience

Pixel (Native Payment Experience)

Split Payment Feature

E-Commerce Plugins

Shopify

<p class="slate-p " >Please follow the below steps to successfully install and configure the Paymob plugin for WordPress (WooComerce). </p><div class="steps-widget" style="width:100%;
  	min-width:100%;"><div class="steps-wrapper"><div class="steps-content"><h6 class="slate-h6 " >1</h6><p class="slate-p " ><a href="https://developers.paymob.com/egypt/e-commerce-plugins/wordpress-woocommerce/prerequisites-before-installation-of-plugin-copy-2" target=""><strong class="slate-bold">Prerequisites Before Installation of Plugin.</strong></a></p></div></div><div class="steps-wrapper"><div class="steps-content"><h6 class="slate-h6 " >2</h6><p class="slate-p " ><a href="https://developers.paymob.com/egypt/e-commerce-plugins/wordpress-woocommerce/steps-to-install-the-paymob-plugin-copy-2" target=""><strong class="slate-bold">Steps to Install the Paymob Plugin from WordPress Market Place.</strong></a></p></div></div><div class="steps-wrapper"><div class="steps-content"><h6 class="slate-h6 " >3</h6><p class="slate-p " ><a href="https://developers.paymob.com/egypt/e-commerce-plugins/wordpress-woocommerce/steps-to-install-the-paymob-plugin-copy-3" target=""><strong class="slate-bold">Steps to Install the Paymob Plugin from Woo Commerce Market Place.</strong></a></p></div></div><div class="steps-wrapper"><div class="steps-content"><h6 class="slate-h6 " >4</h6><p class="slate-p " ><a href="https://developers.paymob.com/egypt/e-commerce-plugins/wordpress-woocommerce/setting-up-the-main-configuration-copy-2" target=""><strong class="slate-bold">Setting Up the Main Configuration.</strong></a></p></div></div><div class="steps-wrapper"><div class="steps-content"><h6 class="slate-h6 " >5</h6><p class="slate-p " ><a href="https://developers.paymob.com/egypt/e-commerce-plugins/wordpress-woocommerce/payment-method-integration-settings-copy-2" target=""><strong class="slate-bold">Payment Integrations.</strong></a></p></div></div><div class="steps-wrapper"><div class="steps-content"><h6 class="slate-h6 " >6</h6><p class="slate-p slate-indent-0" style="0px"><a href="https://developers.paymob.com/egypt/e-commerce-plugins/wordpress-woocommerce/card-embedded-settings" target=""><strong class="slate-bold">Card Embedded Settings.</strong></a></p></div></div></div><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><p class="slate-p " ></p>

WordPress (WooCommerce)

OpenCart

Odoo

Magento 

WHMCS

Cs-Cart

PrestaShop

Joomla

ZenCart

OsCommerce

Laravel-Bagisto

Drupal

<h2 class="slate-h2 " ><span style="color:#1155CB">Overview</span></h2><p class="slate-p " >Paymob provides a comprehensive subscription module designed to help merchants efficiently manage their subscriptions on a variety of billing cycles, including weekly, bi-weekly, monthly, quarterly, semi-annual, and annual plans. This module is tailored to meet the specific needs of each merchant, enabling them to create, manage, and control their subscriptions independently through our APIs.</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 " >For any guidance or assistance, please reach out to your account manager. Alternatively, you can contact our support team via email at  <a href="mailto:support@paymob.com" target="_blank">support@paymob.com</a>. When reaching out, please include details regarding your subscription, such as your Subscription ID and Transaction ID, to help us assist you more efficiently.</p></div></div><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><h2 class="slate-h2 " ><span style="color:#1155CB">Integration Requirements</span></h2><p class="slate-p " >To successfully set up your subscription plan, you will need two integration IDs:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Online 3DS Integration ID:</strong> This ID will be used for creating subscriptions.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Moto Integration ID:</strong> Utilize this ID when creating the subscription plan itself.</div></li></ul><p class="slate-p " >Ensure you have both integration IDs ready to streamline the setup process.</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 " >If you wish to verify the card user details (provide a free trial for X days period) instead of deducting the amount while creating the subscription then you can ask our support team at <a href="mailto:support@paymob.com" target="_blank">support@paymob.com</a> to create a 3DS verification integration ID. Noting this amount will be an auto reversal and you need to set the  <span style="color:rgb(182, 66, 76)">&quot;use_transaction_amount&quot;</span>: <span style="color:rgb(30, 83, 163)"><strong class="slate-bold">false</strong></span>  to avoid any override with the Subscription plan amount</p></div></div><p class="slate-p " >For further assistance or detailed API guidance, please refer to the subsequent sections of this documentation.</p><div style="width:100%;
	min-width:100%;" class="callout-widget" data-type=success ><div class="callout-icon"><svg width="18" height="18" viewBox="0 0 18 18" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M7.77116 10.8968L5.72949 8.8551C5.60449 8.7301 5.45171 8.6676 5.27116 8.6676C5.0906 8.6676 4.93088 8.73705 4.79199 8.87594C4.6531 9.01482 4.58366 9.17455 4.58366 9.3551C4.58366 9.53566 4.6531 9.68844 4.79199 9.81344L7.33366 12.3551C7.45866 12.4801 7.60449 12.5426 7.77116 12.5426C7.93783 12.5426 8.08366 12.4801 8.20866 12.3551L13.2087 7.3551C13.3337 7.2301 13.3927 7.07732 13.3857 6.89677C13.3788 6.71621 13.3128 6.56344 13.1878 6.43844C13.0628 6.29955 12.9066 6.2301 12.7191 6.2301C12.5316 6.2301 12.3684 6.29955 12.2295 6.43844L7.77116 10.8968ZM9.00033 17.3343C7.81977 17.3343 6.72255 17.1225 5.70866 16.6989C4.69477 16.2752 3.81283 15.6884 3.06283 14.9384C2.31283 14.1884 1.72602 13.3065 1.30241 12.2926C0.878798 11.2787 0.666992 10.1815 0.666992 9.00094C0.666992 7.83427 0.878798 6.74399 1.30241 5.7301C1.72602 4.71621 2.31283 3.83427 3.06283 3.08427C3.81283 2.33427 4.69477 1.74399 5.70866 1.31344C6.72255 0.88288 7.81977 0.667603 9.00033 0.667603C10.167 0.667603 11.2573 0.88288 12.2712 1.31344C13.285 1.74399 14.167 2.33427 14.917 3.08427C15.667 3.83427 16.2573 4.71621 16.6878 5.7301C17.1184 6.74399 17.3337 7.83427 17.3337 9.00094C17.3337 10.1815 17.1184 11.2787 16.6878 12.2926C16.2573 13.3065 15.667 14.1884 14.917 14.9384C14.167 15.6884 13.285 16.2752 12.2712 16.6989C11.2573 17.1225 10.167 17.3343 9.00033 17.3343ZM9.00033 16.0843C11.0142 16.0843 12.6982 15.4072 14.0524 14.053C15.4066 12.6989 16.0837 11.0148 16.0837 9.00094C16.0837 6.98705 15.4066 5.30302 14.0524 3.94885C12.6982 2.59469 11.0142 1.9176 9.00033 1.9176C6.98644 1.9176 5.30241 2.59469 3.94824 3.94885C2.59408 5.30302 1.91699 6.98705 1.91699 9.00094C1.91699 11.0148 2.59408 12.6989 3.94824 14.053C5.30241 15.4072 6.98644 16.0843 9.00033 16.0843Z" fill="#06837A"></path></svg></div><div ><p class="slate-p " >Download the <a href="https://drive.google.com/file/d/17_jNJz3QluuuRBlYIyaRUlqcty-A-7xM/view?usp=drive_link" target="">Subscription Module APIs.</a></p></div></div><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

Subscriptions

<h3 class="slate-h3 " ><strong class="slate-bold">Authentication Request API allows you to pass your API key or login details to generate a token in the response.</strong></h3><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><p class="slate-p " ><u class="slate-underline"><strong class="slate-bold">Step 1</strong></u><strong class="slate-bold">: </strong>To start using any API for the subscription module, you need to obtain an authentication token through the below auth request using “api_key” or “login” details.</p><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">URL: </strong><u class="slate-underline"><strong class="slate-bold">https://accept.paymob.com/api/auth/tokens</strong></u></p><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">Method: </strong>POST</p><p class="slate-p " ><strong class="slate-bold">Source</strong>: <em class="slate-italic">Merchant&apos;s server</em></p><p class="slate-p " ><strong class="slate-bold">Recipient</strong>: <em class="slate-italic">Accept&apos;s server</em></p><p class="slate-p " ><span style="color:#1155CB"><u class="slate-underline"><strong class="slate-bold">Step 1.1:</strong></u></span><span style="color:#1155CB"><strong class="slate-bold"> API KEY</strong></span></p><p class="slate-p " >You can pass the API key in the parameters to receive the token in the response. For API key details please refer to this <a href="https://developers.paymob.com/egypt/api-reference-guide/api-setup-secret-and-public-key" target="">section</a>.</p><p class="slate-p " ><strong class="slate-bold">Request:</strong></p><div style="text-align:left"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/9457680e-42ad-48e1-9ee4-3bf9853a680e.jpg" style="
              width:1082px;
	            height:350px;
	            aspect-ratio:1082 / 350"
         /></div><p class="slate-p " ><strong class="slate-bold">Response :</strong></p><div style="text-align:left"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/eb87925c-e8b8-4073-a5a1-e65479e65175.jpg" style="
              width:1082px;
	            height:309px;
	            aspect-ratio:1082 / 309"
         /></div><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><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 " >The token has an expiration limit of 60 minutes. After this period, you will need to generate a new token.</p></div></div><p class="slate-p " ><span style="color:#1155CB"><u class="slate-underline"><strong class="slate-bold">Step 1.2:</strong></u></span><span style="color:#1155CB"><strong class="slate-bold"> LOGIN:</strong></span></p><p class="slate-p " >You can pass the login details in the parameters to receive the token in the response. </p><p class="slate-p " ><strong class="slate-bold">Request:</strong></p><div style="text-align:left"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/07c4bf1a-e233-4f76-a75e-fd26605bf597.jpg" style="
              width:1082px;
	            height:339px;
	            aspect-ratio:1082 / 339"
         /></div><p class="slate-p " ><strong class="slate-bold">Response:</strong></p><div style="text-align:left"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/9bbecea1-9be7-4b4f-9e12-61d787df952f.jpg" style="
              width:1082px;
	            height:309px;
	            aspect-ratio:1082 / 309"
         /></div><div class="slate-div"></div><p class="slate-p " ></p>

Authentication Request (Generate Token)

<h3 class="slate-h3 " ><strong class="slate-bold">Subscription Plan refers to a billing model that allows merchants to offer their products or services on a recurring basis. </strong></h3><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><p class="slate-p " >You can create your own desired Subscription plan by using the below-mentioned APIs. </p><p class="slate-p " ><u class="slate-underline"><strong class="slate-bold">Step 1:</strong></u> First, you will run an Authentication request to get the Auth Bearer Token for Authorization as explained in the “<a href="https://developers.paymob.com/egypt/subscriptions-1/authentication-request-generate-token" target=""><span style="color:#000000"><strong class="slate-bold">Authentication Request (Generated Token)”</strong></span></a><span style="color:#000000"> </span>section.</p><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><p class="slate-p " ><u class="slate-underline"><strong class="slate-bold">Step 2:</strong></u> Please send a POST request to the URL below. Select &quot;Bearer Token&quot; as the authentication type and enter the authentication token in the token box of the authorization section.</p><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">URL: https://accept.paymob.com/api/acceptance/subscription-plans</strong></p><p class="slate-p " ><strong class="slate-bold">Method</strong>: <em class="slate-italic">POST</em></p><p class="slate-p " ><strong class="slate-bold">Source</strong>: <em class="slate-italic">Merchant&apos;s server</em></p><p class="slate-p " ><strong class="slate-bold">Recipient</strong>: <em class="slate-italic">Accept&apos;s server</em></p><p class="slate-p " ><strong class="slate-bold">Authorization</strong>: <em class="slate-italic">Bearer Token {auth token} You need to enter the authentication token value in the token box, as shown in the image below.</em></p><div style="text-align:left"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/d6342822-109d-40eb-89d9-f4e62e3aa3ce.jpg" style="
              width:1507px;
	            height:477px;
	            aspect-ratio:1507 / 477"
         /></div><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><div style="width:100%;
	min-width:100%;" class="callout-widget" data-type=warning ><div class="callout-icon"><svg width="18" height="16" viewBox="0 0 18 16" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M0.916637 15.5009C0.791637 15.5009 0.683998 15.4732 0.59372 15.4176C0.503443 15.362 0.430526 15.2857 0.37497 15.1884C0.319415 15.0912 0.288165 14.9905 0.28122 14.8864C0.274276 14.7822 0.305526 14.6745 0.37497 14.5634L8.4583 0.605103C8.52775 0.493991 8.60761 0.41413 8.69789 0.365519C8.78816 0.316908 8.88886 0.292603 8.99997 0.292603C9.11108 0.292603 9.21178 0.316908 9.30205 0.365519C9.39233 0.41413 9.47219 0.493991 9.54164 0.605103L17.625 14.5634C17.6944 14.6745 17.7257 14.7822 17.7187 14.8864C17.7118 14.9905 17.6805 15.0912 17.625 15.1884C17.5694 15.2857 17.4965 15.362 17.4062 15.4176C17.3159 15.4732 17.2083 15.5009 17.0833 15.5009H0.916637ZM1.99997 14.2509H16L8.99997 2.1676L1.99997 14.2509ZM9.0833 13.0634C9.26386 13.0634 9.41316 13.0044 9.53122 12.8864C9.64928 12.7683 9.7083 12.619 9.7083 12.4384C9.7083 12.2579 9.64928 12.1086 9.53122 11.9905C9.41316 11.8725 9.26386 11.8134 9.0833 11.8134C8.90275 11.8134 8.75344 11.8725 8.63539 11.9905C8.51733 12.1086 8.4583 12.2579 8.4583 12.4384C8.4583 12.619 8.51733 12.7683 8.63539 12.8864C8.75344 13.0044 8.90275 13.0634 9.0833 13.0634ZM9.0833 10.7509C9.26386 10.7509 9.41316 10.6919 9.53122 10.5739C9.64928 10.4558 9.7083 10.3065 9.7083 10.1259V6.70927C9.7083 6.52871 9.64928 6.37941 9.53122 6.26135C9.41316 6.1433 9.26386 6.08427 9.0833 6.08427C8.90275 6.08427 8.75344 6.1433 8.63539 6.26135C8.51733 6.37941 8.4583 6.52871 8.4583 6.70927V10.1259C8.4583 10.3065 8.51733 10.4558 8.63539 10.5739C8.75344 10.6919 8.90275 10.7509 9.0833 10.7509Z" fill="#F1C21B"></path></svg></div><div ><p class="slate-p " ><strong class="slate-bold">Important Notes:</strong></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Please make sure to use the Moto integration ID while creating a subscription plan.</div></li><li class="slate-li " ><div style="position:relative">You need to set parameter &apos;webhook_url&apos; while creating the plan request then you will start receiving the response </div></li></ul><p class="slate-p " >on webhook on any action (subscription level only).</p></div></div><div style="text-align:left"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/151c7271-b8ab-4218-a663-8193c360d500.jpg" style="
              width:1507px;
	            height:513px;
	            aspect-ratio:1507 / 513"
         /></div><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">You will receive a unique webhook URL from the webhook site for testing, as illustrated in the image below.</div></li></ul><div style="text-align:left"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/eddf3147-37dc-43c7-b139-97de4cb3c041.jpg" style="
              width:1507px;
	            height:463px;
	            aspect-ratio:1507 / 463"
         /></div><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><p class="slate-p " >To set your webhook URL for the Moto/3DS ID, follow these steps:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Navigate to the Developers section and set your webhook URL.</div></li><li class="slate-li " ><div style="position:relative">Then, go to the Payment Integration section.</div></li><li class="slate-li " ><div style="position:relative">Click on the integration ID.</div></li><li class="slate-li " ><div style="position:relative">In the lower section of the page, you can edit the integration details. Add your webhook URL in the &quot;Transaction Processed Callback&quot; section, as shown in the image below.</div></li></ul><div style="text-align:left"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/f8e09493-307f-4db7-9ab5-a967c9772e4b.jpg" style="
              width:1507px;
	            height:403px;
	            aspect-ratio:1507 / 403"
         /></div><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><div class="slate-div"></div><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><div class="table-container" style="width:100%;min-width:100%"><table class="slate-table" ><div class="published-table-header" style="width:100%;min-width:100%;min-height:initial;visibility: hidden;border:initial"><div style="width:400px;">Title</div><div style="width:400px;">Description</div><div style="width:400px;"></div></div><colgroup ></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Field</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Description</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Mandatory</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Frequency 

(frequency)</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Specify the frequency of deduction (e.g., Weekly, Biweekly, Monthly, Quarterly, Half annual, Yearly). Values in numbers are (7, 15, 30, 90, 180, 360).</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Yes</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >MIGS Moto Integration ID

(integration)</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >MIGS Moto Integration ID, which will be used for upcoming transactions (recurring transactions).</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Yes</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Name

(name)</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Name the subscription plan for identification purposes. The maximum number of characters is (200).</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Yes</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Plan Type

(plan_type)</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >The type of the subscription plan. It accepts the values (rent) and the default is “rent”</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >No</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Reminder Days

(reminder_days)</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Specify the number of days before which you want to send a notification to the customer to pay (currently supporting email notifications).</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >No</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Retrial Days

(retrial_days)</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Define the days on which the subscription will be attempted again in case of a failure to collect the previous subscription amount.</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >No</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Subscription Amount

(amount_cents)</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Specify the subscription amount that will be charged.</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Based on the Use Transaction Amount Flag</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Use Transaction Amount Flag

(use_transaction_amount)</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >If this flag is enabled, the system will use the first transaction amount instead of the specified subscription amount. Otherwise, it will use the subscription amount from the &quot;Amount Cents.&quot; If <span style="color:rgb(182, 66, 76)">&quot;use_transaction_amount&quot;</span>: <span style="color:rgb(30, 83, 163)"><strong class="slate-bold">false</strong></span>,/disabled //false; to override the create subscription amount.</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Based on Subscription Amount</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Number Of Deductions

(number_of_deductions)</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >The number of deductions of this subscription. The default value is null.</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >No</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Is Active

(is_active)</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Indicates whether the plan will be created will be active or paused. The default value is true.</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >No</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >webhook_url</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >You need to enter the unique webhook URL in this parameter</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >No</p></td></div></tr></tbody></table></div><p class="slate-p " ></p>

Create Subscription plan

<h3 class="slate-h3 " ><strong class="slate-bold">Subscriptions allow merchants to offer products or services on a recurring basis, facilitating automated billing.</strong></h3><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><p class="slate-p " ><u class="slate-underline"><strong class="slate-bold">Step 1:</strong></u> You can create subscriptions by including the parameters outlined below in the normal Payment Intention API, as explained in the &quot;<a href="https://developers.paymob.com/egypt/checkout-copy-1/create-intention-payment-api" target="">Create Intention/Payment API&quot;</a> section.</p><p class="slate-p " ><strong class="slate-bold">subscription_plan_id:</strong> You can obtain the subscription plan ID from the response of the Create Subscription Plan request.</p><p class="slate-p " ><strong class="slate-bold">subscription_start_date:</strong> This field is optional. If you do not wish for your subscription to begin on the day you create it, you may specify a future date instead.</p><div style="text-align:left"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/c62a3734-a2dc-410a-8d08-b08448f53e0e.jpg" style="
              width:1507px;
	            height:756px;
	            aspect-ratio:1507 / 756"
         /></div><p class="slate-p " ><u class="slate-underline"><strong class="slate-bold">Step 2:</strong></u> Please send a POST request to the URL below after adding &quot;secret key&quot; in the authorization box in header section. For secret key please refer to this <a href="https://developers.paymob.com/egypt/api-reference-guide/api-setup-secret-and-public-key" target="_top">section.</a></p><div style="text-align:left"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/557b91de-edcc-4c12-b592-eab04b9a7a02.jpg" style="
              width:1507px;
	            height:105px;
	            aspect-ratio:1507 / 105"
         /></div><p class="slate-p " ><strong class="slate-bold">URL: https://accpet.paymob.com/v1/intention/</strong></p><p class="slate-p " ><strong class="slate-bold">Method</strong>: <em class="slate-italic">POST</em></p><p class="slate-p " ><strong class="slate-bold">Source</strong>: <em class="slate-italic">Merchant&apos;s server</em></p><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">Recipient</strong>: <em class="slate-italic">Accept&apos;s server</em>
</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 " >Please make sure to use the 3DS integration ID (normal card ID) while creating intention that will be used to create subscription once the customer pay.</p></div></div><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">You will receive a unique webhook URL from the webhook site for testing, as illustrated in the image below.</div></li></ul><div style="text-align:left"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/eddf3147-37dc-43c7-b139-97de4cb3c041.jpg" style="
              width:1507px;
	            height:463px;
	            aspect-ratio:1507 / 463"
         /></div><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><p class="slate-p " >To set your webhook URL for the Moto/3DS ID, follow these steps:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Navigate to the Developers section and set your webhook URL.</div></li><li class="slate-li " ><div style="position:relative">Then, go to the Payment Integration section.</div></li><li class="slate-li " ><div style="position:relative">Click on the integration ID.</div></li><li class="slate-li " ><div style="position:relative">In the lower section of the page, you can edit the integration details. Add your webhook URL in the &quot;Transaction Processed Callback&quot; section, as shown in the image below.</div></li></ul><div style="text-align:left"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/0c8d7422-dddb-4756-b4dc-fe9d11bb9c33.jpg" style="
              width:1507px;
	            height:403px;
	            aspect-ratio:1507 / 403"
         /></div><p class="slate-p slate-indent-0" style="0px">Once you perform the payment using the intention API below, including the <code class="slate-code">subscription_plan_id</code> and <code class="slate-code">subscription_start_date (optional Parameter)</code> in the request parameters, your subscription will be successfully created for the specific cardholder who completed the payment .</p><p class="slate-p " ><u class="slate-underline"><strong class="slate-bold">Step 3:</strong></u> Once you are done with the Intention you need to call below url in the browser&apos;s window to access the checkout page as shown below.
<u class="slate-underline"><strong class="slate-bold">https://accept.paymob.com/unifiedcheckout/?publicKey=&lt;add your public key here&gt;&amp;clientSecret=&lt;add your client secret key here&gt;</strong></u></p><h2 class="slate-h2 " >Obtaining Your Keys</h2><p class="slate-p " >To access your Public Key and Client Secret Key, please follow these instructions:</p><ol class="slate-ol " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Public Key:</strong> You can retrieve your Public Key from your Dashboard. For detailed steps, refer to the <a href="https://developers.paymob.com/egypt/api-reference-guide/api-setup-secret-and-public-key" target="">section</a> on accessing your Public Key.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Client Secret Key:</strong> Your Client Secret Key will be included in the response from the Intention API, as demonstrated in the example below.</div></li></ol><div style="text-align:left"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/1b5fe899-8b07-4340-9aee-2f301e48086f.jpg" style="
              width:1507px;
	            height:782px;
	            aspect-ratio:1507 / 782"
         /></div><p class="slate-p slate-indent-0" style="0px">Step 4: Please enter your card details. For test credentials, refer to this <a href="https://developers.paymob.com/egypt/checkout-copy-1/test-credentials-1" target="">section.</a></p><div style="text-align:left"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/bcedc60f-eab1-49c4-9bc9-2eae2765e8e6.jpg" style="
              width:1507px;
	            height:685px;
	            aspect-ratio:1507 / 685"
         /></div><p class="slate-p slate-indent-0" style="0px">Step 5: The approval message will be displayed on the screen if the transaction is successful.</p><div style="text-align:left"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/06f2272c-2aae-4ddb-8d25-08167e28293f.jpg" style="
              width:1507px;
	            height:560px;
	            aspect-ratio:1507 / 560"
         /></div><h3 class="slate-h3 " ><strong class="slate-bold">Webhook Responses:</strong></h3><p class="slate-p " ><u class="slate-underline"><strong class="slate-bold">Response 1:</strong></u><strong class="slate-bold"> Callback Response</strong></p><div style="text-align:left"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/82308916-a94f-4e29-bb6c-a15b0cd3c06e.jpg" style="
              width:1507px;
	            height:1081px;
	            aspect-ratio:1507 / 1081"
         /></div><p class="slate-p " ><u class="slate-underline"><strong class="slate-bold">Response: 2</strong></u><strong class="slate-bold"> Subscription Response</strong></p><div style="text-align:left"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/b494821d-b399-41aa-915a-403ba2613e90.jpg" style="
              width:1507px;
	            height:1013px;
	            aspect-ratio:1507 / 1013"
         /></div><p class="slate-p " ><u class="slate-underline"><strong class="slate-bold">Response 3:</strong></u><strong class="slate-bold"> Token</strong></p><p class="slate-p " >You will receive the token response only if you select the &quot;Save Card&quot; option on the checkout page as shown in the below image.</p><div style="text-align:left"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/029f9e6c-8d34-4eb1-9b68-cd11a9420829.jpg" style="
              width:1507px;
	            height:696px;
	            aspect-ratio:1507 / 696"
         /></div><p class="slate-p " ></p>

Create Subscriptions

<h3 class="slate-h3 " ><strong class="slate-bold">Suspend Subscription Plan API will temporarily deactivate the subscription plan.</strong></h3><p class="slate-p " ><u class="slate-underline"><strong class="slate-bold">Step 1:</strong></u><strong class="slate-bold"> </strong>First, you will run an Authentication request to get the Auth Bearer Token for Authorization as explained in the “<a href="https://developers.paymob.com/egypt/subscriptions-1/authentication-request-generate-token" target=""><span style="color:#000000"><strong class="slate-bold">Authentication Request (Generated Token)”</strong></span></a><span style="color:#000000"> </span>section.</p><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><p class="slate-p slate-indent-0" style="0px"><u class="slate-underline"><strong class="slate-bold">Step 2:</strong></u> The below API allows you to suspend a specific subscription plan identified by <code class="slate-code">{{SUBSCRIPTION_PLAN_ID}}</code>. To do so, please send a POST request to the URL below. Select &quot;Bearer Token&quot; as the authentication type and enter the authentication token in the token box of the authorization section.</p><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">URL: https://accept.paymob.com/api/acceptance/subscription-plans/{subscription-plan id}/suspend</strong></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 " >“You will just pass the subscription plan id in the above URL to suspend your subscription plan.”</p></div></div><p class="slate-p " ><strong class="slate-bold">Method</strong>: <em class="slate-italic">POST</em></p><p class="slate-p " ><strong class="slate-bold">Source</strong>: <em class="slate-italic">Merchant&apos;s server</em></p><p class="slate-p " ><strong class="slate-bold">Recipient</strong>: <em class="slate-italic">Accept&apos;s server</em></p><p class="slate-p " ><strong class="slate-bold">Authorization</strong>: <em class="slate-italic">Bearer Token {auth token} You need to enter the authentication token value in the token box, as shown in the image below.</em></p><div style="text-align:left"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/a9cbc319-4975-4d2d-a0fb-e3bb42e9ea7d.jpg" style="
              width:1082px;
	            height:343px;
	            aspect-ratio:1082 / 343"
         /></div><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><div style="width:100%;
	min-width:100%;" class="callout-widget" data-type=success ><div class="callout-icon"><svg width="18" height="18" viewBox="0 0 18 18" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M7.77116 10.8968L5.72949 8.8551C5.60449 8.7301 5.45171 8.6676 5.27116 8.6676C5.0906 8.6676 4.93088 8.73705 4.79199 8.87594C4.6531 9.01482 4.58366 9.17455 4.58366 9.3551C4.58366 9.53566 4.6531 9.68844 4.79199 9.81344L7.33366 12.3551C7.45866 12.4801 7.60449 12.5426 7.77116 12.5426C7.93783 12.5426 8.08366 12.4801 8.20866 12.3551L13.2087 7.3551C13.3337 7.2301 13.3927 7.07732 13.3857 6.89677C13.3788 6.71621 13.3128 6.56344 13.1878 6.43844C13.0628 6.29955 12.9066 6.2301 12.7191 6.2301C12.5316 6.2301 12.3684 6.29955 12.2295 6.43844L7.77116 10.8968ZM9.00033 17.3343C7.81977 17.3343 6.72255 17.1225 5.70866 16.6989C4.69477 16.2752 3.81283 15.6884 3.06283 14.9384C2.31283 14.1884 1.72602 13.3065 1.30241 12.2926C0.878798 11.2787 0.666992 10.1815 0.666992 9.00094C0.666992 7.83427 0.878798 6.74399 1.30241 5.7301C1.72602 4.71621 2.31283 3.83427 3.06283 3.08427C3.81283 2.33427 4.69477 1.74399 5.70866 1.31344C6.72255 0.88288 7.81977 0.667603 9.00033 0.667603C10.167 0.667603 11.2573 0.88288 12.2712 1.31344C13.285 1.74399 14.167 2.33427 14.917 3.08427C15.667 3.83427 16.2573 4.71621 16.6878 5.7301C17.1184 6.74399 17.3337 7.83427 17.3337 9.00094C17.3337 10.1815 17.1184 11.2787 16.6878 12.2926C16.2573 13.3065 15.667 14.1884 14.917 14.9384C14.167 15.6884 13.285 16.2752 12.2712 16.6989C11.2573 17.1225 10.167 17.3343 9.00033 17.3343ZM9.00033 16.0843C11.0142 16.0843 12.6982 15.4072 14.0524 14.053C15.4066 12.6989 16.0837 11.0148 16.0837 9.00094C16.0837 6.98705 15.4066 5.30302 14.0524 3.94885C12.6982 2.59469 11.0142 1.9176 9.00033 1.9176C6.98644 1.9176 5.30241 2.59469 3.94824 3.94885C2.59408 5.30302 1.91699 6.98705 1.91699 9.00094C1.91699 11.0148 2.59408 12.6989 3.94824 14.053C5.30241 15.4072 6.98644 16.0843 9.00033 16.0843Z" fill="#06837A"></path></svg></div><div ><p class="slate-p " >You will get the parameter <strong class="slate-bold">“is_active” as “false</strong>” which confirms that your subscription plan has been paused.</p></div></div><p class="slate-p " ><strong class="slate-bold">Response:</strong></p><div style="text-align:left"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/68253b4f-99b2-4047-bca8-373e27b59493.jpg" style="
              width:1082px;
	            height:600px;
	            aspect-ratio:1082 / 600"
         /></div><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><div class="slate-div"></div><p class="slate-p " ></p>

Suspend Subscription Plan

<h3 class="slate-h3 " ><strong class="slate-bold">Resume Subscription Plan API will resume your subscription plan.</strong></h3><p class="slate-p " ><u class="slate-underline"><strong class="slate-bold">Step 1:</strong></u> First, you will run an Authentication request to get the Auth Bearer Token for Authorization as explained in the “<a href="https://developers.paymob.com/egypt/subscriptions-1/authentication-request-generate-token" target=""><span style="color:#000000"><strong class="slate-bold">Authentication Request (Generated Token)”</strong></span></a><span style="color:#000000"> </span>section.</p><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><p class="slate-p slate-indent-0" style="0px"><u class="slate-underline"><strong class="slate-bold">Step 2:</strong></u> The below API allows you to suspend a specific subscription plan identified by <code class="slate-code">{{SUBSCRIPTION_PLAN_ID}}</code>. To do so, please send a POST request to the URL below. Select &quot;Bearer Token&quot; as the authentication type and enter the authentication token in the token box of the authorization section. </p><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">URL: https://accept.paymob.com/api/acceptance/subscription-plans/{subscription-plan id}/resume</strong></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 " >“You will just pass the subscription plan id in the above URL to resume your subscription plan.”</p></div></div><p class="slate-p " ><strong class="slate-bold">Method</strong>: <em class="slate-italic">POST</em></p><p class="slate-p " ><strong class="slate-bold">Source</strong>: <em class="slate-italic">Merchant&apos;s server</em></p><p class="slate-p " ><strong class="slate-bold">Recipient</strong>: <em class="slate-italic">Accept&apos;s server</em></p><p class="slate-p " ><strong class="slate-bold">Authorization</strong>: <em class="slate-italic">Bearer Token {auth token} You need to enter the authentication token value in the token box, as shown in the image below.</em></p><div style="text-align:left"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/a9cbc319-4975-4d2d-a0fb-e3bb42e9ea7d.jpg" style="
              width:1082px;
	            height:343px;
	            aspect-ratio:1082 / 343"
         /></div><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><div style="width:100%;
	min-width:100%;" class="callout-widget" data-type=success ><div class="callout-icon"><svg width="18" height="18" viewBox="0 0 18 18" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M7.77116 10.8968L5.72949 8.8551C5.60449 8.7301 5.45171 8.6676 5.27116 8.6676C5.0906 8.6676 4.93088 8.73705 4.79199 8.87594C4.6531 9.01482 4.58366 9.17455 4.58366 9.3551C4.58366 9.53566 4.6531 9.68844 4.79199 9.81344L7.33366 12.3551C7.45866 12.4801 7.60449 12.5426 7.77116 12.5426C7.93783 12.5426 8.08366 12.4801 8.20866 12.3551L13.2087 7.3551C13.3337 7.2301 13.3927 7.07732 13.3857 6.89677C13.3788 6.71621 13.3128 6.56344 13.1878 6.43844C13.0628 6.29955 12.9066 6.2301 12.7191 6.2301C12.5316 6.2301 12.3684 6.29955 12.2295 6.43844L7.77116 10.8968ZM9.00033 17.3343C7.81977 17.3343 6.72255 17.1225 5.70866 16.6989C4.69477 16.2752 3.81283 15.6884 3.06283 14.9384C2.31283 14.1884 1.72602 13.3065 1.30241 12.2926C0.878798 11.2787 0.666992 10.1815 0.666992 9.00094C0.666992 7.83427 0.878798 6.74399 1.30241 5.7301C1.72602 4.71621 2.31283 3.83427 3.06283 3.08427C3.81283 2.33427 4.69477 1.74399 5.70866 1.31344C6.72255 0.88288 7.81977 0.667603 9.00033 0.667603C10.167 0.667603 11.2573 0.88288 12.2712 1.31344C13.285 1.74399 14.167 2.33427 14.917 3.08427C15.667 3.83427 16.2573 4.71621 16.6878 5.7301C17.1184 6.74399 17.3337 7.83427 17.3337 9.00094C17.3337 10.1815 17.1184 11.2787 16.6878 12.2926C16.2573 13.3065 15.667 14.1884 14.917 14.9384C14.167 15.6884 13.285 16.2752 12.2712 16.6989C11.2573 17.1225 10.167 17.3343 9.00033 17.3343ZM9.00033 16.0843C11.0142 16.0843 12.6982 15.4072 14.0524 14.053C15.4066 12.6989 16.0837 11.0148 16.0837 9.00094C16.0837 6.98705 15.4066 5.30302 14.0524 3.94885C12.6982 2.59469 11.0142 1.9176 9.00033 1.9176C6.98644 1.9176 5.30241 2.59469 3.94824 3.94885C2.59408 5.30302 1.91699 6.98705 1.91699 9.00094C1.91699 11.0148 2.59408 12.6989 3.94824 14.053C5.30241 15.4072 6.98644 16.0843 9.00033 16.0843Z" fill="#06837A"></path></svg></div><div ><p class="slate-p " >You will get the parameter <strong class="slate-bold">“is_active” as “True</strong>” which confirms that your subscription plan has been resumed.</p></div></div><p class="slate-p " ><strong class="slate-bold">Response:</strong></p><div style="text-align:left"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/f18b63fb-5c30-449b-b9cd-a44a1b7a8b96.jpg" style="
              width:1082px;
	            height:568px;
	            aspect-ratio:1082 / 568"
         /></div><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><p class="slate-p " ></p>

Resume Subscription plan

<h3 class="slate-h3 " ><strong class="slate-bold">Update Subscription Plan API allows you to modify the subscription plan amount, number of deductions, and integration ID for a specific subscription plan.</strong></h3><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><p class="slate-p " ><u class="slate-underline"><strong class="slate-bold">Step 1:</strong></u> First, you will run an Authentication request to get the Auth Bearer Token for Authorization as explained in the “<a href="https://developers.paymob.com/egypt/subscriptions-1/authentication-request-generate-token" target=""><span style="color:#000000"><strong class="slate-bold">Authentication Request (Generated Token)”</strong></span></a><span style="color:#000000"> </span>section.</p><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><p class="slate-p slate-indent-0" style="0px"><u class="slate-underline"><strong class="slate-bold">Step 2:</strong></u> Please send a POST request to the URL below. Select &quot;Bearer Token&quot; as the authentication type and enter the authentication token in the token box of the authorization section and including subscription Plan amount, number of deductions, and integration id (moto) value in the request parameter. </p><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">URL: https://accept.paymob.com/api/acceptance/subscription-plans/{subscription-plan id}</strong></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 " >“You will just pass the subscription plan ID in the above URL to update the (subscription plan amount, number of deductions, and integration ID (moto) for a specific subscription plan. </p></div></div><p class="slate-p " ><strong class="slate-bold">Method</strong>: <em class="slate-italic">PUT</em></p><p class="slate-p " ><strong class="slate-bold">Source</strong>: <em class="slate-italic">Merchant&apos;s server</em></p><p class="slate-p " ><strong class="slate-bold">Recipient</strong>: <em class="slate-italic">Accept&apos;s server</em></p><p class="slate-p " ><strong class="slate-bold">Authorization</strong>: <em class="slate-italic">Bearer Token {auth token} You need to enter the authentication token value in the token box, as shown in the image below.</em></p><div style="text-align:left"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/a9cbc319-4975-4d2d-a0fb-e3bb42e9ea7d.jpg" style="
              width:1489px;
	            height:472px;
	            aspect-ratio:1489 / 472"
         /></div><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><p class="slate-p " ><strong class="slate-bold">Request:
</strong></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 " > All three of the parameters listed below in the request are optional.</p></div></div><div style="text-align:left"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/dc66f944-3879-4eec-8b46-094c5acedb32.jpg" style="
              width:1489px;
	            height:423px;
	            aspect-ratio:1489 / 423"
         /></div><p class="slate-p " ><strong class="slate-bold">Response:</strong></p><div style="text-align:left"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/d46c4db8-848d-4738-b2bd-4c81336c6615.jpg" style="
              width:1489px;
	            height:540px;
	            aspect-ratio:1489 / 540"
         /></div><div class="slate-div"></div><div class="slate-div"></div><p class="slate-p " ></p>

Update Subscription Plan

<h3 class="slate-h3 " ><strong class="slate-bold">List Subscription Plan API  is utilized to retrieve a list of all subscription plans associated with a specific merchant.</strong></h3><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><p class="slate-p " ><u class="slate-underline"><strong class="slate-bold">Step 1:</strong></u><strong class="slate-bold"> </strong>First, you will run an Authentication request to get the Auth Bearer Token for Authorization as explained in the “<a href="https://developers.paymob.com/egypt/subscriptions-1/authentication-request-generate-token" target=""><span style="color:#000000"><strong class="slate-bold">Authentication Request (Generated Token)”</strong></span></a><span style="color:#000000"> </span>section.</p><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><p class="slate-p slate-indent-0" style="0px"><u class="slate-underline"><strong class="slate-bold">Step 2:</strong></u> Please send a GET request to the URL below. Select &quot;Bearer Token&quot; as the authentication type and enter the authentication token in the token box of the authorization section. </p><p class="slate-p " ><strong class="slate-bold">URL: https://accept.paymob.com/api/acceptance/subscription-plans</strong></p><p class="slate-p " ><strong class="slate-bold">Method</strong>: <em class="slate-italic">GET</em></p><p class="slate-p " ><strong class="slate-bold">Source</strong>: <em class="slate-italic">Merchant&apos;s server</em></p><p class="slate-p " ><strong class="slate-bold">Recipient</strong>: <em class="slate-italic">Accept&apos;s server</em></p><p class="slate-p " ><strong class="slate-bold">Authorization</strong>: <em class="slate-italic">Bearer Token {auth token} You need to enter the authentication token value in the token box, as shown in the image below.</em></p><div style="text-align:left"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/a9cbc319-4975-4d2d-a0fb-e3bb42e9ea7d.jpg" style="
              width:1082px;
	            height:343px;
	            aspect-ratio:1082 / 343"
         /></div><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><p class="slate-p " ><strong class="slate-bold">Response:</strong></p><div style="text-align:left"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/25673d9e-1626-4ffb-9e0c-c98c31b1a8a3.jpg" style="
              width:1082px;
	            height:577px;
	            aspect-ratio:1082 / 577"
         /></div><p class="slate-p " ></p>

List Subscription Plans

<h3 class="slate-h3 " ><strong class="slate-bold">Suspend Subscription API allows you to suspend a subscription and temporarily stop its active billing.</strong></h3><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><p class="slate-p " ><u class="slate-underline"><strong class="slate-bold">Step 1:</strong></u><strong class="slate-bold"> </strong>First, you will run an Authentication request to get the Auth Bearer Token for Authorization as explained in the “<a href="https://developers.paymob.com/egypt/subscriptions-1/authentication-request-generate-token" target=""><span style="color:#000000"><strong class="slate-bold">Authentication Request (Generated Token)”</strong></span></a><span style="color:#000000"> </span>section.</p><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><p class="slate-p slate-indent-0" style="0px"><u class="slate-underline"><strong class="slate-bold">Step 2:</strong></u> Please send a POST request to the URL below. Select &quot;Bearer Token&quot; as the authentication type and enter the authentication token in the token box of the authorization section. </p><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">URL: https://accept.paymob.com/api/acceptance/subscriptions/{subscription- id}/suspend</strong></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 " >“You will just pass the subscription ID in the above URL to suspend your subscription .”</p></div></div><p class="slate-p " ><strong class="slate-bold">Method</strong>: <em class="slate-italic">POST</em></p><p class="slate-p " ><strong class="slate-bold">Source</strong>: <em class="slate-italic">Merchant&apos;s server</em></p><p class="slate-p " ><strong class="slate-bold">Recipient</strong>: <em class="slate-italic">Accept&apos;s server</em></p><p class="slate-p " ><strong class="slate-bold">Authorization</strong>: <em class="slate-italic">Bearer Token {auth token} You need to enter the authentication token value in the token box, as shown in the image below.</em></p><div style="text-align:left"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/a9cbc319-4975-4d2d-a0fb-e3bb42e9ea7d.jpg" style="
              width:1489px;
	            height:472px;
	            aspect-ratio:1489 / 472"
         /></div><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><div style="width:100%;
	min-width:100%;" class="callout-widget" data-type=success ><div class="callout-icon"><svg width="18" height="18" viewBox="0 0 18 18" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M7.77116 10.8968L5.72949 8.8551C5.60449 8.7301 5.45171 8.6676 5.27116 8.6676C5.0906 8.6676 4.93088 8.73705 4.79199 8.87594C4.6531 9.01482 4.58366 9.17455 4.58366 9.3551C4.58366 9.53566 4.6531 9.68844 4.79199 9.81344L7.33366 12.3551C7.45866 12.4801 7.60449 12.5426 7.77116 12.5426C7.93783 12.5426 8.08366 12.4801 8.20866 12.3551L13.2087 7.3551C13.3337 7.2301 13.3927 7.07732 13.3857 6.89677C13.3788 6.71621 13.3128 6.56344 13.1878 6.43844C13.0628 6.29955 12.9066 6.2301 12.7191 6.2301C12.5316 6.2301 12.3684 6.29955 12.2295 6.43844L7.77116 10.8968ZM9.00033 17.3343C7.81977 17.3343 6.72255 17.1225 5.70866 16.6989C4.69477 16.2752 3.81283 15.6884 3.06283 14.9384C2.31283 14.1884 1.72602 13.3065 1.30241 12.2926C0.878798 11.2787 0.666992 10.1815 0.666992 9.00094C0.666992 7.83427 0.878798 6.74399 1.30241 5.7301C1.72602 4.71621 2.31283 3.83427 3.06283 3.08427C3.81283 2.33427 4.69477 1.74399 5.70866 1.31344C6.72255 0.88288 7.81977 0.667603 9.00033 0.667603C10.167 0.667603 11.2573 0.88288 12.2712 1.31344C13.285 1.74399 14.167 2.33427 14.917 3.08427C15.667 3.83427 16.2573 4.71621 16.6878 5.7301C17.1184 6.74399 17.3337 7.83427 17.3337 9.00094C17.3337 10.1815 17.1184 11.2787 16.6878 12.2926C16.2573 13.3065 15.667 14.1884 14.917 14.9384C14.167 15.6884 13.285 16.2752 12.2712 16.6989C11.2573 17.1225 10.167 17.3343 9.00033 17.3343ZM9.00033 16.0843C11.0142 16.0843 12.6982 15.4072 14.0524 14.053C15.4066 12.6989 16.0837 11.0148 16.0837 9.00094C16.0837 6.98705 15.4066 5.30302 14.0524 3.94885C12.6982 2.59469 11.0142 1.9176 9.00033 1.9176C6.98644 1.9176 5.30241 2.59469 3.94824 3.94885C2.59408 5.30302 1.91699 6.98705 1.91699 9.00094C1.91699 11.0148 2.59408 12.6989 3.94824 14.053C5.30241 15.4072 6.98644 16.0843 9.00033 16.0843Z" fill="#06837A"></path></svg></div><div ><p class="slate-p " >In response to the Suspend API request, the response body will include the current state of the subscription, indicated by the parameter &quot;state&quot;: &quot;suspended&quot;. Additionally, the response will contain the parameters &quot;resumed_at&quot; and &quot;suspended_at&quot;, which provide timestamps for when the subscription was resumed and suspended, respectively.</p></div></div><p class="slate-p " ><strong class="slate-bold">Response:</strong></p><div style="text-align:left"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/2dbfe96b-1bec-4467-91ac-82a3ca288060.jpg" style="
              width:1489px;
	            height:842px;
	            aspect-ratio:1489 / 842"
         /></div><p class="slate-p " ></p>

Suspend Subscription

<h3 class="slate-h3 " ><strong class="slate-bold">Resume Subscription API allows you to reactivate a subscription and resume billing.</strong></h3><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><p class="slate-p " ><u class="slate-underline"><strong class="slate-bold">Step 1:</strong></u><strong class="slate-bold"> </strong>First, you will run an Authentication request to get the Auth Bearer Token for Authorization as explained in the “<a href="https://developers.paymob.com/egypt/subscriptions-1/authentication-request-generate-token" target=""><span style="color:#000000"><strong class="slate-bold">Authentication Request (Generated Token)”</strong></span></a><span style="color:#000000"> </span>section.</p><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><p class="slate-p slate-indent-0" style="0px"><u class="slate-underline"><strong class="slate-bold">Step 2:</strong></u> Please send a POST request to the URL below. Select &quot;Bearer Token&quot; as the authentication type and enter the authentication token in the token box of the authorization section. </p><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">URL: https://accept.paymob.com/api/acceptance/subscriptions/{subscription- id}/resume</strong></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 " >“You will just pass the subscription ID in the above URL to resume your subscription .”</p></div></div><p class="slate-p " ><strong class="slate-bold">Method</strong>: <em class="slate-italic">POST</em></p><p class="slate-p " ><strong class="slate-bold">Source</strong>: <em class="slate-italic">Merchant&apos;s server</em></p><p class="slate-p " ><strong class="slate-bold">Recipient</strong>: <em class="slate-italic">Accept&apos;s server</em></p><p class="slate-p " ><strong class="slate-bold">Authorization</strong>: <em class="slate-italic">Bearer Token {auth token} You need to enter the authentication token value in the token box, as shown in the image below.</em></p><div style="text-align:left"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/a9cbc319-4975-4d2d-a0fb-e3bb42e9ea7d.jpg" style="
              width:1082px;
	            height:343px;
	            aspect-ratio:1082 / 343"
         /></div><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><div style="width:100%;
	min-width:100%;" class="callout-widget" data-type=success ><div class="callout-icon"><svg width="18" height="18" viewBox="0 0 18 18" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M7.77116 10.8968L5.72949 8.8551C5.60449 8.7301 5.45171 8.6676 5.27116 8.6676C5.0906 8.6676 4.93088 8.73705 4.79199 8.87594C4.6531 9.01482 4.58366 9.17455 4.58366 9.3551C4.58366 9.53566 4.6531 9.68844 4.79199 9.81344L7.33366 12.3551C7.45866 12.4801 7.60449 12.5426 7.77116 12.5426C7.93783 12.5426 8.08366 12.4801 8.20866 12.3551L13.2087 7.3551C13.3337 7.2301 13.3927 7.07732 13.3857 6.89677C13.3788 6.71621 13.3128 6.56344 13.1878 6.43844C13.0628 6.29955 12.9066 6.2301 12.7191 6.2301C12.5316 6.2301 12.3684 6.29955 12.2295 6.43844L7.77116 10.8968ZM9.00033 17.3343C7.81977 17.3343 6.72255 17.1225 5.70866 16.6989C4.69477 16.2752 3.81283 15.6884 3.06283 14.9384C2.31283 14.1884 1.72602 13.3065 1.30241 12.2926C0.878798 11.2787 0.666992 10.1815 0.666992 9.00094C0.666992 7.83427 0.878798 6.74399 1.30241 5.7301C1.72602 4.71621 2.31283 3.83427 3.06283 3.08427C3.81283 2.33427 4.69477 1.74399 5.70866 1.31344C6.72255 0.88288 7.81977 0.667603 9.00033 0.667603C10.167 0.667603 11.2573 0.88288 12.2712 1.31344C13.285 1.74399 14.167 2.33427 14.917 3.08427C15.667 3.83427 16.2573 4.71621 16.6878 5.7301C17.1184 6.74399 17.3337 7.83427 17.3337 9.00094C17.3337 10.1815 17.1184 11.2787 16.6878 12.2926C16.2573 13.3065 15.667 14.1884 14.917 14.9384C14.167 15.6884 13.285 16.2752 12.2712 16.6989C11.2573 17.1225 10.167 17.3343 9.00033 17.3343ZM9.00033 16.0843C11.0142 16.0843 12.6982 15.4072 14.0524 14.053C15.4066 12.6989 16.0837 11.0148 16.0837 9.00094C16.0837 6.98705 15.4066 5.30302 14.0524 3.94885C12.6982 2.59469 11.0142 1.9176 9.00033 1.9176C6.98644 1.9176 5.30241 2.59469 3.94824 3.94885C2.59408 5.30302 1.91699 6.98705 1.91699 9.00094C1.91699 11.0148 2.59408 12.6989 3.94824 14.053C5.30241 15.4072 6.98644 16.0843 9.00033 16.0843Z" fill="#06837A"></path></svg></div><div ><p class="slate-p " >In response to the Resume API request, the response body will include the current state of the subscription, indicated by the parameter <code class="slate-code">&quot;state&quot;: &quot;active&quot;</code>. Additionally, the response will contain the parameters <code class="slate-code">&quot;resumed_at&quot;</code> and <code class="slate-code">&quot;suspended_at&quot;</code>, which provide timestamps for when the subscription was resumed and suspended, respectively.</p></div></div><p class="slate-p " ><strong class="slate-bold">Response:</strong></p><div style="text-align:left"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/30aab17c-dfbb-4291-a835-8dfc7647b48c.jpg" style="
              width:1082px;
	            height:615px;
	            aspect-ratio:1082 / 615"
         /></div><p class="slate-p " ></p>

Resume Subscription

<h3 class="slate-h3 " ><strong class="slate-bold">Cancel Subscription API allows you to cancel your subscription. Only suspended subscriptions can be resumed; canceling a subscription will permanently terminate it.</strong></h3><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><p class="slate-p " ><u class="slate-underline"><strong class="slate-bold">Step 1:</strong></u><strong class="slate-bold"> </strong>First, you will run an Authentication request to get the Auth Bearer Token for Authorization as explained in the “<a href="https://developers.paymob.com/egypt/subscriptions-1/authentication-request-generate-token" target=""><span style="color:#000000"><strong class="slate-bold">Authentication Request (Generated Token)”</strong></span></a><span style="color:#000000"> </span>section.</p><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><p class="slate-p slate-indent-0" style="0px"><u class="slate-underline"><strong class="slate-bold">Step 2:</strong></u> Pease send a POST request to the URL below. Select &quot;Bearer Token&quot; as the authentication type and enter the authentication token in the token box of the authorization section. </p><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">URL: https://accept.paymob.com/api/acceptance/subscriptions/{subscription- id}/cancel</strong></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 " >“You will just pass the subscription id in the above URL to cancel your subscription .</p></div></div><p class="slate-p " ><strong class="slate-bold">Method</strong>: <em class="slate-italic">POST</em></p><p class="slate-p " ><strong class="slate-bold">Source</strong>: <em class="slate-italic">Merchant&apos;s server</em></p><p class="slate-p " ><strong class="slate-bold">Recipient</strong>: <em class="slate-italic">Accept&apos;s server</em></p><p class="slate-p " ><strong class="slate-bold">Authorization</strong>: <em class="slate-italic">Bearer Token {auth token} You need to enter the authentication token value in the token box, as shown in the image below.</em></p><div style="text-align:left"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/a9cbc319-4975-4d2d-a0fb-e3bb42e9ea7d.jpg" style="
              width:1082px;
	            height:343px;
	            aspect-ratio:1082 / 343"
         /></div><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><p class="slate-p " ></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 slate-indent-0" style="0px">In response to the Cancel Subscription API request ,you will receive a state of the subscription in the response parameters as mentioned above in response body i.e. <strong class="slate-bold">&quot;state&quot;: &quot;canceled&quot;. </strong>You can also find the<strong class="slate-bold"> &quot;resumed at&quot;</strong> and <strong class="slate-bold">&quot;suspended at&quot;</strong> parameters in the response body.</p></div></div><p class="slate-p " ><strong class="slate-bold">Response:</strong></p><p class="slate-p " ></p><div class="slate-div"></div><p class="slate-p " ></p><div class="slate-div"></div><p class="slate-p slate-indent-0" style="0px">In response to the Cancel Subscription API request ,you will receive a state of the subscription in the response parameters as mentioned above in response body i.e. <strong class="slate-bold">&quot;state&quot;: &quot;canceled&quot;.</strong>
You can also find the<strong class="slate-bold"> &quot;resumed at&quot;</strong> and <strong class="slate-bold">&quot;suspended at&quot;</strong> parameters in the response body.</p><p class="slate-p " ></p>

Cancel Subscription

<h3 class="slate-h3 " ><strong class="slate-bold">Update Subscription API allows you to modify the subscription amount and the subscription end date for a specific subscription.</strong></h3><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><p class="slate-p " ><u class="slate-underline"><strong class="slate-bold">Step 1:</strong></u><strong class="slate-bold"> </strong>First, you will run an Authentication request to get the Auth Bearer Token for Authorization as explained in the “<a href="https://developers.paymob.com/egypt/subscriptions-1/authentication-request-generate-token" target=""><span style="color:#000000"><strong class="slate-bold">Authentication Request (Generated Token)”</strong></span></a><span style="color:#000000"> </span>section.</p><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><p class="slate-p slate-indent-0" style="0px"><u class="slate-underline"><strong class="slate-bold">Step 2:</strong></u> Please send a PUT request to the URL below. Select &quot;Bearer Token&quot; as the authentication type and enter the authentication token in the token box of the authorization section. </p><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">URL: https://accept.paymob.com/api/acceptance/subscriptions/{subscription- id}</strong></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 " >“You will just pass the subscription id in the above URL to update your subscription .”</p></div></div><p class="slate-p " ><strong class="slate-bold">Method</strong>: <em class="slate-italic">PUT</em></p><p class="slate-p " ><strong class="slate-bold">Source</strong>: <em class="slate-italic">Merchant&apos;s server</em></p><p class="slate-p " ><strong class="slate-bold">Recipient</strong>: <em class="slate-italic">Accept&apos;s server</em></p><p class="slate-p " ><strong class="slate-bold">Authorization</strong>: <em class="slate-italic">Bearer Token {auth token} You need to enter the authentication token value in the token box, as shown in the image below.</em></p><div style="text-align:left"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/a9cbc319-4975-4d2d-a0fb-e3bb42e9ea7d.jpg" style="
              width:1489px;
	            height:472px;
	            aspect-ratio:1489 / 472"
         /></div><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><p class="slate-p " ><strong class="slate-bold">Request: </strong></p><div style="text-align:left"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/67735d38-9c42-4556-8c46-fbb8fd5cbb39.jpg" style="
              width:1489px;
	            height:420px;
	            aspect-ratio:1489 / 420"
         /></div><p class="slate-p " ><strong class="slate-bold">Response:</strong></p><div style="text-align:left"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/9d3f993c-1370-4203-a831-6f7a79254939.jpg" style="
              width:1489px;
	            height:558px;
	            aspect-ratio:1489 / 558"
         /></div><div class="slate-div"></div><p class="slate-p " ></p>

Update Subscription

<h3 class="slate-h3 " ><strong class="slate-bold">List Subscription Card API allows you to retrieve a list of card tokens associated with a specific subscription.</strong></h3><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><p class="slate-p " ><u class="slate-underline"><strong class="slate-bold">Step 1:</strong></u><strong class="slate-bold"> </strong>First, you will run an Authentication request to get the Auth Bearer Token for Authorization as explained in the “<a href="https://developers.paymob.com/egypt/subscriptions-1/authentication-request-generate-token" target=""><span style="color:#000000"><strong class="slate-bold">Authentication Request (Generated Token)”</strong></span></a><span style="color:#000000"> </span>section.</p><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><p class="slate-p slate-indent-0" style="0px"><u class="slate-underline"><strong class="slate-bold">Step 2:</strong></u>  Please send a GET request to the URL below. Select &quot;Bearer Token&quot; as the authentication type and enter the authentication token in the token box of the authorization section.</p><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">URL: https://accept.paymob.com/api/acceptance/subscriptions/{Subscription_Id}/card-tokens</strong></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 " >“You will just pass the subscription ID in the above URL to retrieve a list of card tokens associated with a specific subscription identified by<code class="slate-code">{SUBSCRIPTION_ID}}</code>.</p></div></div><p class="slate-p " ><strong class="slate-bold">Method</strong>: GET</p><p class="slate-p " ><strong class="slate-bold">Source</strong>: <em class="slate-italic">Merchant&apos;s server</em></p><p class="slate-p " ><strong class="slate-bold">Recipient</strong>: <em class="slate-italic">Accept&apos;s server</em></p><p class="slate-p " ><strong class="slate-bold">Authorization</strong>: <em class="slate-italic">Bearer Token {auth token} You need to enter the authentication token value in the token box, as shown in the image below.</em></p><div style="text-align:left"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/a9cbc319-4975-4d2d-a0fb-e3bb42e9ea7d.jpg" style="
              width:1082px;
	            height:343px;
	            aspect-ratio:1082 / 343"
         /></div><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><p class="slate-p " ><strong class="slate-bold">Response:</strong></p><div style="text-align:left"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/234d4208-4844-4ebb-913d-cebb0328486e.jpg" style="
              width:1082px;
	            height:647px;
	            aspect-ratio:1082 / 647"
         /></div><p class="slate-p " ></p>

List Subscription Cards 

<h3 class="slate-h3 " ><strong class="slate-bold">Change Subscription Primary Card API allows you to change the primary card associated with a specific subscription.</strong></h3><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><p class="slate-p " ><u class="slate-underline"><strong class="slate-bold">Step 1:</strong></u><strong class="slate-bold"> </strong>First, you will run an Authentication request to get the Auth Bearer Token for Authorization as explained in the “<a href="https://developers.paymob.com/egypt/subscriptions-1/authentication-request-generate-token" target=""><span style="color:#000000"><strong class="slate-bold">Authentication Request (Generated Token)”</strong></span></a><span style="color:#000000"> </span>section.</p><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><p class="slate-p slate-indent-0" style="0px"><u class="slate-underline"><strong class="slate-bold">Step 2:</strong></u> Please send a POST request to the URL below. Select &quot;Bearer Token&quot; as the authentication type and enter the authentication token in the token box of the authorization section.</p><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">URL: https://accept.paymob.com/api/acceptance/subscriptions/{Subscription_Id}/change-primary-card</strong>
</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 " >“You will just pass the subscription ID in the above URL to change the primary card associated with a specific subscription.</p></div></div><p class="slate-p " ><strong class="slate-bold">Method</strong>: <em class="slate-italic">POST</em></p><p class="slate-p " ><strong class="slate-bold">Source</strong>: <em class="slate-italic">Merchant&apos;s server</em></p><p class="slate-p " ><strong class="slate-bold">Recipient</strong>: <em class="slate-italic">Accept&apos;s server</em></p><p class="slate-p " ><strong class="slate-bold">Authorization</strong>: <em class="slate-italic">Bearer Token {auth token} You need to enter the authentication token value in the token box, as shown in the image below.</em></p><div style="text-align:left"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/a9cbc319-4975-4d2d-a0fb-e3bb42e9ea7d.jpg" style="
              width:1082px;
	            height:343px;
	            aspect-ratio:1082 / 343"
         /></div><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">Step 3: </strong>You can obtain the Card ID by using the &quot;subscriptionv2_id&quot; parameter in the intention request and Perform the transaction with another card. After completing the transaction, you will get the card id in the response of the list of subscription cards.</p><div style="text-align:left"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/24889166-a462-48f4-8d19-5dbf700efc99.jpg" style="
              width:1082px;
	            height:338px;
	            aspect-ratio:1082 / 338"
         /></div><div style="text-align:left"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/2482cc45-d39b-4817-bb77-f309d5084121.jpg" style="
              width:1082px;
	            height:603px;
	            aspect-ratio:1082 / 603"
         /></div><p class="slate-p " ><strong class="slate-bold">Step 4: </strong>Please specify the new card by including its card identifier in the request parameter to set it as the primary card.</p><p class="slate-p " ><strong class="slate-bold">Request:</strong></p><div style="text-align:left"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/12c40816-33f4-4db6-bc6c-97494f627ac9.jpg" style="
              width:1082px;
	            height:332px;
	            aspect-ratio:1082 / 332"
         /></div><p class="slate-p " ><strong class="slate-bold">Response:</strong></p><div style="text-align:left"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/010a205a-346e-4580-9e44-3a06e78bae15.jpg" style="
              width:1082px;
	            height:406px;
	            aspect-ratio:1082 / 406"
         /></div><div class="slate-div"></div><p class="slate-p " ></p>

Change Subscription Primary card

<h3 class="slate-h3 " ><strong class="slate-bold">Delete Secondary Card API allows you to delete a specific card associated with a subscription.</strong></h3><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><p class="slate-p " ><u class="slate-underline"><strong class="slate-bold">Step 1:</strong></u><strong class="slate-bold"> </strong>First, you will run an Authentication request to get the Auth Bearer Token for Authorization as explained in the “<a href="https://developers.paymob.com/egypt/subscriptions-1/authentication-request-generate-token" target=""><span style="color:#000000"><strong class="slate-bold">Authentication Request (Generated Token)”</strong></span></a><span style="color:#000000"> </span>section.</p><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><p class="slate-p slate-indent-0" style="0px"><u class="slate-underline"><strong class="slate-bold">Step 2:</strong></u> Please send a POST request to the URL below. Select &quot;Bearer Token&quot; as the authentication type and enter the authentication token in the token box of the authorization section. </p><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">URL: https://accept.paymob.com/api/acceptance/subscriptions/{Subscription_id}/delete-card</strong></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 ><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">You will just pass the subscription id in the above URL to delete a specific card associated with a subscription. </div></li><li class="slate-li " ><div style="position:relative">You cannot delete the primary card; only secondary cards can be removed. To delete a primary card, you must first add a secondary card and set it as the primary card. Once the secondary card is designated as the primary, you can then delete the original primary card.</div></li></ul></div></div><p class="slate-p " ><strong class="slate-bold">Method</strong>: <em class="slate-italic">POST</em></p><p class="slate-p " ><strong class="slate-bold">Source</strong>: <em class="slate-italic">Merchant&apos;s server</em></p><p class="slate-p " ><strong class="slate-bold">Recipient</strong>: <em class="slate-italic">Accept&apos;s server</em></p><p class="slate-p " ><strong class="slate-bold">Authorization</strong>: <em class="slate-italic">Bearer Token {auth token} You need to enter the authentication token value in the token box, as shown in the image below.</em></p><div style="text-align:left"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/a9cbc319-4975-4d2d-a0fb-e3bb42e9ea7d.jpg" style="
              width:1082px;
	            height:343px;
	            aspect-ratio:1082 / 343"
         /></div><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><p class="slate-p " ><strong class="slate-bold">Step 3:</strong> To delete a secondary card, please include its card identifier in the request parameter. </p><p class="slate-p " ><strong class="slate-bold">Request:</strong></p><div style="text-align:left"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/b392ca03-33f3-4ff9-a407-d45dd0f7ad86.jpg" style="
              width:1082px;
	            height:330px;
	            aspect-ratio:1082 / 330"
         /></div><p class="slate-p " ><strong class="slate-bold">Response:</strong></p>

Delete Secondary Card

<h3 class="slate-h3 " ><strong class="slate-bold">List Subscription Details API allows you to retrieve detailed information for a specific subscription using its unique subscription ID or get all subscriptions associated with the specific merchant.</strong></h3><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><p class="slate-p " ><u class="slate-underline"><strong class="slate-bold">Step 1:</strong></u><strong class="slate-bold"> </strong>First, you will run an Authentication request to get the Auth Bearer Token for Authorization as explained in the “<a href="https://developers.paymob.com/egypt/subscriptions-1/authentication-request-generate-token" target=""><span style="color:#000000"><strong class="slate-bold">Authentication Request (Generated Token)”</strong></span></a><span style="color:#000000"> </span>section.</p><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><p class="slate-p slate-indent-0" style="0px"><u class="slate-underline"><strong class="slate-bold">Step 2:</strong></u> Please send a GET request to the URL below. Select &quot;Bearer Token&quot; as the authentication type and enter the authentication token in the token box of the authorization section. </p><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">URL: https://accept.paymob.com/api/acceptance/subscriptions/{Subscription_id}</strong></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 ><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">You will just pass the subscription id in the above URL  allows you to retrieve list of all subscription details against one specific subscription ID. </div></li><li class="slate-li " ><div style="position:relative">Please note that if you do not add any subscription id at the end of the URL, you will get all subscriptions associated with the specific merchant.</div></li></ul></div></div><p class="slate-p " ><strong class="slate-bold">Method</strong>: GET</p><p class="slate-p " ><strong class="slate-bold">Source</strong>: <em class="slate-italic">Merchant&apos;s server</em></p><p class="slate-p " ><strong class="slate-bold">Recipient</strong>: <em class="slate-italic">Accept&apos;s server</em></p><p class="slate-p " ><strong class="slate-bold">Authorization</strong>: <em class="slate-italic">Bearer Token {auth token} You need to enter the authentication token value in the token box, as shown in the image below.</em></p><div style="text-align:left"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/a9cbc319-4975-4d2d-a0fb-e3bb42e9ea7d.jpg" style="
              width:1489px;
	            height:472px;
	            aspect-ratio:1489 / 472"
         /></div><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><p class="slate-p " ><strong class="slate-bold">Response:</strong></p><div style="text-align:left"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/fe944116-8141-4b27-90bf-ef51f25b4d5b.jpg" style="
              width:1489px;
	            height:914px;
	            aspect-ratio:1489 / 914"
         /></div><p class="slate-p slate-indent-0" style="0px"><u class="slate-underline"><strong class="slate-bold">Response with Parameters Description:</strong></u></p><div class="table-container" style="width:98%;
  min-width:98%;"><table class="slate-table" style="min-width:100%"><div class="published-table-header" style="width:100%;min-width:100%;min-height:initial;visibility: hidden;border:initial"><div style="width:338px;">Title</div><div style="width:0px;">Description</div></div><colgroup ><col style="width:338px"><col style="width:initial"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">Parameter</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">Description</strong></p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">ID (id):</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">Each subscription has a unique identifier. This can be useful for tracking and managing subscriptions.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">Client Information (client_info):</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">Provides details about the client who subscribed, including full name, email, and phone number. Merchants can use this information for customer management and communication.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">Frequency (frequency):</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">Indicates how often the subscription renews</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">Created and Updated Dates (created_at, updated_at)</strong>:</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">Timestamps that help merchants keep track of when the subscription was created and last updated.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">Name (name):</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">Name associated with the subscription. It could be the product or service name or any custom name assigned by the client.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">Reminder and Retrial Days (reminder_days, retrial_days): </strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">Specifies the number of days before the next billing for sending reminders and retrial attempts. Merchants can automate communication and payment recovery processes based on these values.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">Plan ID (plan_id): </strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">Identifies the specific plan or tier of the subscription. Useful for categorizing and managing different subscription levels.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">State (state): </strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">Starts, Next Billing, Reminder, and Ends Dates (starts_at, next_billing, reminder_date, ends_at):</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">Amount (amount_cents):</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">Specifies the subscription amount in cents. Merchants can use this information for financial reporting and analysis.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">Starts, Next Billing, Reminder, and Ends Dates (starts_at, next_billing, reminder_date, ends_at):</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">Important dates related to the subscription lifecycle. Helps merchants in planning and managing subscription events.</p></td></div></tr></tbody></table></div><p class="slate-p " ></p><p class="slate-p " ></p>

List Subscription Details

<h3 class="slate-h3 " ><span style="color:#000000"><strong class="slate-bold">Transaction ID Subscriptions API is used to retrieve subscriptions associated with a specific transaction.</strong></span></h3><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><p class="slate-p " ><u class="slate-underline"><strong class="slate-bold">Step 1:</strong></u><strong class="slate-bold"> </strong>First, you will run an Authentication request to get the Auth Bearer Token for Authorization as explained in the “<a href="https://developers.paymob.com/egypt/subscriptions-1/authentication-request-generate-token" target=""><span style="color:#000000"><strong class="slate-bold">Authentication Request (Generated Token)”</strong></span></a><span style="color:#000000"> </span>section.</p><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><p class="slate-p slate-indent-0" style="0px"><u class="slate-underline"><strong class="slate-bold">Step 2:</strong></u> Please send a GET request to the URL below. Select &quot;Bearer Token&quot; as the authentication type and enter the authentication token in the token box of the authorization section. </p><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">URL: https://accept.paymob.com/api/acceptance/subscriptions?transaction={Transaction ID}</strong></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 " >“You will just pass the transaction id in the above URL  allows you  to retrieve subscriptions related to a transaction.</p></div></div><p class="slate-p " ><strong class="slate-bold">Method</strong>: GET</p><p class="slate-p " ><strong class="slate-bold">Source</strong>: <em class="slate-italic">Merchant&apos;s server</em></p><p class="slate-p " ><strong class="slate-bold">Recipient</strong>: <em class="slate-italic">Accept&apos;s server</em></p><p class="slate-p " ><strong class="slate-bold">Authorization</strong>: <em class="slate-italic">Bearer Token {auth token} You need to enter the authentication token value in the token box, as shown in the image below.</em></p><div style="text-align:left"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/a9cbc319-4975-4d2d-a0fb-e3bb42e9ea7d.jpg" style="
              width:1082px;
	            height:343px;
	            aspect-ratio:1082 / 343"
         /></div><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><p class="slate-p " ><strong class="slate-bold">Response:</strong></p><div style="text-align:left"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/eadd4989-78f3-4fba-8aa6-2f975599062a.jpg" style="
              width:1082px;
	            height:653px;
	            aspect-ratio:1082 / 653"
         /></div><p class="slate-p " ></p>

Transaction ID Subscriptions

<h3 class="slate-h3 " ><strong class="slate-bold">Last Transaction Subscription API allows you to retrieve the last transaction details associated with a specific subscription.</strong></h3><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><p class="slate-p " ><u class="slate-underline"><strong class="slate-bold">Step 1:</strong></u><strong class="slate-bold"> </strong>First, you will run an Authentication request to get the Auth Bearer Token for Authorization as explained in the “<a href="https://developers.paymob.com/egypt/subscriptions-1/authentication-request-generate-token" target=""><span style="color:#000000"><strong class="slate-bold">Authentication Request (Generated Token)”</strong></span></a><span style="color:#000000"> </span>section.</p><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><p class="slate-p slate-indent-0" style="0px"><u class="slate-underline"><strong class="slate-bold">Step 2:</strong></u> Please send a GET request to the URL below. Select &quot;Bearer Token&quot; as the authentication type and enter the authentication token in the token box of the authorization section. </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 " >“You will just pass the subscription id in the above URL to retrieve the last transaction associated with a specific subscription.</p></div></div><p class="slate-p " ><strong class="slate-bold">URL: https://accept.paymob.com/api/acceptance/subscriptions/{Subscription_Id}/last-transaction</strong></p><p class="slate-p " ><strong class="slate-bold">Method</strong>: <em class="slate-italic">GET</em></p><p class="slate-p " ><strong class="slate-bold">Source</strong>: <em class="slate-italic">Merchant&apos;s server</em></p><p class="slate-p " ><strong class="slate-bold">Recipient</strong>: <em class="slate-italic">Accept&apos;s server</em></p><p class="slate-p " ><strong class="slate-bold">Authorization</strong>: <em class="slate-italic">Bearer Token {auth token} You need to enter the authentication token value in the token box, as shown in the image below.</em></p><div style="text-align:left"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/a9cbc319-4975-4d2d-a0fb-e3bb42e9ea7d.jpg" style="
              width:1082px;
	            height:343px;
	            aspect-ratio:1082 / 343"
         /></div><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><p class="slate-p " ><strong class="slate-bold">Response:</strong></p><div style="text-align:left"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/f9fb9362-dc41-4a7b-9173-eb29112adfd4.jpg" style="
              width:1082px;
	            height:623px;
	            aspect-ratio:1082 / 623"
         /></div><p class="slate-p " ></p>

Last Transaction Subscription

<h3 class="slate-h3 " ><strong class="slate-bold">List Subscription Transactions API allows you to list down all transactions against one specific subscription ID.</strong></h3><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><p class="slate-p " ><u class="slate-underline"><strong class="slate-bold">Step 1:</strong></u><strong class="slate-bold"> </strong>First, you will run an Authentication request to get the Auth Bearer Token for Authorization as explained in the “<a href="https://developers.paymob.com/egypt/subscriptions-1/authentication-request-generate-token" target=""><span style="color:#000000"><strong class="slate-bold">Authentication Request (Generated Token)”</strong></span></a><span style="color:#000000"> </span>section.</p><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><p class="slate-p slate-indent-0" style="0px"><u class="slate-underline"><strong class="slate-bold">Step 2:</strong></u> Please send a GET request to the URL below. Select &quot;Bearer Token&quot; as the authentication type and enter the authentication token in the token box of the authorization section. </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 " >“You will just pass the subscription id in the above URL to<strong class="slate-bold"> </strong>list down all transactions against specific subscription ID.</p></div></div><p class="slate-p " ><strong class="slate-bold">URL: https://accept.paymob.com/api/acceptance/subscriptions/{Subscription_Id}/transactions</strong></p><p class="slate-p " ><strong class="slate-bold">Method</strong>: <em class="slate-italic">GET</em></p><p class="slate-p " ><strong class="slate-bold">Source</strong>: <em class="slate-italic">Merchant&apos;s server</em></p><p class="slate-p " ><strong class="slate-bold">Recipient</strong>: <em class="slate-italic">Accept&apos;s server</em></p><p class="slate-p " ><strong class="slate-bold">Authorization</strong>: <em class="slate-italic">Bearer Token {auth token} You need to enter the authentication token value in the token box, as shown in the image below.</em></p><div style="text-align:left"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/a9cbc319-4975-4d2d-a0fb-e3bb42e9ea7d.jpg" style="
              width:1082px;
	            height:343px;
	            aspect-ratio:1082 / 343"
         /></div><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><p class="slate-p " ><strong class="slate-bold">Response:</strong></p><div style="text-align:left"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/0da4332f-3806-43e4-8956-6570e6f2336d.jpg" style="
              width:1082px;
	            height:651px;
	            aspect-ratio:1082 / 651"
         /></div><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><div class="slate-div"></div><p class="slate-p " ></p>

List Subscription Transactions

<h3 class="slate-h3 " >Do Subscriptions Support Webhooks?</h3><p class="slate-p " >Yes, subscriptions support webhooks. You can add a webhook URL when creating a new subscription plan using this “<strong class="slate-bold">Webhook New Subscription Plan</strong>” section. Additionally, you can add a webhook URL in the existing subscription ID in the “<strong class="slate-bold">Webhook Existing Subscription Plan</strong>” Section.</p>

Webhook

Mobile SDKs

Mobile SDKs V2

Test Credentials

<p class="slate-p " >Paymob provides a comprehensive range of payment options to suit various business needs, enhancing the flexibility and security of online transactions. The following are the four primary payment types supported by Paymob:</p><h3 class="slate-h3 " >1. <strong class="slate-bold">3D Secure (3DS)</strong></h3><p class="slate-p " >3D Secure (3DS) is a security protocol designed to reduce the risk of fraudulent online transactions by adding an additional layer of authentication. When a cardholder makes a purchase online, 3DS prompts the customer to authenticate their identity with the card issuer during the final stage of the checkout process. This step typically involves entering a one-time password (OTP) or biometric verification, depending on the card issuer’s requirements.</p><h3 class="slate-h3 " >2. <strong class="slate-bold">Auth and Capture</strong></h3><p class="slate-p " >The <strong class="slate-bold">Auth and Capture</strong> payment method is a two-step process where the transaction is initially authorized, but the funds are not immediately captured. First, the payment gateway authorizes the transaction by confirming that the customer has sufficient funds available, but the actual transaction amount will be captured later. If the transaction is not captured within 14 days, it will be automatically voided.</p><h3 class="slate-h3 " >3. <strong class="slate-bold">Card Verification</strong></h3><p class="slate-p " >Card Verification Function is a functionality provided by the Network to authenticate a card transaction without actually deducting the transaction amount from the customer’s card.</p><h3 class="slate-h3 " >4. <strong class="slate-bold">Pay with Saved Card Token</strong></h3><p class="slate-p " >The <strong class="slate-bold">Pay with Saved Card Token</strong> method allows customers to store their card details securely for future transactions. Once a customer has completed a transaction, the payment system stores a unique token that represents their payment method. In subsequent transactions, customers can opt to pay using this saved token without having to re-enter their card details, simplifying the checkout process.</p><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><p class="slate-p " ></p>

Payment Types

<p class="slate-p " >3D Secure (3DS), also known as payer authentication, is a security system that helps protect online credit and debit card transactions. It adds an extra layer of security to reduce the risk of fraud, keeping both merchants and customers safe from unauthorized payments. Merchants can set up 3D Secure by using a <strong class="slate-bold">3DS integration ID</strong> in the payment request, making the process smoother while ensuring strong protection. The<a href="https://developers.paymob.com/paymob-solutions-s-a-e/uae/api-reference-guide/create-intention-payment-api" target="_self"> Intention API </a>lets you create a payment request by providing all the necessary information. Make sure to include all the required details to start the payment request correctly. For more information about the <a href="https://developers.paymob.com/paymob-solutions-s-a-e/uae/api-reference-guide/create-intention-payment-api" target="_self"><strong class="slate-bold">Unified API Intention Experience</strong></a>, please check this section.</p><h4 class="slate-h4 " ><strong class="slate-bold">Important points:</strong></h4><ol class="slate-ol " ><li class="slate-li " ><div style="position:relative">You can create your integration ID from the <a href="https://developers.paymob.com/paymob-solutions-s-a-e/uae/accept-dashboard/payment-integrations" target="">Payments Integration tab</a> in the Merchant Portal Dashboard. Please note that any integration ID you create from your dashboard will be set to &quot;Test&quot; status by default. For any configuration changes to a Test Integration ID or if you wish to switch it to &quot;LIVE,&quot; please contact your Account Manager or reach out to the Support team via email at <a href="support@paymob.com" target="">support@paymob.com</a>. Alternatively, you can raise a ticket through the support widget in your <a href="https://uae.paymob.com/portal2/en/login" target="_self">Merchant Portal</a> Dashboard.</div></li><li class="slate-li " ><div style="position:relative">This feature works in both live and test environments. </div></li></ol><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><p class="slate-p " ></p>

3D Secure (3DS)

<p class="slate-p " >An Auth/Capture transaction has two separate steps:</p><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><p class="slate-p " ><strong class="slate-bold">Authorization Transaction:</strong> In this step, you hold (or &quot;authorize&quot;) a certain amount on your customer&apos;s card. Make sure to include the Auth and Capture integration ID in the intention request to authorize the payment. The <a href="https://developers.paymob.com/paymob-solutions-s-a-e/uae/api-reference-guide/create-intention-payment-api" target="_self">Intention API</a> helps you create a payment request by providing all the necessary information. Make sure to include all steps and details correctly to successfully start the payment request. For more information on the <a href="https://developers.paymob.com/paymob-solutions-s-a-e/uae/api-reference-guide/create-intention-payment-api" target="">Unified API Intention Experience</a>, please check this section.</p><h4 class="slate-h4 " ><strong class="slate-bold">Important points:</strong></h4><ol class="slate-ol " ><li class="slate-li " ><div style="position:relative">You can create your<a href="https://developers.paymob.com/paymob-solutions-s-a-e/uae/accept-dashboard/payment-integrations" target=""> integration ID</a> from the Payments Integration tab in the <a href="https://uae.paymob.com/portal2/en/login" target="_self">Merchant Portal </a>Dashboard. Please note that any integration ID you create from your dashboard will be set to &quot;Test&quot; status by default. For any configuration changes to a Test Integration ID or if you wish to switch it to &quot;LIVE,&quot; please contact your Account Manager or reach out to the Support team via email at <a href="support@paymob.com" target="">support@paymob.com</a>. Alternatively, you can raise a ticket through the support widget in your <a href="https://uae.paymob.com/portal2/en/login" target="_self">Merchant Portal</a> Dashboard.</div></li><li class="slate-li " ><div style="position:relative">This feature works in both live and test environments. </div></li></ol><p class="slate-p " ><strong class="slate-bold">Capture Transaction:</strong> In this step, you capture the authorized amount, or a smaller amount if needed. If the transaction is not captured within 14 days, it will be automatically canceled.</p><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><p class="slate-p " ></p>

Auth and Capture

<p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">Card Verification Function</strong> is a functionality that the Network provides to authenticate a card transaction without deducting the transaction amount from the customer’s card. This will mainly be used by merchants who want to tokenize customer card information. The transaction flow will be exactly the same as it is for a<strong class="slate-bold"> </strong><a href="https://developers.paymob.com/paymob-solutions-s-a-e/uae/payment-types/3ds" target="_self"><strong class="slate-bold">normal 3DS Card</strong></a><strong class="slate-bold"> Transaction</strong>. A transaction using the card verification function cannot be refunded or voided. However, once the transaction is completed, Paymob will automatically mark it to be voided in the system.&quot;</p><p class="slate-p " ><strong class="slate-bold">Important points:</strong></p><ol class="slate-ol " ><li class="slate-li " ><div style="position:relative">The merchant should request a card verification Integration ID from their account manager. This integration ID can be used for any API payment. </div></li><li class="slate-li " ><div style="position:relative">This feature works in both live and test environments. </div></li><li class="slate-li " ><div style="position:relative">If the customer doesn’t want to charge any amount on their card, they should set the transaction amount to &quot;false&quot; when creating the subscription plan.&quot;</div></li></ol><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><p class="slate-p " ></p>

Card Verification

<p class="slate-p " >Paymob facilitates seamless payments by allowing users to transact with saved card tokens, which enable transactions using previously stored cards. There are two primary methods for utilizing these saved tokens for payments:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Pay with Saved Card Token (Normal Moto Integration Flow)</strong></div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Pay with Saved Card Token (3DS Integration Flow ( Unified Checkout)</strong></div></li></ul><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><p class="slate-p " ></p>

Pay With Saved Card Token

Payment Links

Payment Link (Quick Link)

Payment Link (API)

Payment Actions

Dashboard

API Level

Payment Methods

Card/MADA

Tabby

Tamara

Google Pay

Apple Pay

StcPay

Transaction Inquiry API

Authentication Request (Generate Token) 

Retrieve Transaction With Order ID

Retreive Transaction With Transaction ID

Retrieve Transaction With Merchant Order ID (Special Reference Number)

<p class="slate-p " >Welcome to the Manage Callback documentation! In this section, we&apos;ll guide you through the different types of transaction callbacks that are essential for handling payment processing and ensuring a seamless integration with your system. Specifically, we&apos;ll cover transaction processed callbacks, transaction response callbacks, and how to calculate HMAC for processed callbacks, redirection callbacks, and saved card token objects.</p><p class="slate-p " >You will learn how to configure and manage these callbacks, understand their role in transaction flow, and ensure that your system securely processes and responds to different events during payment transactions. Whether you&apos;re dealing with successful payments, handling failures, or managing tokenized card data, this guide will provide you with the necessary tools and knowledge to handle callbacks efficiently and securely.</p><p class="slate-p " >Let&apos;s dive into understanding each callback type and how to calculate and implement HMAC to ensure the integrity and security of your transactions.</p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

Manage Callback

Transaction Callbacks 

<h3 class="slate-h3 " >HMAC Introduction</h3><p class="slate-p " ><strong class="slate-bold">HMAC (Hash-based Message Authentication Code)</strong> is a widely used cryptographic technique designed to ensure both the integrity and authenticity of a message. It combines a cryptographic hash function (such as SHA-512) with a secret key and a string of data to produce a unique signature, known as an HMAC. This signature serves as a guarantee that the message has not been altered during transmission and confirms the identity of the sender.</p><h3 class="slate-h3 " >HMAC Authentication</h3><p class="slate-p " >HMAC authentication is employed to secure communication between systems by ensuring that the data remains unaltered and authentic. It verifies the sender&apos;s identity and confirms that the data has not been tampered with during transmission. In the case of <strong class="slate-bold">Accept</strong>, HMAC authentication is used to validate every callback sent to your server. Each callback from Accept’s server includes its own specific HMAC validation, and the methodology for calculating the HMAC remains consistent across all callbacks. Once you implement the HMAC calculation for one callback, you can apply the same process to others seamlessly.</p><h3 class="slate-h3 " >Steps to Calculate and Validate the HMAC</h3><p class="slate-p " >Whenever you receive a callback from Accept, it will include an HMAC value associated with the data received in the request. This HMAC value is sent as a query parameter named <code class="slate-code">hmac</code>. To verify the authenticity of the callback, you need to calculate the HMAC based on the data you received and compare it with the HMAC value sent by Accept. Follow these steps to calculate and validate the HMAC:</p><h4 class="slate-h4 " >Step 1: Sort the Data Lexicographically by Key</h4><p class="slate-p " >Sort the parameters received in the callback in lexicographical order based on their keys.</p><h4 class="slate-h4 " >Step 2: Concatenate the Values</h4><p class="slate-p " >Depending on the type of callback received, concatenate the values of the keys/parameters into a single string. This string will be used to calculate the HMAC in the next step.</p><h4 class="slate-h4 " >Step 3: Get the HMAC Value</h4><p class="slate-p " >Obtain the HMAC value from the <a href="https://uae.paymob.com/portal2/en/login" target=""><strong class="slate-bold">Merchant Portal</strong> </a>settings tab. Use this Hmac value as the secret key in the following steps.</p><h4 class="slate-h4 " >Step 4: Calculate the HMAC</h4><p class="slate-p " >Go to a <a href="https://www.freeformatter.com/hmac-generator.html#before-output" target="">free online HMAC generator.</a> In the string box, add the concatenated string you generated in Step 2. Then, input the HMAC key you obtained in Step 3 into the &quot;secret key&quot; field and then select <strong class="slate-bold">SHA-512</strong> as the digest algorithm, and click on <strong class="slate-bold">Compute</strong> to calculate the HMAC.</p><h4 class="slate-h4 " >Step 5: Compare the Calculated HMAC</h4><p class="slate-p " >Compare the HMAC value you calculated with the <code class="slate-code">hmac</code> value received in the callback to verify the integrity and authenticity of the data.</p><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><p class="slate-p " >By following these steps, you can ensure that each callback from Accept is authentic and that the data has not been tampered with during transmission.</p><p class="slate-p " ></p><div class="slate-div"></div><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

HMAC 

<p class="slate-p " ><p class="slate-p " >The following payment methods are available for this region. Click on a payment method to view relevant error titles and their descriptions, which will assist customers, merchants, and developers in diagnosing and resolving payment processing issues.</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">MIGS</strong></div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Tabby</strong></div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Tamara</strong></div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Apple Pay</strong></div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Google Pay</strong></div></li></ul></p><p class="slate-p " ></p>

Error Description

<p class="slate-p " >MIGS payment method error details help customers, merchants, and developers diagnose and resolve payment processing issues. Below is a list of common errors titles along with their descriptions.</p><h3 class="slate-h3 " >MIGS Error Titles and Descriptions:</h3><div class="table-container" style="width:100%;
  min-width:100%;"><table class="slate-table" style="min-width:100%"><div class="published-table-header" style="width:100%;min-width:100%;"><div style="width:644px;">Error Title</div><div style="width:0px;">Description</div></div><colgroup ><col style="width:644px"><col style="width:initial"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Authentication Failed</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">We are unable to process your payment. Please try again with another payment method or use a different card</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Authentication Unavailable</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">You may have entered incorrect details or the card is not enabled on 3DS2. Please check your card details again or try another payment method. </p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Authentication Rejected</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">The Card Issuing Bank has declined the transaction. Please try again with another payment method or use a different card.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Authentication Not Supported</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >We are unable to process your payment. Please try another payment method or use a different card.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Declined</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >The transaction has been declined from Bank Side. Please try another payment method or use a different card.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " > Not sufficient Funds</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Your card does not have sufficient funds.  Please try another payment method or use a different card.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Pending 3DS Authorization</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >The user has been directed to the OTP Page but the customer did not enter the OTP.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Do Not Honour</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >The card issuer has declined to process the payment. Please try again using another payment method or a different card.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Transaction Not Permitted to Cardholder</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >The card issuer has restricted transactions on this card.  Please try another payment method or use a different card</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >3DS Authentication Failure</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Invalid card details or 3D Secure is not enabled on the Card. Please try again using another payment method or a different card.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Fraud/Security Issue (Mastercard use only)</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " > The Card Issuer restricted the processing of the payment and suspected this payment to be fraudulent. Please try again with another payment method or use a different card</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Invalid Card Number</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >The card number is invalid. Please check your card details again or try another payment method.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Value &apos;000008248767&apos; is invalid. No valid Merchant Acquirer Relationship is available</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Transactions failed because certain card types, such as Maestro and Discover, are not supported by the payment scheme. Please use a different card.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Expired Card</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >The card&apos;s Expiration Date is in the past. Please check your card details again or try another payment method.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Transaction Did Not Pass Risk Checks</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >The transaction did not pass internal risk checks. For more details, please contact the merchant.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Exceeds Withdrawal Limits</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >The card transaction limit was exceeded. Please try another payment method or use a different card.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Policy Restriction (Mastercard use only)</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >There was an issue with processing your payment. Please try again with another payment method or use a different card</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Suspected Fraud</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >The card issuer restricted processing the payment. Please try again with another payment method or use a different card</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Invalid Request</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Your transaction could not be processed due to a technical issue. Please try another payment method.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Lost Card</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >This card has been reported as Lost.  Please try another payment method or use a different card</p></td></div></tr></tbody></table></div><p class="slate-p " ></p>

MIGS 

<p class="slate-p " ><p class="slate-p " >TABBY payment method error details help customers, merchants, and developers diagnose and resolve payment processing issues. Below is a list of common error titles along with their descriptions.</p><h3 class="slate-h3 " >Tabby Error Titles and Descriptions</h3><div class="table-container" style="width:100%;
  min-width:100%;"><table class="slate-table" style="min-width:100%"><div class="published-table-header" style="width:100%;min-width:100%;"><div style="width:100px;">Title</div><div style="width:100px;">Description</div></div><colgroup ><col style="width:initial"><col style="width:initial"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Rejected</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Tabby was unable to approve this purchase.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Expired</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >The payment was not completed within Tabby&apos;s payment session</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Canceled from the user</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >The payment was canceled by the user.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Session Error</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >The payment could not be processed. Please contact your account manager for assistance.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Declined</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Tabby was unable to approve this purchase.</p></td></div></tr></tbody></table></div></p><p class="slate-p " ></p>

<p class="slate-p " ><p class="slate-p " >TAMARA payment method error details help customers, merchants, and developers diagnose and resolve payment processing issues. Below is a list of common errors titles along with their descriptions.</p><h3 class="slate-h3 " >Tamara Error Titles and Descriptions:</h3><div class="table-container" style="width:100%;
  min-width:100%;"><table class="slate-table" style="min-width:100%"><div class="published-table-header" style="width:100%;min-width:100%;"><div style="width:100px;">Tilte</div><div style="width:100px;">Description</div></div><colgroup ><col style="width:initial"><col style="width:initial"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Canceled</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >The payment was canceled by the user.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Declined</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Tamara was unable to approve this purchase.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Expired</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >The payment was not completed within Tamara&apos;s payment session.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Order Declined</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Tamara was unable to approve this purchase.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Order Expired</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><p class="slate-p " >The payment was not completed within Tamara&apos;s payment session.</p></p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >User Has No Available Payment Options</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >There are no payment plans available for this user on Tamara.</p></td></div></tr></tbody></table></div></p><p class="slate-p " ></p>

<p class="slate-p " ><p class="slate-p " >Apple Pay payment method error details help customers, merchants, and developers diagnose and resolve payment processing issues. Below is a list of common error titles along with their descriptions.</p><h3 class="slate-h3 " >Apple Pay Error Titles and Descriptions:</h3><div class="table-container" style="width:100%;
  min-width:100%;"><table class="slate-table" style="min-width:100%"><div class="published-table-header" style="width:100%;min-width:100%;"><div style="width:100px;">Title</div><div style="width:100px;">Description</div></div><colgroup ><col style="width:initial"><col style="width:initial"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " > Not sufficient Funds</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Your card does not have sufficient funds.  Please try another payment method or use a different card.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Do Not Honour</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >The card issuer has declined to process the payment. Please try again using another payment method or a different card.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Transaction Not Permitted to Cardholder</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >The card issuer has restricted transactions on this card.  Please try another payment method or use a different card</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Invalid Card Number</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >The card number is invalid. Please check your card details again or try another payment method.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Declined - Do Not Honour</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><p class="slate-p " >The card issuer has declined to process the payment. Please try again using another payment method or a different card.</p></p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Unspecified Failure</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >The card issuer was unable to recognize the entered card details. Please check your card details again or try another payment method.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Value &apos;000008248767&apos; is invalid. No valid Merchant Acquirer Relationship is available</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Transactions failed because certain card types, such as Maestro and Discover, are not supported by the payment scheme. Please use a different card.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Fraud/Security Issue (Mastercard use only)</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " > The Card Issuer restricted the processing of the payment and suspected this payment to be fraudulent. Please try again using another payment method or a different card.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Exceeds Withdrawal Limits</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >The card transaction limit was exceeded. Please try another payment method or use a different card.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Transaction Did Not Pass Risk Checks</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">The transaction did not pass internal risk checks. For more details, please contact the merchant.</p></td></div></tr></tbody></table></div></p><p class="slate-p " ></p>

<p class="slate-p " ><p class="slate-p " >Google Pay payment method error details help customers, merchants, and developers diagnose and resolve payment processing issues. Below is a list of common error titles along with their descriptions.</p><h3 class="slate-h3 " >Google Pay Error Titles and Descriptions:</h3><div class="table-container" style="width:100%;
  min-width:100%;"><table class="slate-table" style="min-width:100%"><div class="published-table-header" style="width:100%;min-width:100%;"><div style="width:100px;">Title</div><div style="width:100px;">Description</div></div><colgroup ><col style="width:initial"><col style="width:initial"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Do Not Honour</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >The card issuer has declined to process the payment. Please try again using another payment method or a different card.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Transaction Not Permitted to Cardholder</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >The card issuer has restricted transactions on this card.  Please try another payment method or use a different card</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Fraud/Security Issue (Mastercard use only)</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " > The Card Issuer restricted the processing of the payment and suspected this payment to be fraudulent. Please try again using another payment method or a different card.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " > Not sufficient Funds</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Your card does not have sufficient funds.  Please try another payment method or use a different card.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Transaction Did Not Pass Risk Checks</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >The transaction did not pass internal risk checks. For more details, please contact the merchant.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Security Violation</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">The card issuer recognized a security issue with this card. Please try again using another payment method or a different card.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Policy (Mastercard use only)</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">There was an issue with processing your payment. Please try again with another payment method or use a different card </p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Restricted Card</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Your card issuer has declined the transaction.  Please try another payment method or use a different card</p></td></div></tr></tbody></table></div></p><p class="slate-p " ></p>

<p class="slate-p " ><p class="slate-p " ><p class="slate-p " >STCPay payment method error details help customers, merchants, and developers diagnose and resolve payment processing issues. Below is a list of common error titles along with their descriptions.</p><h3 class="slate-h3 " >STCPay Error Titles and Descritpions</h3><div class="table-container" style="width:100%;
  min-width:100%;"><table class="slate-table" style="min-width:100%"><div class="published-table-header" style="width:100%;min-width:100%;"><div style="width:100px;">Title</div><div style="width:100px;">Description</div></div><colgroup ><col style="width:initial"><col style="width:initial"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Customer not found</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >The customer does not have an STC Pay wallet.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >The Balance is insufficient</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >The customer&apos;s wallet does not have sufficient funds to complete the transaction.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Transaction is Pending Pay</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >The transaction is awaiting user verification via OTP.</p></td></div></tr></tbody></table></div></p><p class="slate-p " ></p></p>

STCPay

Frequently Asked Questions (FAQs) 

Troubleshooting

Blank

KSA-DOCS

End Point

Sandbox

A guide to registering a new accept account.

To create your account, follow these steps

2. After that, you will enter your mobile number

 on which you will be receiving OTP for first-time verification.

3. As soon as you enter the OTP that you have received on your mobile number, you will get the below screen where you will be adding your name, and email details including your desired Password which you will be using for further logging.

4. Please note that after this screen you will get a login screen where you will be entering your registered mobile number without country code and your password which you have set in the previous screen.

5. As soon as you will log in, you will get the below screen to enter your business details.

After filling in this information, you will get a " 

" message on the screen and you will be routed to your Paymob Dashboard as below :

 and start accepting online payments from your customers, Go check our use case guide and choose your perfect payment scenario!

<h4 class="slate-h4 " >A detailed guide to your Accept dashboard</h4><p class="slate-p " >In order to deal with any of Accept&apos;s services, you have to create an <a href="https://ksa.paymob.com/portal2/en/register" target="_self">Accept account</a>.</p><p class="slate-p " >In your Accept portal, you can find:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Profile. </div></li><li class="slate-li " ><div style="position:relative">Payment Integrations.</div></li><li class="slate-li " ><div style="position:relative">Orders,</div></li><li class="slate-li " ><div style="position:relative">Transactions.</div></li><li class="slate-li " ><div style="position:relative">Checkout Customization</div></li></ul><p class="slate-p " ></p>

A detailed guide to your Accept dashboard

In order to deal with any of Accept's services, you have to create an 

<p class="slate-p " >Welcome to the API Checkout Experience documentation! In this guide, you will learn how to integrate and set up our API to provide a seamless and unified checkout experience. This includes everything you need to get started with setting up the API, generating your keys, and configuring both the Unified  Intention API Checkout and Pixel Native Payment experiences.</p><p class="slate-p " >We&apos;ll walk you through the basics of the API, including an overview of how it works, step-by-step instructions on how to get your environment set up, and how to use the various endpoints to facilitate secure and efficient transactions.</p>

Welcome to the API Checkout Experience documentation! In this guide, you will learn how to integrate and set up our API to provide a seamless and unified checkout experience. This includes everything you need to get started with setting up the API, generating your keys, and configuring both the Unified  Intention API Checkout and Pixel Native Payment experiences.

We'll walk you through the basics of the API, including an overview of how it works, step-by-step instructions on how to get your environment set up, and how to use the various endpoints to facilitate secure and efficient transactions.

<h2 class="slate-h2 " ><span style="color:#1155CB">Overview</span></h2><p class="slate-p " >Paymob provides a comprehensive subscription module designed to help merchants efficiently manage their subscriptions on a variety of billing cycles, including weekly, bi-weekly, monthly, quarterly, semi-annual, and annual plans. This module is tailored to meet the specific needs of each merchant, enabling them to create, manage, and control their subscriptions independently through our APIs.</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 " >For any guidance or assistance, please reach out to your account manager. Alternatively, you can contact our support team via email at  <a href="mailto:support@paymob.com" target="_blank">support@paymob.com</a>. When reaching out, please include details regarding your subscription, such as your Subscription ID and Transaction ID, to help us assist you more efficiently.</p></div></div><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><h2 class="slate-h2 " ><span style="color:#1155CB">Integration Requirements</span></h2><p class="slate-p " >To successfully set up your subscription plan, you will need two integration IDs:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Online 3DS Integration ID:</strong> This ID will be used for creating subscriptions.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Moto Integration ID:</strong> Utilize this ID when creating the subscription plan itself.</div></li></ul><p class="slate-p " >Ensure you have both integration IDs ready to streamline the setup process.</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 " >If you wish to verify the card user details (provide a free trial for X days period) instead of deducting the amount while creating the subscription then you can ask our support team at <a href="mailto:support@paymob.com" target="_blank">support@paymob.com</a> to create a 3DS verification integration ID. Noting this amount will be an auto reversal and you need to set the  <span style="color:rgb(182, 66, 76)">&quot;use_transaction_amount&quot;</span>: <span style="color:rgb(30, 83, 163)"><strong class="slate-bold">false</strong></span>  to avoid any override with the Subscription plan amount</p></div></div><p class="slate-p " >For further assistance or detailed API guidance, please refer to the subsequent sections of this documentation.</p><div style="width:100%;
	min-width:100%;" class="callout-widget" data-type=success ><div class="callout-icon"><svg width="18" height="18" viewBox="0 0 18 18" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M7.77116 10.8968L5.72949 8.8551C5.60449 8.7301 5.45171 8.6676 5.27116 8.6676C5.0906 8.6676 4.93088 8.73705 4.79199 8.87594C4.6531 9.01482 4.58366 9.17455 4.58366 9.3551C4.58366 9.53566 4.6531 9.68844 4.79199 9.81344L7.33366 12.3551C7.45866 12.4801 7.60449 12.5426 7.77116 12.5426C7.93783 12.5426 8.08366 12.4801 8.20866 12.3551L13.2087 7.3551C13.3337 7.2301 13.3927 7.07732 13.3857 6.89677C13.3788 6.71621 13.3128 6.56344 13.1878 6.43844C13.0628 6.29955 12.9066 6.2301 12.7191 6.2301C12.5316 6.2301 12.3684 6.29955 12.2295 6.43844L7.77116 10.8968ZM9.00033 17.3343C7.81977 17.3343 6.72255 17.1225 5.70866 16.6989C4.69477 16.2752 3.81283 15.6884 3.06283 14.9384C2.31283 14.1884 1.72602 13.3065 1.30241 12.2926C0.878798 11.2787 0.666992 10.1815 0.666992 9.00094C0.666992 7.83427 0.878798 6.74399 1.30241 5.7301C1.72602 4.71621 2.31283 3.83427 3.06283 3.08427C3.81283 2.33427 4.69477 1.74399 5.70866 1.31344C6.72255 0.88288 7.81977 0.667603 9.00033 0.667603C10.167 0.667603 11.2573 0.88288 12.2712 1.31344C13.285 1.74399 14.167 2.33427 14.917 3.08427C15.667 3.83427 16.2573 4.71621 16.6878 5.7301C17.1184 6.74399 17.3337 7.83427 17.3337 9.00094C17.3337 10.1815 17.1184 11.2787 16.6878 12.2926C16.2573 13.3065 15.667 14.1884 14.917 14.9384C14.167 15.6884 13.285 16.2752 12.2712 16.6989C11.2573 17.1225 10.167 17.3343 9.00033 17.3343ZM9.00033 16.0843C11.0142 16.0843 12.6982 15.4072 14.0524 14.053C15.4066 12.6989 16.0837 11.0148 16.0837 9.00094C16.0837 6.98705 15.4066 5.30302 14.0524 3.94885C12.6982 2.59469 11.0142 1.9176 9.00033 1.9176C6.98644 1.9176 5.30241 2.59469 3.94824 3.94885C2.59408 5.30302 1.91699 6.98705 1.91699 9.00094C1.91699 11.0148 2.59408 12.6989 3.94824 14.053C5.30241 15.4072 6.98644 16.0843 9.00033 16.0843Z" fill="#06837A"></path></svg></div><div ><p class="slate-p " >Download the <a href="https://drive.google.com/drive/folders/1xlmf_0NfuWZjpo_DgU6wIQ1J7nafOVJ-?usp=sharing" target="">Subscription Module APIs.</a></p></div></div><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

Paymob provides a comprehensive subscription module designed to help merchants efficiently manage their subscriptions on a variety of billing cycles, including weekly, bi-weekly, monthly, quarterly, semi-annual, and annual plans. This module is tailored to meet the specific needs of each merchant, enabling them to create, manage, and control their subscriptions independently through our APIs.

To successfully set up your subscription plan, you will need two integration IDs:

Ensure you have both integration IDs ready to streamline the setup process.

For further assistance or detailed API guidance, please refer to the subsequent sections of this documentation.

<h4 class="slate-h4 " >Here are the test credentials for the online card payment method:</h4><p class="slate-p slate-indent-0" style="0px">Mastercard:</p><div class="table-container" style="width:60%;
  min-width:60%;"><table class="slate-table" ><div class="published-table-header" style="width:100%;min-width:100%;min-height:initial;visibility: hidden;border:initial"><div style="width:100px;">Title</div><div style="width:100px;">Description</div></div><colgroup ><col style="width:initial"><col style="width:initial"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">Card</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">Mastercard</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">Card number</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >5123456789012346</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">Cardholder Name</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">Test Account</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">Expiry Month</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">12</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">Expiry Year</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">25</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">CVV</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">123</p></td></div></tr></tbody></table></div><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><h4 class="slate-h4 " ><u class="slate-underline"><strong class="slate-bold">MasterCard For Simulation:</strong></u></h4><div class="table-container" style="width:60%;
  min-width:60%;"><table class="slate-table" ><div class="published-table-header" style="width:100%;min-width:100%;min-height:initial;visibility: hidden;border:initial"><div style="width:100px;">Title</div><div style="width:100px;">Description</div></div><colgroup ><col style="width:initial"><col style="width:initial"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Card</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Mastercard</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Card number</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >5123450000000008</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Cardholder Name</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >TEST CARD</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Expiry Month</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >01</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Expiry Year</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >39</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >CVV</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >123</p></td></div></tr></tbody></table></div><p class="slate-p slate-indent-0" style="0px">VISA Card for Simulation:</p><div class="table-container" style="width:60%;
  min-width:60%;"><table class="slate-table" ><div class="published-table-header" style="width:100%;min-width:100%;min-height:initial;visibility: hidden;border:initial"><div style="width:100px;">Title</div><div style="width:100px;">Description</div></div><colgroup ><col style="width:initial"><col style="width:initial"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">Card</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">VISA</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">Card number</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">4111111111111111</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">Cardholder Name</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">Test Account</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">Expiry Month</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">12</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">Expiry Year</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">25</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">CVV</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">123</p></td></div></tr></tbody></table></div><p class="slate-p " ></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 " ><strong class="slate-bold">You will simulate both successful and all failed cases outlined below using the VISA card credentials provided above.</strong></p></div></div><div style="text-align:left"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/abaf33b0-7d69-4b9d-a258-48e21803a217.jpg" style="
              width:1082px;
	            height:721px;
	            aspect-ratio:1082 / 721"
         /></div><h4 class="slate-h4 " ><u class="slate-underline"><strong class="slate-bold">Successful Response:</strong></u>
</h4><div style="text-align:left"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/eeaf0e60-6198-41b8-9999-4f1e7cd53952.jpg" style="
              width:1082px;
	            height:412px;
	            aspect-ratio:1082 / 412"
         /></div><p class="slate-p " ><u class="slate-underline"><strong class="slate-bold">Failed Response:</strong></u></p><div style="text-align:left"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/3a3c82a8-a6b0-4b2d-9ade-88b48cf28746.jpg" style="
              width:1082px;
	            height:422px;
	            aspect-ratio:1082 / 422"
         /></div><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><p class="slate-p " ></p>

Here are the test credentials for the online card payment method:

Title

Description

<p class="slate-p " >Paymob provides a comprehensive range of payment options to suit various business needs, enhancing the flexibility and security of online transactions. The following are the four primary payment types supported by Paymob:</p><h3 class="slate-h3 " >1. <strong class="slate-bold">3D Secure (3DS)</strong></h3><p class="slate-p " >3D Secure (3DS) is a security protocol designed to reduce the risk of fraudulent online transactions by adding an additional layer of authentication. When a cardholder makes a purchase online, 3DS prompts the customer to authenticate their identity with the card issuer during the final stage of the checkout process. This step typically involves entering a one-time password (OTP) or biometric verification, depending on the card issuer’s requirements.</p><h3 class="slate-h3 " >2. <strong class="slate-bold">Auth and Capture</strong></h3><p class="slate-p " >The <strong class="slate-bold">Auth and Capture</strong> payment method is a two-step process where the transaction is initially authorized, but the funds are not immediately captured. First, the payment gateway authorizes the transaction by confirming that the customer has sufficient funds available, but the actual transaction amount will be captured later. If the transaction is not captured within 14 days, it will be automatically voided.</p><h3 class="slate-h3 " >3. <strong class="slate-bold">Card Verification</strong></h3><p class="slate-p " >Card Verification Function is a functionality provided by the Network to authenticate a card transaction without actually deducting the transaction amount from the customer’s card.</p><h3 class="slate-h3 " >4. <strong class="slate-bold">Pay with Saved Card Token</strong></h3><p class="slate-p " >The <strong class="slate-bold">Pay with Saved Card Token</strong> method allows customers to store their card details securely for future transactions. Once a customer has completed a transaction, the payment system stores a unique token that represents their payment method. In subsequent transactions, customers can opt to pay using this saved token without having to re-enter their card details, simplifying the checkout process.</p><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><p class="slate-p " ></p><p class="slate-p " ></p>

Paymob provides a comprehensive range of payment options to suit various business needs, enhancing the flexibility and security of online transactions. The following are the four primary payment types supported by Paymob:

3D Secure (3DS) is a security protocol designed to reduce the risk of fraudulent online transactions by adding an additional layer of authentication. When a cardholder makes a purchase online, 3DS prompts the customer to authenticate their identity with the card issuer during the final stage of the checkout process. This step typically involves entering a one-time password (OTP) or biometric verification, depending on the card issuer’s requirements.

 payment method is a two-step process where the transaction is initially authorized, but the funds are not immediately captured. First, the payment gateway authorizes the transaction by confirming that the customer has sufficient funds available, but the actual transaction amount will be captured later. If the transaction is not captured within 14 days, it will be automatically voided.

Card Verification Function is a functionality provided by the Network to authenticate a card transaction without actually deducting the transaction amount from the customer’s card.

 method allows customers to store their card details securely for future transactions. Once a customer has completed a transaction, the payment system stores a unique token that represents their payment method. In subsequent transactions, customers can opt to pay using this saved token without having to re-enter their card details, simplifying the checkout process.

<p class="slate-p " >This section contains the following topics:</p><ol class="slate-ol " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Refund Transaction through the Dashboard.</strong></div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Refund Transaction through API.</strong></div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Void Transaction through the Dashboard.</strong></div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Void Transaction through API.</strong></div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Auth/Capture Transaction through the Dashboard.</strong></div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Auth/Capture Transaction through API.</strong></div></li></ol><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>

This section contains the following topics:

<p class="slate-p " ><p class="slate-p " >Paymob provides a wide range of payment methods in KSA, enabling businesses to offer seamless and secure transactions for their customers. Whether through cards or installment plans, Paymob ensures a smooth payment experience tailored to diverse customer needs. Below is a list of supported payment methods:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Card Payments</strong></div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Tabby</strong></div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Tamara</strong></div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Apple Pay</strong></div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Google Pay</strong></div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">StcPay</strong></div></li></ul><p class="slate-p " >This extensive payment network allows businesses to expand their customer reach and simplify transactions through flexible and accessible solutions.</p></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

<h3 class="slate-h3 " ><strong class="slate-bold">Retrieve A Transaction allows you to obtain the details and status of a transaction-whether it is successful or failed,  using one of the following methods:</strong></h3><ol class="slate-ol " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Retrieve Transaction with Order ID.</strong>
Use the Order ID to access transaction details.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Retrieve Transaction with Transaction ID.</strong>
Use the Transaction ID to obtain the relevant transaction information.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Retrieve Transaction with Merchant Order ID(Special Reference Number).</strong>
Access transaction details using the Merchant Order ID (Special Reference Number).</div></li></ol><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><p class="slate-p " ></p>

Retrieve A Transaction allows you to obtain the details and status of a transaction-whether it is successful or failed,  using one of the following methods:

<h3 class="slate-h3 " ><strong class="slate-bold">Authentication Request API allows you to pass your API key or login details to generate a token in the response.</strong></h3><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><p class="slate-p " ><u class="slate-underline"><strong class="slate-bold">Step 1</strong></u><strong class="slate-bold">: Y</strong>ou need to obtain an authentication token through the below auth request using “api_key” or “login” details.</p><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">URL: </strong><span style="color:#4B85E8"><u class="slate-underline"><strong class="slate-bold">https://ksa.paymob.com/api/auth/tokens</strong></u></span></p><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">Method: </strong>POST</p><p class="slate-p " ><strong class="slate-bold">Source</strong>: <em class="slate-italic">Merchant&apos;s server</em></p><p class="slate-p " ><strong class="slate-bold">Recipient</strong>: <em class="slate-italic">Accept&apos;s server</em></p><p class="slate-p " ><span style="color:#1155CB"><u class="slate-underline"><strong class="slate-bold">Step 1.1:</strong></u></span><span style="color:#1155CB"><strong class="slate-bold"> API KEY</strong></span></p><p class="slate-p slate-indent-0" style="0px">You can pass the API key in the parameters to receive the token in the response. For API key details please refer to this <a href="https://developers.paymob.com/ksa/api-reference-guide/api-setup-secret-and-public-key" target="">section.</a></p><p class="slate-p " ><strong class="slate-bold">Request:</strong></p><div style="text-align:left"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/9457680e-42ad-48e1-9ee4-3bf9853a680e.jpg" style="
              width:1082px;
	            height:350px;
	            aspect-ratio:1082 / 350"
         /></div><p class="slate-p " ><strong class="slate-bold">Response :</strong></p><div style="text-align:left"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/eb87925c-e8b8-4073-a5a1-e65479e65175.jpg" style="
              width:1082px;
	            height:309px;
	            aspect-ratio:1082 / 309"
         /></div><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><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 " >The token has an expiration limit of 60 minutes. After this period, you will need to generate a new token.</p></div></div><p class="slate-p " ><span style="color:#1155CB"><u class="slate-underline"><strong class="slate-bold">Step 1.2:</strong></u></span><span style="color:#1155CB"><strong class="slate-bold"> LOGIN:</strong></span></p><p class="slate-p " >You can pass the login details in the parameters to receive the token in the response. </p><p class="slate-p " ><strong class="slate-bold">Request:</strong></p><div style="text-align:left"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/07c4bf1a-e233-4f76-a75e-fd26605bf597.jpg" style="
              width:1082px;
	            height:339px;
	            aspect-ratio:1082 / 339"
         /></div><p class="slate-p " ><strong class="slate-bold">Response:</strong></p><div style="text-align:left"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/9bbecea1-9be7-4b4f-9e12-61d787df952f.jpg" style="
              width:1082px;
	            height:309px;
	            aspect-ratio:1082 / 309"
         /></div><div class="slate-div"></div><p class="slate-p " ></p>

Authentication Request API allows you to pass your API key or login details to generate a token in the response.

ou need to obtain an authentication token through the below auth request using “api_key” or “login” details.

You can pass the API key in the parameters to receive the token in the response. For API key details please refer to this 

You can pass the login details in the parameters to receive the token in the response. 

This API Key you will find in your Dashboard settings tab, to authenticate your request.

api_key

profile

You will get a Authentication token in response of the Authentication request and you will need to use this token as "Authentication bearer token" in next subscription APIs

token

<h3 class="slate-h3 " ><strong class="slate-bold">How to get the Order ID?</strong></h3><p class="slate-p " >Answer: You can obtain the Order ID from your dashboard or from the transaction response in a webhook. Please see the screenshots below for both methods.</p><p class="slate-p " ><u class="slate-underline"><strong class="slate-bold">Order ID From Dashboard:</strong></u></p><div style="text-align:left"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/ec52ed91-58a0-41e3-b9da-e5b9e9916697.jpg" style="
              width:1082px;
	            height:455px;
	            aspect-ratio:1082 / 455"
         /></div><p class="slate-p " ><u class="slate-underline"><strong class="slate-bold">Order ID From Transaction Response in Webhook:</strong></u></p><div style="text-align:left"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/cde4237c-3e6e-4bfc-b58f-a41d04554538.jpg" style="
              width:1082px;
	            height:390px;
	            aspect-ratio:1082 / 390"
         /></div><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><p class="slate-p " ><u class="slate-underline"><strong class="slate-bold">Step 1:</strong></u> First, you will run an Authentication request to get the Auth Bearer Token for Authorization as explained in the “<a href="https://developers.paymob.com/uae/payment-actions-copy-1/retrieve-a-transaction-inquiry-with-order-id-copy-1/authentication-request-generate-token-copy-1" target="_top"><span style="color:#000000"><strong class="slate-bold">Authentication Request (Generated Token)”</strong></span></a><span style="color:#000000"> </span>section.</p><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><p class="slate-p " ><u class="slate-underline"><strong class="slate-bold">Step 2:</strong></u> Please send a POST request to the URL below. Select &quot;Bearer Token&quot; as the authentication type and enter the authentication token in the token box of the authorization section.</p><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">URL: </strong><span style="color:#4B85E8"><strong class="slate-bold">https://ksa.paymob.com/api/ecommerce/orders/transaction_inquiry</strong></span></p><p class="slate-p " ><strong class="slate-bold">Method</strong>: <em class="slate-italic">POST</em></p><p class="slate-p " ><strong class="slate-bold">Source</strong>: <em class="slate-italic">Merchant&apos;s server</em></p><p class="slate-p " ><strong class="slate-bold">Recipient</strong>: <em class="slate-italic">Accept&apos;s server</em></p><p class="slate-p " ><strong class="slate-bold">Authorization</strong>: <em class="slate-italic">Bearer Token {auth token} You need to enter the authentication token value in the token box, as shown in the image below.</em></p><div style="text-align:left"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/217ee3b0-38f0-4b9a-b8f3-a00e5ddf35aa.jpg" style="
              width:1082px;
	            height:365px;
	            aspect-ratio:1082 / 365"
         /></div><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 " >You can inquire about your transaction by including the <code class="slate-code">order_id</code> in the request parameters.</p></div></div><h4 class="slate-h4 " >Request:</h4><div style="text-align:left"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/9d1de8c3-9d89-4e1d-93c8-d4b32c3465cd.jpg" style="
              width:1082px;
	            height:245px;
	            aspect-ratio:1082 / 245"
         /></div><h4 class="slate-h4 " >Response:</h4><div style="text-align:left"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/b88caeaf-df53-47ef-b2a3-44eed75b5155.jpg" style="
              width:1082px;
	            height:621px;
	            aspect-ratio:1082 / 621"
         /></div><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><p class="slate-p " ></p>

Answer: You can obtain the Order ID from your dashboard or from the transaction response in a webhook. Please see the screenshots below for both methods.

Order ID From Transaction Response in Webhook:

 First, you will run an Authentication request to get the Auth Bearer Token for Authorization as explained in the “

 Please send a POST request to the URL below. Select "Bearer Token" as the authentication type and enter the authentication token in the token box of the authorization section.

https://ksa.paymob.com/api/ecommerce/orders/transaction_inquiry

Bearer Token {auth token} You need to enter the authentication token value in the token box, as shown in the image below.

Sections