Version: 1.0
Audience: Merchant developers, technical teams, and integration partners
Source: HealthPay Merchant API Postman collection
Last updated: 23 September 2026
HealthPay provides a merchant-facing API for creating payment orders and checkout links and for managing related payment operations such as refunds, invoices, subscriptions, balances, settlements, and card-session tokenization.
\nThe supplied collection separates the API into two HealthPay services:
\nThe collection description states that order creation/checkout is split between these services and that the merchant should configure an API key before running requests.
\nThe supplied API collection covers:
\nFor a standard payment:
\nMerchant System\n |\n | 1. Create Order\n v\nHealthPay Gateway\n |\n | 2. Return order UUID\n v\nMerchant System\n |\n | 3. Create Checkout URL\n v\nHealthPay\n |\n | 4. Return checkout URL\n v\nMerchant\n |\n | 5. Redirect customer\n v\nCustomer\n |\n | 6. Pay\n v\nHealthPay Checkout\n |\n +-- --> Merchant notification URL (if configured)\n |\n v\nMerchant System\n |\n | 7. Verify order status\n v\nHealthPay\n\nThe collection explicitly demonstrates creating an order, storing its UUID, creating a checkout URL from that UUID, and looking the order up again after payment.
\nBefore integrating, the merchant needs:
\nnotificationUrl field.The collection states that the test API key is obtained from:
\nDashboard → Developer → API keys
\nThe collection uses:
\nAuthorization: Bearer YOUR_API_KEY\n\nThe Postman collection defines a collection-level Bearer authentication token whose value is .
The API key should be kept server-side.
\nDo not:
\nThe supplied collection does not define API-key rotation, scopes, expiration, or permissions. These should be confirmed by HealthPay before being documented as supported behavior.
\nhttps://gateway.pg.healthpay.com.eg\n\nUsed by the supplied collection for:
\nPOST /v1/orders\nGET /v1/orders/uuid/{order_uuid}\nGET /v1/orders/{order_id}\nPOST /v1/orders/{order_id}/cancel\nPOST /v1/card-sessions\n\nhttps://dashboard.healthpay.com.eg\n\nUsed by the supplied collection for:
\nPOST /api/v1/orders/{order_uuid}/checkout-url\nGET /api/v1/refunds\nPOST /api/v1/refunds\nGET /api/v1/refunds/{refund_id}\nGET /api/v1/invoices\nPOST /api/v1/invoices\nGET /api/v1/invoices/{invoice_uuid}\nPOST /api/v1/invoices/{invoice_uuid}/send\nGET /api/v1/invoices/{invoice_uuid}/pdf\nPOST /api/v1/invoices/{invoice_uuid}/void\nDELETE /api/v1/invoices/{invoice_uuid}\nGET /api/v1/subscriptions\nPOST /api/v1/subscriptions\nPOST /api/v1/subscriptions/{subscription_uuid}/pause\nPOST /api/v1/subscriptions/{subscription_uuid}/resume\nPOST /api/v1/subscriptions/{subscription_uuid}/cancel\nGET /api/v1/balance\nGET /api/v1/settlements\n\nFor JSON requests:
\nAuthorization: Bearer YOUR_API_KEY\nContent-Type: application/json\n\nGET requests in the supplied collection do not define a Content-Type header.
Start with Create Order.
\ncurl -X POST \"https://gateway.pg.healthpay.com.eg/v1/orders\" \\\n -H \"Authorization: Bearer YOUR_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"environment\": \"test\",\n \"reference\": \"ORDER-10001\",\n \"amount\": 100,\n \"currency\": \"EGP\",\n \"apiOperation\": \"PAY\",\n \"notificationUrl\": \"https://merchant.example.com/webhooks/healthpay\",\n \"city\": \"CAIRO\",\n \"country\": \"EGY\",\n \"street\": \"12 Tahrir Street\"\n }'\n\nThe collection expects a successful response to contain a string uuid.
Call:
\nPOST /v1/orders\n\nSave the returned order UUID.
\nCall:
\nPOST /api/v1/orders/{order_uuid}/checkout-url\n\nThe response contains checkoutUrl.
Open the returned checkout URL in the customer's browser.
\nThe customer completes payment on the HealthPay checkout page.
\nThe collection provides:
\nGET /v1/orders/uuid/{order_uuid}\n\nThe collection description specifically says to run this again after paying through the checkout URL to see the order status change to a success/failure state.
\nThe merchant should only fulfill the order after its own integration has confirmed the final HealthPay order/payment state.
\n\n\nThe exact complete list of order statuses and their meanings is not defined in the supplied collection and must be confirmed from the API implementation before being published as a fixed status table.
\n
POST https://gateway.pg.healthpay.com.eg/v1/orders\n\nBearer API key.
\nThe supplied collection demonstrates:
\n{\n \"environment\": \"test\",\n \"reference\": \"POSTMAN-TEST-001\",\n \"amount\": 100,\n \"currency\": \"EGP\",\n \"apiOperation\": \"PAY\",\n \"notificationUrl\": \"https://example.com/webhooks/healthpay\",\n \"city\": \"CAIRO\",\n \"country\": \"EGY\",\n \"street\": \"12 Tahrir Street\"\n}\n\nThe collection does not specify which fields are formally mandatory, field-length limits, accepted currencies, or amount precision rules. Those should be confirmed from the API implementation.
\nThe Postman test expects HTTP 200 or 201 and requires:
{\n \"uuid\": \"...\"\n}\n\nThe UUID is saved as the collection variable order_uuid.
GET https://gateway.pg.healthpay.com.eg/v1/orders/uuid/{order_uuid}\n\nExample:
\ncurl \"https://gateway.pg.healthpay.com.eg/v1/orders/uuid/ORDER-UUID\" \\\n -H \"Authorization: Bearer YOUR_API_KEY\"\n\nThe supplied collection expects HTTP 200.
Use this endpoint when the merchant has the HealthPay order UUID.
\nGET https://gateway.pg.healthpay.com.eg/v1/orders/{order_id}\n\nThe collection extracts _id from the UUID lookup response and stores it as order_id.
Use the ID endpoint when the merchant has the internal order ID.
\nPOST https://gateway.pg.healthpay.com.eg/v1/orders/{order_id}/cancel\n\n{\n \"reason\": \"Customer cancelled the order\"\n}\n\nThe collection notes that cancellation is refused if the order is already paid or mid-flight.
\nUse cancellation only for an order that should no longer proceed to payment.
\nPOST https://dashboard.healthpay.com.eg/api/v1/orders/{order_uuid}/checkout-url\n\n{\n \"customer_name\": \"Test Customer\",\n \"customer_email\": \"test@example.com\",\n \"customer_mobile\": \"+201001234567\"\n}\n\nThe supplied Postman test expects HTTP 200 and a string:
{\n \"checkoutUrl\": \"...\"\n}\n\nThe collection stores the value in checkout_url.
After receiving checkoutUrl, redirect or open the customer in that URL.
Example server-side response:
\nCreate order\n ↓\nCreate checkout URL\n ↓\nReceive checkoutUrl\n ↓\nRedirect customer to checkoutUrl\n\nThe supplied collection provides these test cards:
\nThese values are test credentials supplied by the collection and must not be used for production transactions.
\n\n\nThe supplied collection contains expiry dates that are now historical relative to the document date. Confirm whether the sandbox still accepts these exact cards before publishing them as currently valid test credentials.
\n
The order request supports:
\n{\n \"notificationUrl\": \"https://merchant.example.com/webhooks/healthpay\"\n}\n\nThe field is demonstrated in the Create Order request.
\nThe merchant's endpoint should:
\nThe supplied collection does not define:
\nTherefore these items should not be guessed. They must be confirmed from the HealthPay webhook implementation before merchants rely on them.
\nA notification should not by itself be treated as proof of a successful payment unless the notification contract explicitly guarantees that behavior.
\nThe collection provides an order lookup endpoint that can be used to retrieve the current order state:
\nGET /v1/orders/uuid/{order_uuid}\n\nThe merchant integration should use the documented HealthPay status as the source for fulfillment.
\nGET https://dashboard.healthpay.com.eg/api/v1/refunds\n\nReturns the merchant's refund requests according to the API's response contract.
\nPagination/filter parameters are not defined in the supplied collection.
\nPOST https://dashboard.healthpay.com.eg/api/v1/refunds\n\n{\n \"order_uuid\": \"\",\n \"reason\": \"Customer requested refund\"\n}\n\nThe collection explicitly states that omitting amount requests a full refund.
The collection states that an amount may be supplied for a partial refund, but does not provide a sample payload. A likely structure is:
{\n \"order_uuid\": \"ORDER-UUID\",\n \"amount\": 50,\n \"reason\": \"Partial refund\"\n}\n\n\n\nConfirm the exact partial-refund field type and rules before publishing this example as a guaranteed contract.
\n
The collection states that the order must be settled/paid before requesting a refund.
\nThe request is queued for admin review.
\nThe collection says the refund can be approved from:
\nAdmin → Refunds → Refund Requests
\nGET https://dashboard.healthpay.com.eg/api/v1/refunds/{refund_id}\n\nThe refund ID is returned by the refund request and stored in the Postman variable refund_id.
Paid Order\n ↓\nRefund Request\n ↓\nPending Review\n ↓\nAdmin Approval\n ↓\nRefund Processing\n ↓\nFinal Refund Result\n\nThe collection only explicitly documents the review/approval stage. Exact refund status values are not supplied.
\nGET https://dashboard.healthpay.com.eg/api/v1/invoices\n\nPOST https://dashboard.healthpay.com.eg/api/v1/invoices\n\n{\n \"customer_name\": \"Test Customer\",\n \"customer_email\": \"test@example.com\",\n \"currency\": \"EGP\",\n \"due_date\": \"2026-10-01\",\n \"items\": [\n {\n \"description\": \"Consultation\",\n \"quantity\": 1,\n \"unit_price\": 500\n }\n ]\n}\n\nThe response's uuid is saved as invoice_uuid.
The collection does not define validation rules or maximum values for these fields.
\nGET https://dashboard.healthpay.com.eg/api/v1/invoices/{invoice_uuid}\n\nPOST https://dashboard.healthpay.com.eg/api/v1/invoices/{invoice_uuid}/send\n\nThe request changes the invoice into a payable state according to the endpoint name and collection organization.
\nGET https://dashboard.healthpay.com.eg/api/v1/invoices/{invoice_uuid}/pdf\n\nThe response is expected to represent/download the invoice PDF.
\nPOST https://dashboard.healthpay.com.eg/api/v1/invoices/{invoice_uuid}/void\n\nThe collection states that voiding is blocked once the invoice has been paid.
\nDELETE https://dashboard.healthpay.com.eg/api/v1/invoices/{invoice_uuid}\n\nThe collection states that deletion works only for a draft that has not been sent.
\nDraft\n |\n +-- --> Delete\n |\n v\nSend\n |\n v\nPayable\n |\n v\nPaid\nDraft/Payable\n |\n v\nVoid\n\nThe exact API status values are not supplied by the collection.
\nGET https://dashboard.healthpay.com.eg/api/v1/subscriptions\n\nPOST https://dashboard.healthpay.com.eg/api/v1/subscriptions\n\n{\n \"customer_name\": \"Test Customer\",\n \"customer_email\": \"test@example.com\",\n \"currency\": \"EGP\",\n \"interval_unit\": \"month\",\n \"interval_count\": 1,\n \"due_days\": 7,\n \"items\": [\n {\n \"description\": \"Monthly plan\",\n \"quantity\": 1,\n \"unit_price\": 300\n }\n ]\n}\n\nThe response's uuid is stored as subscription_uuid.
The collection description states:
\n\n\nA normal invoice is automatically generated and sent every billing cycle; no card is charged silently.
\n
Therefore the documented flow is invoice-based rather than silent automatic card charging.
\nThe example uses:
\n{\n \"interval_unit\": \"month\",\n \"interval_count\": 1\n}\n\nThe collection does not define the complete set of accepted interval_unit values. Confirm supported units before documenting them as exhaustive.
{\n \"due_days\": 7\n}\n\nThe example indicates a seven-day due period.
\nThe collection does not define whether zero/negative values are accepted or the maximum value.
\nPOST /api/v1/subscriptions/{subscription_uuid}/pause\n\nPOST /api/v1/subscriptions/{subscription_uuid}/resume\n\nPOST /api/v1/subscriptions/{subscription_uuid}/cancel\n\nCreated\n |\n v\nActive\n / \\\n / \\\nPause Cancel\n |\n v\nPaused\n |\n v\nResume\n |\n v\nActive\n\nThe exact status values are not specified by the supplied collection.
\nGET https://dashboard.healthpay.com.eg/api/v1/balance\n\nThis is a read-only endpoint according to the collection.
\nUse it to retrieve the current merchant ledger balance.
\nGET https://dashboard.healthpay.com.eg/api/v1/settlements\n\nThis is also read-only.
\nUse it to retrieve settlement batch history.
\nThe collection does not define:
\nThese must be documented from the actual API response/implementation before being promised to merchants.
\nThe card-session API creates a short-lived/session token intended for use by the HealthPay card iframe.
\nPOST https://gateway.pg.healthpay.com.eg/v1/card-sessions\n\n{\n \"origin\": \"https://your-store.example.com\"\n}\n\nThe collection requires the origin to be the exact HTTPS origin that will host the iframe.
\nIt must contain:
\nscheme + host\n\nand no path.
\nExample:
\nhttps://shop.example.com\n\nNot:
\nhttps://shop.example.com/checkout\n\nThe collection expects HTTP 201 and a string:
{\n \"token\": \"...\"\n}\n\nThe token is stored in the Postman variable card_session_token.
The collection provides this structure:
\n</div><div class='preserveHtml' class='preserveHtml'> src=\"https://card-iframe.healthpay.com.eg/?merchant_id=YOUR_MERCHANT_ID&customer_id=test-customer-1#session=YOUR_SESSION_TOKEN\">\n
</div><div class='preserveHtml' class='preserveHtml'></iframe>\n
</div></code></pre><p class='preserveHtml' >Replace:</p><ul class='preserveHtml' ><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'><code class='preserveHtml' >YOUR_MERCHANT_ID</code></div></li><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'><code class='preserveHtml' >test-customer-1</code></div></li><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'><code class='preserveHtml' >YOUR_SESSION_TOKEN</code></div></li></ul><p class='preserveHtml' >with the merchant/customer/session values.</p><h2 class='preserveHtml' >11.5 Tokenization result</h2><p class='preserveHtml' >The collection states that the browser should listen for:</p><pre class='preserveHtml' class=javascript><code class='preserveHtml' class='preserveHtml'><div class='preserveHtml' class='preserveHtml'>window.addEventListener('message', (event) => {\n
</div><div class='preserveHtml' class='preserveHtml'> if (event.data?.type === 'healthpay.card.tokenized') {\n
</div><div class='preserveHtml' class='preserveHtml'> // Read the tokenized card information from event.data\n
</div><div class='preserveHtml' class='preserveHtml'> }\n
</div><div class='preserveHtml' class='preserveHtml'>});\n
</div></code></pre><p class='preserveHtml' >The exact <code class='preserveHtml' >event.data</code> schema is not defined in the supplied collection.</p><h2 class='preserveHtml' >11.6 Important browser limitation</h2><p class='preserveHtml' >The collection explicitly notes that Postman cannot perform the browser iframe / <code class='preserveHtml' >postMessage</code> handshake.</p><p class='preserveHtml' >Therefore card tokenization must be tested in an actual browser environment.</p><div class='preserveHtml' ><hr class='preserveHtml' contenteditable=\"false\" /></div><h1 class='preserveHtml' >12. Error Handling</h1><h2 class='preserveHtml' >12.1 HTTP status codes</h2><p class='preserveHtml' >The collection explicitly expects the following successful response codes for some operations:</p><div class='preserveHtml' ><table class='preserveHtml' class='preserveHtml'><tbody class='preserveHtml' class='preserveHtml'><tr class='preserveHtml' ><th class='preserveHtml' >Operation</th><th class='preserveHtml' >Expected code in collection</th></tr><tr class='preserveHtml' ><td class='preserveHtml' ><div class='preserveHtml' >Create order</div><div class='preserveHtml' contenteditable=\"false\"><div class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'><div class='preserveHtml' ></div></div></div><div class='preserveHtml' ></div></div></td><td class='preserveHtml' ><div class='preserveHtml' ><code class='preserveHtml' >200</code> or <code class='preserveHtml' >201</code></div><div class='preserveHtml' contenteditable=\"false\"><div class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'><div class='preserveHtml' ></div></div></div><div class='preserveHtml' ></div></div></td></tr><tr class='preserveHtml' ><td class='preserveHtml' ><div class='preserveHtml' >Look up order</div><div class='preserveHtml' contenteditable=\"false\"><div class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'><div class='preserveHtml' ></div></div></div><div class='preserveHtml' ></div></div></td><td class='preserveHtml' ><div class='preserveHtml' ><code class='preserveHtml' >200</code></div><div class='preserveHtml' contenteditable=\"false\"><div class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'><div class='preserveHtml' ></div></div></div><div class='preserveHtml' ></div></div></td></tr><tr class='preserveHtml' ><td class='preserveHtml' ><div class='preserveHtml' >Get checkout URL</div><div class='preserveHtml' contenteditable=\"false\"><div class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'><div class='preserveHtml' ></div></div></div><div class='preserveHtml' ></div></div></td><td class='preserveHtml' ><div class='preserveHtml' ><code class='preserveHtml' >200</code></div><div class='preserveHtml' contenteditable=\"false\"><div class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'><div class='preserveHtml' ></div></div></div><div class='preserveHtml' ></div></div></td></tr><tr class='preserveHtml' ><td class='preserveHtml' ><div class='preserveHtml' >Create card session</div><div class='preserveHtml' contenteditable=\"false\"><div class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'><div class='preserveHtml' ></div></div></div><div class='preserveHtml' ></div></div></td><td class='preserveHtml' ><div class='preserveHtml' ><code class='preserveHtml' >201</code></div><div class='preserveHtml' contenteditable=\"false\"><div class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'><div class='preserveHtml' ></div></div></div><div class='preserveHtml' ></div></div></td></tr></tbody></table></div><p class='preserveHtml' >Other endpoint-specific status codes are not defined in the collection.</p><h2 class='preserveHtml' >12.2 Merchant error handling</h2><p class='preserveHtml' >For every API request:</p><ol class='preserveHtml' ><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'>Check the HTTP status code.</div></li><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'>Parse the JSON response when applicable.</div></li><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'>Log the request correlation/reference information available to your application.</div></li><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'>Do not expose the API key in logs.</div></li><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'>Do not treat every non-2xx response as a permanent failure.</div></li><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'>For payment operations, verify the final order status before fulfilling the customer's order.</div></li></ol><h2 class='preserveHtml' >12.3 Error response format</h2><p class='preserveHtml' >The supplied collection does not provide a standard HealthPay error response example.</p><p class='preserveHtml' >Therefore the following should be confirmed before publishing:</p><pre class='preserveHtml' class=json><code class='preserveHtml' class='preserveHtml'><div class='preserveHtml' class='preserveHtml'>{\n
</div><div class='preserveHtml' class='preserveHtml'> \"error\": \"...\",\n
</div><div class='preserveHtml' class='preserveHtml'> \"message\": \"...\",\n
</div><div class='preserveHtml' class='preserveHtml'> \"code\": \"...\",\n
</div><div class='preserveHtml' class='preserveHtml'> \"details\": {}\n
</div><div class='preserveHtml' class='preserveHtml'>}\n
</div></code></pre><p class='preserveHtml' >The above is only an illustrative structure and is <strong class='preserveHtml' >not</b> a HealthPay contract.</p><div class='preserveHtml' ><hr class='preserveHtml' contenteditable=\"false\" /></div><h1 class='preserveHtml' >13. Security</h1><h2 class='preserveHtml' >13.1 API key</h2><p class='preserveHtml' >Keep the API key on the merchant backend.</p><p class='preserveHtml' >Example:</p><pre class='preserveHtml' class=text><code class='preserveHtml' class='preserveHtml'><div class='preserveHtml' class='preserveHtml'>Customer Browser\n
</div><div class='preserveHtml' class='preserveHtml'> |\n
</div><div class='preserveHtml' class='preserveHtml'> | no HealthPay secret\n
</div><div class='preserveHtml' class='preserveHtml'> v\n
</div><div class='preserveHtml' class='preserveHtml'>Merchant Backend\n
</div><div class='preserveHtml' class='preserveHtml'> |\n
</div><div class='preserveHtml' class='preserveHtml'> | Authorization: Bearer API_KEY\n
</div><div class='preserveHtml' class='preserveHtml'> v\n
</div><div class='preserveHtml' class='preserveHtml'>HealthPay API\n
</div></code></pre><h2 class='preserveHtml' >13.2 HTTPS</h2><p class='preserveHtml' >All supplied HealthPay API base URLs use HTTPS.</p><p class='preserveHtml' >Merchant notification endpoints should also use HTTPS in production.</p><h2 class='preserveHtml' >13.3 Card data</h2><p class='preserveHtml' >The supplied card-session flow is designed around a HealthPay-hosted card iframe.</p><p class='preserveHtml' >The collection specifically describes using the iframe and receiving a tokenization event rather than directly collecting card details in Postman.</p><p class='preserveHtml' >Merchants should not store or process raw card data unless their approved integration and compliance scope explicitly permits it.</p><h2 class='preserveHtml' >13.4 Webhook security</h2><p class='preserveHtml' >The supplied collection does not document webhook signatures or verification.</p><p class='preserveHtml' >Do not invent a signature-validation algorithm. Obtain the official HealthPay webhook security specification before implementing it.</p><h2 class='preserveHtml' >13.5 PCI considerations</h2><p class='preserveHtml' >The Postman collection alone does not define HealthPay's PCI responsibilities, merchant PCI scope, SAQ requirements, or compliance obligations.</p><p class='preserveHtml' >These must be supplied separately in the merchant onboarding/compliance documentation.</p><div class='preserveHtml' ><hr class='preserveHtml' contenteditable=\"false\" /></div><h1 class='preserveHtml' >14. Testing</h1><h2 class='preserveHtml' >14.1 Test environment</h2><p class='preserveHtml' >The Create Order example uses:</p><pre class='preserveHtml' class=json><code class='preserveHtml' class='preserveHtml'><div class='preserveHtml' class='preserveHtml'>{\n
</div><div class='preserveHtml' class='preserveHtml'> \"environment\": \"test\"\n
</div><div class='preserveHtml' class='preserveHtml'>}\n
</div></code></pre><p class='preserveHtml' >The collection description identifies the API key as a test key obtained from:</p><p class='preserveHtml' ><strong class='preserveHtml' >Dashboard → Developer → API keys</b></p><h2 class='preserveHtml' >14.2 Recommended test plan</h2><h3 class='preserveHtml' >Test 1 — Create order</h3><p class='preserveHtml' >Expected:</p><ul class='preserveHtml' ><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'>HTTP <code class='preserveHtml' >200</code> or <code class='preserveHtml' >201</code></div></li><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'>Response contains <code class='preserveHtml' >uuid</code></div></li></ul><h3 class='preserveHtml' >Test 2 — Retrieve order</h3><p class='preserveHtml' >Call:</p><pre class='preserveHtml' class=http><code class='preserveHtml' class='preserveHtml'><div class='preserveHtml' class='preserveHtml'>GET /v1/orders/uuid/{order_uuid}\n
</div></code></pre><p class='preserveHtml' >Expected:</p><ul class='preserveHtml' ><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'>HTTP <code class='preserveHtml' >200</code></div></li></ul><h3 class='preserveHtml' >Test 3 — Generate checkout</h3><p class='preserveHtml' >Call:</p><pre class='preserveHtml' class=http><code class='preserveHtml' class='preserveHtml'><div class='preserveHtml' class='preserveHtml'>POST /api/v1/orders/{order_uuid}/checkout-url\n
</div></code></pre><p class='preserveHtml' >Expected:</p><ul class='preserveHtml' ><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'>HTTP <code class='preserveHtml' >200</code></div></li><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'><code class='preserveHtml' >checkoutUrl</code> is present</div></li></ul><h3 class='preserveHtml' >Test 4 — Successful payment</h3><p class='preserveHtml' >Open the checkout URL and use a valid sandbox test card.</p><h3 class='preserveHtml' >Test 5 — Verify payment</h3><p class='preserveHtml' >Retrieve the order again and confirm its final status.</p><h3 class='preserveHtml' >Test 6 — Failed payment</h3><p class='preserveHtml' >Use the documented hard-decline test card and verify that the merchant does not fulfill the order.</p><h3 class='preserveHtml' >Test 7 — Refund</h3><p class='preserveHtml' >After a successful/settled payment:</p><ol class='preserveHtml' ><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'>Create a refund request.</div></li><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'>Record the returned refund ID.</div></li><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'>Check the refund.</div></li><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'>Complete the configured approval process.</div></li><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'>Verify the final refund result.</div></li></ol><h3 class='preserveHtml' >Test 8 — Invoice</h3><p class='preserveHtml' >Test:</p><pre class='preserveHtml' class=text><code class='preserveHtml' class='preserveHtml'><div class='preserveHtml' class='preserveHtml'>Create draft\n
</div><div class='preserveHtml' class='preserveHtml'> ↓\n
</div><div class='preserveHtml' class='preserveHtml'>Get invoice\n
</div><div class='preserveHtml' class='preserveHtml'> ↓\n
</div><div class='preserveHtml' class='preserveHtml'>Send invoice\n
</div><div class='preserveHtml' class='preserveHtml'> ↓\n
</div><div class='preserveHtml' class='preserveHtml'>Download PDF\n
</div></code></pre><p class='preserveHtml' >Also test:</p><pre class='preserveHtml' class=text><code class='preserveHtml' class='preserveHtml'><div class='preserveHtml' class='preserveHtml'>Create draft\n
</div><div class='preserveHtml' class='preserveHtml'> ↓\n
</div><div class='preserveHtml' class='preserveHtml'>Delete draft\n
</div></code></pre><p class='preserveHtml' >and:</p><pre class='preserveHtml' class=text><code class='preserveHtml' class='preserveHtml'><div class='preserveHtml' class='preserveHtml'>Create/send invoice\n
</div><div class='preserveHtml' class='preserveHtml'> ↓\n
</div><div class='preserveHtml' class='preserveHtml'>Void when allowed\n
</div></code></pre><h3 class='preserveHtml' >Test 9 — Subscription</h3><p class='preserveHtml' >Test:</p><pre class='preserveHtml' class=text><code class='preserveHtml' class='preserveHtml'><div class='preserveHtml' class='preserveHtml'>Create\n
</div><div class='preserveHtml' class='preserveHtml'> ↓\n
</div><div class='preserveHtml' class='preserveHtml'>Pause\n
</div><div class='preserveHtml' class='preserveHtml'> ↓\n
</div><div class='preserveHtml' class='preserveHtml'>Resume\n
</div><div class='preserveHtml' class='preserveHtml'> ↓\n
</div><div class='preserveHtml' class='preserveHtml'>Cancel\n
</div></code></pre><h3 class='preserveHtml' >Test 10 — Card session</h3><p class='preserveHtml' >Test:</p><pre class='preserveHtml' class=text><code class='preserveHtml' class='preserveHtml'><div class='preserveHtml' class='preserveHtml'>Create session\n
</div><div class='preserveHtml' class='preserveHtml'> ↓\n
</div><div class='preserveHtml' class='preserveHtml'>Embed iframe\n
</div><div class='preserveHtml' class='preserveHtml'> ↓\n
</div><div class='preserveHtml' class='preserveHtml'>Enter test card\n
</div><div class='preserveHtml' class='preserveHtml'> ↓\n
</div><div class='preserveHtml' class='preserveHtml'>Receive postMessage tokenization event\n
</div></code></pre><div class='preserveHtml' ><hr class='preserveHtml' contenteditable=\"false\" /></div><h1 class='preserveHtml' >15. Production / Go-Live</h1><h2 class='preserveHtml' >15.1 Production readiness checklist</h2><p class='preserveHtml' >Before going live, the merchant should verify:</p><h3 class='preserveHtml' >Credentials</h3><ul class='preserveHtml' ><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'> Production API credentials have been issued.</div></li><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'> Production credentials are stored securely.</div></li><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'> Test credentials are not used in production.</div></li></ul><h3 class='preserveHtml' >Server</h3><ul class='preserveHtml' ><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'> Backend communicates with HealthPay over HTTPS.</div></li><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'> API key is server-side.</div></li><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'> Secrets are stored in environment variables/secret storage.</div></li><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'> Sensitive API responses are not written to application logs.</div></li></ul><h3 class='preserveHtml' >Orders</h3><ul class='preserveHtml' ><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'> Merchant reference is unique.</div></li><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'> Merchant stores HealthPay order UUID.</div></li><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'> Merchant can query order status.</div></li><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'> Merchant handles successful payments.</div></li><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'> Merchant handles failed payments.</div></li><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'> Merchant handles cancelled orders.</div></li></ul><h3 class='preserveHtml' >Checkout</h3><ul class='preserveHtml' ><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'> Checkout URL is generated correctly.</div></li><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'> Customer is redirected correctly.</div></li><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'> Merchant does not assume payment success from redirect alone.</div></li></ul><h3 class='preserveHtml' >Notifications</h3><ul class='preserveHtml' ><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'> Notification URL is configured.</div></li><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'> Endpoint is publicly reachable.</div></li><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'> Endpoint uses HTTPS.</div></li><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'> Notification processing is idempotent.</div></li><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'> Merchant verifies the corresponding order status.</div></li></ul><h3 class='preserveHtml' >Refunds</h3><ul class='preserveHtml' ><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'> Merchant understands refund approval flow.</div></li><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'> Full refunds have been tested.</div></li><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'> Partial refunds have been tested if supported.</div></li></ul><h3 class='preserveHtml' >Invoices</h3><ul class='preserveHtml' ><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'> Invoice creation tested.</div></li><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'> Invoice sending tested.</div></li><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'> PDF download tested.</div></li><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'> Void behavior tested.</div></li></ul><h3 class='preserveHtml' >Subscriptions</h3><ul class='preserveHtml' ><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'> Subscription creation tested.</div></li><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'> Billing cycle behavior understood.</div></li><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'> Pause/resume tested.</div></li><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'> Cancellation tested.</div></li></ul><h3 class='preserveHtml' >Settlement</h3><ul class='preserveHtml' ><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'> Balance endpoint tested.</div></li><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'> Settlement history endpoint tested.</div></li><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'> Merchant understands the settlement process.</div></li></ul><h3 class='preserveHtml' >Card tokenization</h3><ul class='preserveHtml' ><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'> Card iframe origin is configured correctly.</div></li><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'> Card iframe works on the actual merchant domain.</div></li><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'> <code class='preserveHtml' >postMessage</code> handling is implemented.</div></li><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'> Tokenization result is stored securely.</div></li></ul><h2 class='preserveHtml' >15.2 Production URLs</h2><p class='preserveHtml' >The supplied collection provides the following URLs but does not separately identify production versus sandbox base URLs:</p><pre class='preserveHtml' class=text><code class='preserveHtml' class='preserveHtml'><div class='preserveHtml' class='preserveHtml'>https://gateway.pg.healthpay.com.eg\n
</div><div class='preserveHtml' class='preserveHtml'>https://dashboard.healthpay.com.eg\n
</div></code></pre><p class='preserveHtml' >Confirm with HealthPay whether these are the final production endpoints and whether separate sandbox endpoints exist.</p><div class='preserveHtml' ><hr class='preserveHtml' contenteditable=\"false\" /></div><h1 class='preserveHtml' >16. Troubleshooting</h1><h2 class='preserveHtml' >16.1 401 / authentication failure</h2><p class='preserveHtml' >Check:</p><ul class='preserveHtml' ><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'>API key is correct.</div></li><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'>API key has not been revoked.</div></li><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'><code class='preserveHtml' >Authorization</code> header is present.</div></li><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'>Header uses the Bearer format.</div></li></ul><p class='preserveHtml' >Correct:</p><pre class='preserveHtml' class=http><code class='preserveHtml' class='preserveHtml'><div class='preserveHtml' class='preserveHtml'>Authorization: Bearer YOUR_API_KEY\n
</div></code></pre><h2 class='preserveHtml' >16.2 Order creation fails</h2><p class='preserveHtml' >Check:</p><ul class='preserveHtml' ><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'>JSON is valid.</div></li><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'><code class='preserveHtml' >Content-Type: application/json</code> is present.</div></li><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'>API key is valid.</div></li><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'><code class='preserveHtml' >environment</code> is correct.</div></li><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'>Amount and currency are valid.</div></li><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'>Required order fields are present.</div></li><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'>Notification URL is valid if being supplied.</div></li></ul><h2 class='preserveHtml' >16.3 Checkout URL is not generated</h2><p class='preserveHtml' >Check:</p><ol class='preserveHtml' ><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'>The order UUID is correct.</div></li><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'>The order exists.</div></li><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'>The API key is correct.</div></li><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'>The request is sent to the Dashboard API, not the Gateway URL.</div></li><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'>Customer information is valid.</div></li></ol><p class='preserveHtml' >Correct endpoint:</p><pre class='preserveHtml' class=text><code class='preserveHtml' class='preserveHtml'><div class='preserveHtml' class='preserveHtml'>https://dashboard.healthpay.com.eg/api/v1/orders/{order_uuid}/checkout-url\n
</div></code></pre><h2 class='preserveHtml' >16.4 Payment appears successful but merchant order is not updated</h2><p class='preserveHtml' >Do not rely only on the browser redirect.</p><p class='preserveHtml' >Use:</p><pre class='preserveHtml' class=http><code class='preserveHtml' class='preserveHtml'><div class='preserveHtml' class='preserveHtml'>GET /v1/orders/uuid/{order_uuid}\n
</div></code></pre><p class='preserveHtml' >and compare the current HealthPay order state with the merchant's stored state.</p><p class='preserveHtml' >Also verify the notification endpoint if one is configured.</p><h2 class='preserveHtml' >16.5 Cancellation fails</h2><p class='preserveHtml' >The collection explicitly says cancellation is refused when the order is already paid or mid-flight.</p><p class='preserveHtml' >Use cancellation only for an eligible order.</p><h2 class='preserveHtml' >16.6 Refund request fails</h2><p class='preserveHtml' >Confirm that:</p><ul class='preserveHtml' ><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'>The order has been paid/settled.</div></li><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'>The correct <code class='preserveHtml' >order_uuid</code> is supplied.</div></li><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'>The refund request is valid.</div></li><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'>The merchant understands that the request is queued for admin review.</div></li></ul><h2 class='preserveHtml' >16.7 Invoice cannot be deleted</h2><p class='preserveHtml' >The collection states that deletion only works for an unsent draft.</p><h2 class='preserveHtml' >16.8 Invoice cannot be voided</h2><p class='preserveHtml' >The collection states that voiding is blocked after payment.</p><h2 class='preserveHtml' >16.9 Card iframe does not work</h2><p class='preserveHtml' >Check:</p><ul class='preserveHtml' ><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'><code class='preserveHtml' >origin</code> exactly matches the HTTPS origin hosting the iframe.</div></li><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'>No path is included in <code class='preserveHtml' >origin</code>.</div></li><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'>The session token belongs to that origin.</div></li><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'>The iframe is loaded from the HealthPay card iframe URL.</div></li><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'>Browser <code class='preserveHtml' >postMessage</code> handling is implemented.</div></li></ul><p class='preserveHtml' >Example origin:</p><pre class='preserveHtml' class=text><code class='preserveHtml' class='preserveHtml'><div class='preserveHtml' class='preserveHtml'>https://shop.example.com\n
</div></code></pre><p class='preserveHtml' >Not:</p><pre class='preserveHtml' class=text><code class='preserveHtml' class='preserveHtml'><div class='preserveHtml' class='preserveHtml'>https://shop.example.com/checkout\n
</div></code></pre><h2 class='preserveHtml' >16.10 Postman card-session testing does not complete</h2><p class='preserveHtml' >This is expected from the collection documentation: Postman cannot perform the browser iframe and <code class='preserveHtml' >postMessage</code> handshake.</p><p class='preserveHtml' >Use a browser-based test page hosted on the same origin used to create the card session.</p><div class='preserveHtml' ><hr class='preserveHtml' contenteditable=\"false\" /></div><h1 class='preserveHtml' >17. Postman Collection</h1><p class='preserveHtml' >The supplied Postman collection contains these folders:</p><pre class='preserveHtml' class=text><code class='preserveHtml' class='preserveHtml'><div class='preserveHtml' class='preserveHtml'>1. Orders (gateway-pg)\n
</div><div class='preserveHtml' class='preserveHtml'> ├── Create order\n
</div><div class='preserveHtml' class='preserveHtml'> ├── Look up order by uuid\n
</div><div class='preserveHtml' class='preserveHtml'> ├── Look up order by id\n
</div><div class='preserveHtml' class='preserveHtml'> └── Cancel order\n
</div><div class='preserveHtml' class='preserveHtml'>2. Checkout (pg-lrvl)\n
</div><div class='preserveHtml' class='preserveHtml'> └── Get checkout URL\n
</div><div class='preserveHtml' class='preserveHtml'>3. Refunds (pg-lrvl)\n
</div><div class='preserveHtml' class='preserveHtml'> ├── List refund requests\n
</div><div class='preserveHtml' class='preserveHtml'> ├── Request a refund\n
</div><div class='preserveHtml' class='preserveHtml'> └── Look up a refund\n
</div><div class='preserveHtml' class='preserveHtml'>4. Invoices (pg-lrvl)\n
</div><div class='preserveHtml' class='preserveHtml'> ├── List invoices\n
</div><div class='preserveHtml' class='preserveHtml'> ├── Create a draft invoice\n
</div><div class='preserveHtml' class='preserveHtml'> ├── Look up an invoice\n
</div><div class='preserveHtml' class='preserveHtml'> ├── Send invoice\n
</div><div class='preserveHtml' class='preserveHtml'> ├── Download invoice PDF\n
</div><div class='preserveHtml' class='preserveHtml'> ├── Void invoice\n
</div><div class='preserveHtml' class='preserveHtml'> └── Delete draft invoice\n
</div><div class='preserveHtml' class='preserveHtml'>5. Subscriptions (pg-lrvl)\n
</div><div class='preserveHtml' class='preserveHtml'> ├── List subscriptions\n
</div><div class='preserveHtml' class='preserveHtml'> ├── Create a subscription\n
</div><div class='preserveHtml' class='preserveHtml'> ├── Pause subscription\n
</div><div class='preserveHtml' class='preserveHtml'> ├── Resume subscription\n
</div><div class='preserveHtml' class='preserveHtml'> └── Cancel subscription\n
</div><div class='preserveHtml' class='preserveHtml'>6. Balance & Settlements (pg-lrvl, read-only)\n
</div><div class='preserveHtml' class='preserveHtml'> ├── Current ledger balance\n
</div><div class='preserveHtml' class='preserveHtml'> └── Settlement batch history\n
</div><div class='preserveHtml' class='preserveHtml'>7. Card Sessions (gateway-pg)\n
</div><div class='preserveHtml' class='preserveHtml'> └── Create card-iframe session\n
</div></code></pre><p class='preserveHtml' >The collection also automatically stores intermediate values such as order UUID, order ID, checkout URL, refund ID, invoice UUID, subscription UUID, and card session token.</p><div class='preserveHtml' ><hr class='preserveHtml' contenteditable=\"false\" /></div><h1 class='preserveHtml' >18. Complete Merchant Integration Example</h1><h2 class='preserveHtml' >18.1 Backend</h2><pre class='preserveHtml' class=text><code class='preserveHtml' class='preserveHtml'><div class='preserveHtml' class='preserveHtml'>Customer\n
</div><div class='preserveHtml' class='preserveHtml'> |\n
</div><div class='preserveHtml' class='preserveHtml'> | Buy product\n
</div><div class='preserveHtml' class='preserveHtml'> v\n
</div><div class='preserveHtml' class='preserveHtml'>Merchant Website\n
</div><div class='preserveHtml' class='preserveHtml'> |\n
</div><div class='preserveHtml' class='preserveHtml'> | Create HealthPay order\n
</div><div class='preserveHtml' class='preserveHtml'> v\n
</div><div class='preserveHtml' class='preserveHtml'>Merchant Backend\n
</div><div class='preserveHtml' class='preserveHtml'> |\n
</div><div class='preserveHtml' class='preserveHtml'> | POST /v1/orders\n
</div><div class='preserveHtml' class='preserveHtml'> v\n
</div><div class='preserveHtml' class='preserveHtml'>HealthPay\n
</div><div class='preserveHtml' class='preserveHtml'> |\n
</div><div class='preserveHtml' class='preserveHtml'> | uuid\n
</div><div class='preserveHtml' class='preserveHtml'> v\n
</div><div class='preserveHtml' class='preserveHtml'>Merchant Backend\n
</div><div class='preserveHtml' class='preserveHtml'> |\n
</div><div class='preserveHtml' class='preserveHtml'> | POST /api/v1/orders/{uuid}/checkout-url\n
</div><div class='preserveHtml' class='preserveHtml'> v\n
</div><div class='preserveHtml' class='preserveHtml'>HealthPay\n
</div><div class='preserveHtml' class='preserveHtml'> |\n
</div><div class='preserveHtml' class='preserveHtml'> | checkoutUrl\n
</div><div class='preserveHtml' class='preserveHtml'> v\n
</div><div class='preserveHtml' class='preserveHtml'>Merchant Backend\n
</div><div class='preserveHtml' class='preserveHtml'> |\n
</div><div class='preserveHtml' class='preserveHtml'> | redirect\n
</div><div class='preserveHtml' class='preserveHtml'> v\n
</div><div class='preserveHtml' class='preserveHtml'>Customer\n
</div><div class='preserveHtml' class='preserveHtml'> |\n
</div><div class='preserveHtml' class='preserveHtml'> | payment\n
</div><div class='preserveHtml' class='preserveHtml'> v\n
</div><div class='preserveHtml' class='preserveHtml'>HealthPay Checkout\n
</div><div class='preserveHtml' class='preserveHtml'> |\n
</div><div class='preserveHtml' class='preserveHtml'> +----</comment> notificationUrl\n
</div><div class='preserveHtml' class='preserveHtml'> |\n
</div><div class='preserveHtml' class='preserveHtml'> v\n
</div><div class='preserveHtml' class='preserveHtml'>Merchant Backend\n
</div><div class='preserveHtml' class='preserveHtml'> |\n
</div><div class='preserveHtml' class='preserveHtml'> | GET /v1/orders/uuid/{uuid}\n
</div><div class='preserveHtml' class='preserveHtml'> v\n
</div><div class='preserveHtml' class='preserveHtml'>HealthPay\n
</div><div class='preserveHtml' class='preserveHtml'> |\n
</div><div class='preserveHtml' class='preserveHtml'> | final status\n
</div><div class='preserveHtml' class='preserveHtml'> v\n
</div><div class='preserveHtml' class='preserveHtml'>Merchant Backend\n
</div><div class='preserveHtml' class='preserveHtml'> |\n
</div><div class='preserveHtml' class='preserveHtml'> | fulfill order\n
</div><div class='preserveHtml' class='preserveHtml'> v\n
</div><div class='preserveHtml' class='preserveHtml'>Customer\n
</div></code></pre><h2 class='preserveHtml' >18.2 Example pseudo-code</h2><pre class='preserveHtml' class=javascript><code class='preserveHtml' class='preserveHtml'><div class='preserveHtml' class='preserveHtml'>// 1. Create order\n
</div><div class='preserveHtml' class='preserveHtml'>const order = await healthpay.createOrder({\n
</div><div class='preserveHtml' class='preserveHtml'> environment: \"test\",\n
</div><div class='preserveHtml' class='preserveHtml'> reference: merchantOrderReference,\n
</div><div class='preserveHtml' class='preserveHtml'> amount: orderAmount,\n
</div><div class='preserveHtml' class='preserveHtml'> currency: \"EGP\",\n
</div><div class='preserveHtml' class='preserveHtml'> apiOperation: \"PAY\",\n
</div><div class='preserveHtml' class='preserveHtml'> notificationUrl: webhookUrl\n
</div><div class='preserveHtml' class='preserveHtml'>});\n
</div><div class='preserveHtml' class='preserveHtml'>// 2. Create checkout URL\n
</div><div class='preserveHtml' class='preserveHtml'>const checkout = await healthpay.createCheckoutUrl(order.uuid, {\n
</div><div class='preserveHtml' class='preserveHtml'> customer_name: customer.name,\n
</div><div class='preserveHtml' class='preserveHtml'> customer_email: customer.email,\n
</div><div class='preserveHtml' class='preserveHtml'> customer_mobile: customer.mobile\n
</div><div class='preserveHtml' class='preserveHtml'>});\n
</div><div class='preserveHtml' class='preserveHtml'>// 3. Redirect customer\n
</div><div class='preserveHtml' class='preserveHtml'>return redirect(checkout.checkoutUrl);\n
</div></code></pre><p class='preserveHtml' >After payment:</p><pre class='preserveHtml' class=javascript><code class='preserveHtml' class='preserveHtml'><div class='preserveHtml' class='preserveHtml'>// Never fulfill solely because the customer returned to your site.\n
</div><div class='preserveHtml' class='preserveHtml'>// Verify the HealthPay order state.\n
</div><div class='preserveHtml' class='preserveHtml'>const order = await healthpay.getOrderByUuid(orderUuid);\n
</div><div class='preserveHtml' class='preserveHtml'>if (isConfirmedSuccessful(order)) {\n
</div><div class='preserveHtml' class='preserveHtml'> fulfillMerchantOrder();\n
</div><div class='preserveHtml' class='preserveHtml'>}\n
</div></code></pre><p class='preserveHtml' ><code class='preserveHtml' >isConfirmedSuccessful()</code> must use the actual documented HealthPay status values once those values are confirmed.</p><div class='preserveHtml' ><hr class='preserveHtml' contenteditable=\"false\" /></div><h1 class='preserveHtml' >19. API Reference Summary</h1><div class='preserveHtml' ><table class='preserveHtml' class='preserveHtml'><tbody class='preserveHtml' class='preserveHtml'><tr class='preserveHtml' ><th class='preserveHtml' >Method</th><th class='preserveHtml' >Endpoint</th><th class='preserveHtml' >Purpose</th></tr><tr class='preserveHtml' ><td class='preserveHtml' ><div class='preserveHtml' >POST</div><div class='preserveHtml' contenteditable=\"false\"><div class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'><div class='preserveHtml' ></div></div></div><div class='preserveHtml' ></div></div></td><td class='preserveHtml' ><div class='preserveHtml' ><code class='preserveHtml' >/v1/orders</code></div><div class='preserveHtml' contenteditable=\"false\"><div class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'><div class='preserveHtml' ></div></div></div><div class='preserveHtml' ></div></div></td><td class='preserveHtml' ><div class='preserveHtml' >Create order</div><div class='preserveHtml' contenteditable=\"false\"><div class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'><div class='preserveHtml' ></div></div></div><div class='preserveHtml' ></div></div></td></tr><tr class='preserveHtml' ><td class='preserveHtml' ><div class='preserveHtml' >GET</div><div class='preserveHtml' contenteditable=\"false\"><div class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'><div class='preserveHtml' ></div></div></div><div class='preserveHtml' ></div></div></td><td class='preserveHtml' ><div class='preserveHtml' ><code class='preserveHtml' >/v1/orders/uuid/{order_uuid}</code></div><div class='preserveHtml' contenteditable=\"false\"><div class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'><div class='preserveHtml' ></div></div></div><div class='preserveHtml' ></div></div></td><td class='preserveHtml' ><div class='preserveHtml' >Get order by UUID</div><div class='preserveHtml' contenteditable=\"false\"><div class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'><div class='preserveHtml' ></div></div></div><div class='preserveHtml' ></div></div></td></tr><tr class='preserveHtml' ><td class='preserveHtml' ><div class='preserveHtml' >GET</div><div class='preserveHtml' contenteditable=\"false\"><div class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'><div class='preserveHtml' ></div></div></div><div class='preserveHtml' ></div></div></td><td class='preserveHtml' ><div class='preserveHtml' ><code class='preserveHtml' >/v1/orders/{order_id}</code></div><div class='preserveHtml' contenteditable=\"false\"><div class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'><div class='preserveHtml' ></div></div></div><div class='preserveHtml' ></div></div></td><td class='preserveHtml' ><div class='preserveHtml' >Get order by ID</div><div class='preserveHtml' contenteditable=\"false\"><div class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'><div class='preserveHtml' ></div></div></div><div class='preserveHtml' ></div></div></td></tr><tr class='preserveHtml' ><td class='preserveHtml' ><div class='preserveHtml' >POST</div><div class='preserveHtml' contenteditable=\"false\"><div class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'><div class='preserveHtml' ></div></div></div><div class='preserveHtml' ></div></div></td><td class='preserveHtml' ><div class='preserveHtml' ><code class='preserveHtml' >/v1/orders/{order_id}/cancel</code></div><div class='preserveHtml' contenteditable=\"false\"><div class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'><div class='preserveHtml' ></div></div></div><div class='preserveHtml' ></div></div></td><td class='preserveHtml' ><div class='preserveHtml' >Cancel order</div><div class='preserveHtml' contenteditable=\"false\"><div class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'><div class='preserveHtml' ></div></div></div><div class='preserveHtml' ></div></div></td></tr><tr class='preserveHtml' ><td class='preserveHtml' ><div class='preserveHtml' >POST</div><div class='preserveHtml' contenteditable=\"false\"><div class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'><div class='preserveHtml' ></div></div></div><div class='preserveHtml' ></div></div></td><td class='preserveHtml' ><div class='preserveHtml' ><code class='preserveHtml' >/api/v1/orders/{order_uuid}/checkout-url</code></div><div class='preserveHtml' contenteditable=\"false\"><div class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'><div class='preserveHtml' ></div></div></div><div class='preserveHtml' ></div></div></td><td class='preserveHtml' ><div class='preserveHtml' >Create checkout URL</div><div class='preserveHtml' contenteditable=\"false\"><div class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'><div class='preserveHtml' ></div></div></div><div class='preserveHtml' ></div></div></td></tr><tr class='preserveHtml' ><td class='preserveHtml' ><div class='preserveHtml' >GET</div><div class='preserveHtml' contenteditable=\"false\"><div class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'><div class='preserveHtml' ></div></div></div><div class='preserveHtml' ></div></div></td><td class='preserveHtml' ><div class='preserveHtml' ><code class='preserveHtml' >/api/v1/refunds</code></div><div class='preserveHtml' contenteditable=\"false\"><div class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'><div class='preserveHtml' ></div></div></div><div class='preserveHtml' ></div></div></td><td class='preserveHtml' ><div class='preserveHtml' >List refunds</div><div class='preserveHtml' contenteditable=\"false\"><div class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'><div class='preserveHtml' ></div></div></div><div class='preserveHtml' ></div></div></td></tr><tr class='preserveHtml' ><td class='preserveHtml' ><div class='preserveHtml' >POST</div><div class='preserveHtml' contenteditable=\"false\"><div class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'><div class='preserveHtml' ></div></div></div><div class='preserveHtml' ></div></div></td><td class='preserveHtml' ><div class='preserveHtml' ><code class='preserveHtml' >/api/v1/refunds</code></div><div class='preserveHtml' contenteditable=\"false\"><div class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'><div class='preserveHtml' ></div></div></div><div class='preserveHtml' ></div></div></td><td class='preserveHtml' ><div class='preserveHtml' >Request refund</div><div class='preserveHtml' contenteditable=\"false\"><div class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'><div class='preserveHtml' ></div></div></div><div class='preserveHtml' ></div></div></td></tr><tr class='preserveHtml' ><td class='preserveHtml' ><div class='preserveHtml' >GET</div><div class='preserveHtml' contenteditable=\"false\"><div class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'><div class='preserveHtml' ></div></div></div><div class='preserveHtml' ></div></div></td><td class='preserveHtml' ><div class='preserveHtml' ><code class='preserveHtml' >/api/v1/refunds/{refund_id}</code></div><div class='preserveHtml' contenteditable=\"false\"><div class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'><div class='preserveHtml' ></div></div></div><div class='preserveHtml' ></div></div></td><td class='preserveHtml' ><div class='preserveHtml' >Get refund</div><div class='preserveHtml' contenteditable=\"false\"><div class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'><div class='preserveHtml' ></div></div></div><div class='preserveHtml' ></div></div></td></tr><tr class='preserveHtml' ><td class='preserveHtml' ><div class='preserveHtml' >GET</div><div class='preserveHtml' contenteditable=\"false\"><div class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'><div class='preserveHtml' ></div></div></div><div class='preserveHtml' ></div></div></td><td class='preserveHtml' ><div class='preserveHtml' ><code class='preserveHtml' >/api/v1/invoices</code></div><div class='preserveHtml' contenteditable=\"false\"><div class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'><div class='preserveHtml' ></div></div></div><div class='preserveHtml' ></div></div></td><td class='preserveHtml' ><div class='preserveHtml' >List invoices</div><div class='preserveHtml' contenteditable=\"false\"><div class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'><div class='preserveHtml' ></div></div></div><div class='preserveHtml' ></div></div></td></tr><tr class='preserveHtml' ><td class='preserveHtml' ><div class='preserveHtml' >POST</div><div class='preserveHtml' contenteditable=\"false\"><div class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'><div class='preserveHtml' ></div></div></div><div class='preserveHtml' ></div></div></td><td class='preserveHtml' ><div class='preserveHtml' ><code class='preserveHtml' >/api/v1/invoices</code></div><div class='preserveHtml' contenteditable=\"false\"><div class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'><div class='preserveHtml' ></div></div></div><div class='preserveHtml' ></div></div></td><td class='preserveHtml' ><div class='preserveHtml' >Create invoice</div><div class='preserveHtml' contenteditable=\"false\"><div class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'><div class='preserveHtml' ></div></div></div><div class='preserveHtml' ></div></div></td></tr><tr class='preserveHtml' ><td class='preserveHtml' ><div class='preserveHtml' >GET</div><div class='preserveHtml' contenteditable=\"false\"><div class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'><div class='preserveHtml' ></div></div></div><div class='preserveHtml' ></div></div></td><td class='preserveHtml' ><div class='preserveHtml' ><code class='preserveHtml' >/api/v1/invoices/{invoice_uuid}</code></div><div class='preserveHtml' contenteditable=\"false\"><div class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'><div class='preserveHtml' ></div></div></div><div class='preserveHtml' ></div></div></td><td class='preserveHtml' ><div class='preserveHtml' >Get invoice</div><div class='preserveHtml' contenteditable=\"false\"><div class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'><div class='preserveHtml' ></div></div></div><div class='preserveHtml' ></div></div></td></tr><tr class='preserveHtml' ><td class='preserveHtml' ><div class='preserveHtml' >POST</div><div class='preserveHtml' contenteditable=\"false\"><div class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'><div class='preserveHtml' ></div></div></div><div class='preserveHtml' ></div></div></td><td class='preserveHtml' ><div class='preserveHtml' ><code class='preserveHtml' >/api/v1/invoices/{invoice_uuid}/send</code></div><div class='preserveHtml' contenteditable=\"false\"><div class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'><div class='preserveHtml' ></div></div></div><div class='preserveHtml' ></div></div></td><td class='preserveHtml' ><div class='preserveHtml' >Send invoice</div><div class='preserveHtml' contenteditable=\"false\"><div class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'><div class='preserveHtml' ></div></div></div><div class='preserveHtml' ></div></div></td></tr><tr class='preserveHtml' ><td class='preserveHtml' ><div class='preserveHtml' >GET</div><div class='preserveHtml' contenteditable=\"false\"><div class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'><div class='preserveHtml' ></div></div></div><div class='preserveHtml' ></div></div></td><td class='preserveHtml' ><div class='preserveHtml' ><code class='preserveHtml' >/api/v1/invoices/{invoice_uuid}/pdf</code></div><div class='preserveHtml' contenteditable=\"false\"><div class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'><div class='preserveHtml' ></div></div></div><div class='preserveHtml' ></div></div></td><td class='preserveHtml' ><div class='preserveHtml' >Download PDF</div><div class='preserveHtml' contenteditable=\"false\"><div class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'><div class='preserveHtml' ></div></div></div><div class='preserveHtml' ></div></div></td></tr><tr class='preserveHtml' ><td class='preserveHtml' ><div class='preserveHtml' >POST</div><div class='preserveHtml' contenteditable=\"false\"><div class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'><div class='preserveHtml' ></div></div></div><div class='preserveHtml' ></div></div></td><td class='preserveHtml' ><div class='preserveHtml' ><code class='preserveHtml' >/api/v1/invoices/{invoice_uuid}/void</code></div><div class='preserveHtml' contenteditable=\"false\"><div class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'><div class='preserveHtml' ></div></div></div><div class='preserveHtml' ></div></div></td><td class='preserveHtml' ><div class='preserveHtml' >Void invoice</div><div class='preserveHtml' contenteditable=\"false\"><div class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'><div class='preserveHtml' ></div></div></div><div class='preserveHtml' ></div></div></td></tr><tr class='preserveHtml' ><td class='preserveHtml' ><div class='preserveHtml' >DELETE</div><div class='preserveHtml' contenteditable=\"false\"><div class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'><div class='preserveHtml' ></div></div></div><div class='preserveHtml' ></div></div></td><td class='preserveHtml' ><div class='preserveHtml' ><code class='preserveHtml' >/api/v1/invoices/{invoice_uuid}</code></div><div class='preserveHtml' contenteditable=\"false\"><div class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'><div class='preserveHtml' ></div></div></div><div class='preserveHtml' ></div></div></td><td class='preserveHtml' ><div class='preserveHtml' >Delete draft</div><div class='preserveHtml' contenteditable=\"false\"><div class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'><div class='preserveHtml' ></div></div></div><div class='preserveHtml' ></div></div></td></tr><tr class='preserveHtml' ><td class='preserveHtml' ><div class='preserveHtml' >GET</div><div class='preserveHtml' contenteditable=\"false\"><div class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'><div class='preserveHtml' ></div></div></div><div class='preserveHtml' ></div></div></td><td class='preserveHtml' ><div class='preserveHtml' ><code class='preserveHtml' >/api/v1/subscriptions</code></div><div class='preserveHtml' contenteditable=\"false\"><div class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'><div class='preserveHtml' ></div></div></div><div class='preserveHtml' ></div></div></td><td class='preserveHtml' ><div class='preserveHtml' >List subscriptions</div><div class='preserveHtml' contenteditable=\"false\"><div class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'><div class='preserveHtml' ></div></div></div><div class='preserveHtml' ></div></div></td></tr><tr class='preserveHtml' ><td class='preserveHtml' ><div class='preserveHtml' >POST</div><div class='preserveHtml' contenteditable=\"false\"><div class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'><div class='preserveHtml' ></div></div></div><div class='preserveHtml' ></div></div></td><td class='preserveHtml' ><div class='preserveHtml' ><code class='preserveHtml' >/api/v1/subscriptions</code></div><div class='preserveHtml' contenteditable=\"false\"><div class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'><div class='preserveHtml' ></div></div></div><div class='preserveHtml' ></div></div></td><td class='preserveHtml' ><div class='preserveHtml' >Create subscription</div><div class='preserveHtml' contenteditable=\"false\"><div class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'><div class='preserveHtml' ></div></div></div><div class='preserveHtml' ></div></div></td></tr><tr class='preserveHtml' ><td class='preserveHtml' ><div class='preserveHtml' >POST</div><div class='preserveHtml' contenteditable=\"false\"><div class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'><div class='preserveHtml' ></div></div></div><div class='preserveHtml' ></div></div></td><td class='preserveHtml' ><div class='preserveHtml' ><code class='preserveHtml' >/api/v1/subscriptions/{subscription_uuid}/pause</code></div><div class='preserveHtml' contenteditable=\"false\"><div class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'><div class='preserveHtml' ></div></div></div><div class='preserveHtml' ></div></div></td><td class='preserveHtml' ><div class='preserveHtml' >Pause</div><div class='preserveHtml' contenteditable=\"false\"><div class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'><div class='preserveHtml' ></div></div></div><div class='preserveHtml' ></div></div></td></tr><tr class='preserveHtml' ><td class='preserveHtml' ><div class='preserveHtml' >POST</div><div class='preserveHtml' contenteditable=\"false\"><div class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'><div class='preserveHtml' ></div></div></div><div class='preserveHtml' ></div></div></td><td class='preserveHtml' ><div class='preserveHtml' ><code class='preserveHtml' >/api/v1/subscriptions/{subscription_uuid}/resume</code></div><div class='preserveHtml' contenteditable=\"false\"><div class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'><div class='preserveHtml' ></div></div></div><div class='preserveHtml' ></div></div></td><td class='preserveHtml' ><div class='preserveHtml' >Resume</div><div class='preserveHtml' contenteditable=\"false\"><div class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'><div class='preserveHtml' ></div></div></div><div class='preserveHtml' ></div></div></td></tr><tr class='preserveHtml' ><td class='preserveHtml' ><div class='preserveHtml' >POST</div><div class='preserveHtml' contenteditable=\"false\"><div class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'><div class='preserveHtml' ></div></div></div><div class='preserveHtml' ></div></div></td><td class='preserveHtml' ><div class='preserveHtml' ><code class='preserveHtml' >/api/v1/subscriptions/{subscription_uuid}/cancel</code></div><div class='preserveHtml' contenteditable=\"false\"><div class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'><div class='preserveHtml' ></div></div></div><div class='preserveHtml' ></div></div></td><td class='preserveHtml' ><div class='preserveHtml' >Cancel</div><div class='preserveHtml' contenteditable=\"false\"><div class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'><div class='preserveHtml' ></div></div></div><div class='preserveHtml' ></div></div></td></tr><tr class='preserveHtml' ><td class='preserveHtml' ><div class='preserveHtml' >GET</div><div class='preserveHtml' contenteditable=\"false\"><div class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'><div class='preserveHtml' ></div></div></div><div class='preserveHtml' ></div></div></td><td class='preserveHtml' ><div class='preserveHtml' ><code class='preserveHtml' >/api/v1/balance</code></div><div class='preserveHtml' contenteditable=\"false\"><div class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'><div class='preserveHtml' ></div></div></div><div class='preserveHtml' ></div></div></td><td class='preserveHtml' ><div class='preserveHtml' >Current balance</div><div class='preserveHtml' contenteditable=\"false\"><div class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'><div class='preserveHtml' ></div></div></div><div class='preserveHtml' ></div></div></td></tr><tr class='preserveHtml' ><td class='preserveHtml' ><div class='preserveHtml' >GET</div><div class='preserveHtml' contenteditable=\"false\"><div class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'><div class='preserveHtml' ></div></div></div><div class='preserveHtml' ></div></div></td><td class='preserveHtml' ><div class='preserveHtml' ><code class='preserveHtml' >/api/v1/settlements</code></div><div class='preserveHtml' contenteditable=\"false\"><div class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'><div class='preserveHtml' ></div></div></div><div class='preserveHtml' ></div></div></td><td class='preserveHtml' ><div class='preserveHtml' >Settlement history</div><div class='preserveHtml' contenteditable=\"false\"><div class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'><div class='preserveHtml' ></div></div></div><div class='preserveHtml' ></div></div></td></tr><tr class='preserveHtml' ><td class='preserveHtml' ><div class='preserveHtml' >POST</div><div class='preserveHtml' contenteditable=\"false\"><div class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'><div class='preserveHtml' ></div></div></div><div class='preserveHtml' ></div></div></td><td class='preserveHtml' ><div class='preserveHtml' ><code class='preserveHtml' >/v1/card-sessions</code></div><div class='preserveHtml' contenteditable=\"false\"><div class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'><div class='preserveHtml' ></div></div></div><div class='preserveHtml' ></div></div></td><td class='preserveHtml' ><div class='preserveHtml' >Create card session</div><div class='preserveHtml' contenteditable=\"false\"><div class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'><div class='preserveHtml' ></div></div></div><div class='preserveHtml' ></div></div></td></tr></tbody></table></div><div class='preserveHtml' ><hr class='preserveHtml' contenteditable=\"false\" /></div><h1 class='preserveHtml' >20. Information That Must Be Confirmed Before Publishing as Final API Contract</h1><p class='preserveHtml' >The supplied Postman collection is enough to document the available operations and basic integration flows, but the following are not defined in it:</p><ol class='preserveHtml' ><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'>Complete response schemas for every endpoint.</div></li><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'>Complete order status list.</div></li><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'>Complete refund status list.</div></li><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'>Complete invoice status list.</div></li><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'>Complete subscription status list.</div></li><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'>Complete settlement status list.</div></li><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'>Error response schema.</div></li><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'>Error code catalog.</div></li><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'>Required/optional status of every request field.</div></li><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'>Field validation rules and maximum lengths.</div></li><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'>Amount precision/unit rules.</div></li><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'>Pagination parameters and response format.</div></li><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'>Rate limits.</div></li><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'>API key scopes/permissions.</div></li><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'>API key expiration/rotation behavior.</div></li><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'>Webhook payload schema.</div></li><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'>Webhook event names.</div></li><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'>Webhook signature/authentication.</div></li><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'>Webhook retries and timeout behavior.</div></li><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'>Idempotency mechanism.</div></li><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'>Production/sandbox endpoint separation.</div></li><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'>Production test procedure.</div></li><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'>Exact card-tokenization event payload.</div></li><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'>Supported subscription interval units.</div></li><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'>Refund approval/processing status transitions.</div></li><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'>Settlement schedule and fee behavior.</div></li></ol><p class='preserveHtml' >These should be obtained from the API implementation or official HealthPay backend specification before being presented to merchants as guaranteed behavior.</p><div class='preserveHtml' ><hr class='preserveHtml' contenteditable=\"false\" /></div><h1 class='preserveHtml' >21. Merchant Support Philosophy</h1><p class='preserveHtml' >A merchant should be able to complete the following without contacting HealthPay engineering:</p><pre class='preserveHtml' class=text><code class='preserveHtml' class='preserveHtml'><div class='preserveHtml' class='preserveHtml'>Get credentials\n
</div><div class='preserveHtml' class='preserveHtml'> ↓\n
</div><div class='preserveHtml' class='preserveHtml'>Configure API\n
</div><div class='preserveHtml' class='preserveHtml'> ↓\n
</div><div class='preserveHtml' class='preserveHtml'>Create order\n
</div><div class='preserveHtml' class='preserveHtml'> ↓\n
</div><div class='preserveHtml' class='preserveHtml'>Create checkout\n
</div><div class='preserveHtml' class='preserveHtml'> ↓\n
</div><div class='preserveHtml' class='preserveHtml'>Test payment\n
</div><div class='preserveHtml' class='preserveHtml'> ↓\n
</div><div class='preserveHtml' class='preserveHtml'>Verify payment\n
</div><div class='preserveHtml' class='preserveHtml'> ↓\n
</div><div class='preserveHtml' class='preserveHtml'>Configure notifications\n
</div><div class='preserveHtml' class='preserveHtml'> ↓\n
</div><div class='preserveHtml' class='preserveHtml'>Handle failures\n
</div><div class='preserveHtml' class='preserveHtml'> ↓\n
</div><div class='preserveHtml' class='preserveHtml'>Request refund\n
</div><div class='preserveHtml' class='preserveHtml'> ↓\n
</div><div class='preserveHtml' class='preserveHtml'>Use invoices\n
</div><div class='preserveHtml' class='preserveHtml'> ↓\n
</div><div class='preserveHtml' class='preserveHtml'>Use subscriptions\n
</div><div class='preserveHtml' class='preserveHtml'> ↓\n
</div><div class='preserveHtml' class='preserveHtml'>Check balance\n
</div><div class='preserveHtml' class='preserveHtml'> ↓\n
</div><div class='preserveHtml' class='preserveHtml'>Check settlements\n
</div><div class='preserveHtml' class='preserveHtml'> ↓\n
</div><div class='preserveHtml' class='preserveHtml'>Integrate card sessions\n
</div><div class='preserveHtml' class='preserveHtml'> ↓\n
</div><div class='preserveHtml' class='preserveHtml'>Complete production checklist\n
</div></code></pre><p class='preserveHtml' >If a merchant reaches a point where they need engineering assistance for one of these standard flows, the documentation should contain either a concrete example, a troubleshooting procedure, or an explicit explanation of the missing requirement.</p><div class='preserveHtml' ><hr class='preserveHtml' contenteditable=\"false\" /></div><h1 class='preserveHtml' >Appendix A — Postman Variables</h1><div class='preserveHtml' ><table class='preserveHtml' class='preserveHtml'><tbody class='preserveHtml' class='preserveHtml'><tr class='preserveHtml' ><th class='preserveHtml' >Variable</th><th class='preserveHtml' >Purpose</th></tr><tr class='preserveHtml' ><td class='preserveHtml' ><div class='preserveHtml' ><code class='preserveHtml' >base_gateway</code></div><div class='preserveHtml' contenteditable=\"false\"><div class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'><div class='preserveHtml' ></div></div></div><div class='preserveHtml' ></div></div></td><td class='preserveHtml' ><div class='preserveHtml' >Gateway API base URL</div><div class='preserveHtml' contenteditable=\"false\"><div class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'><div class='preserveHtml' ></div></div></div><div class='preserveHtml' ></div></div></td></tr><tr class='preserveHtml' ><td class='preserveHtml' ><div class='preserveHtml' ><code class='preserveHtml' >base_dashboard</code></div><div class='preserveHtml' contenteditable=\"false\"><div class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'><div class='preserveHtml' ></div></div></div><div class='preserveHtml' ></div></div></td><td class='preserveHtml' ><div class='preserveHtml' >Dashboard API base URL</div><div class='preserveHtml' contenteditable=\"false\"><div class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'><div class='preserveHtml' ></div></div></div><div class='preserveHtml' ></div></div></td></tr><tr class='preserveHtml' ><td class='preserveHtml' ><div class='preserveHtml' ><code class='preserveHtml' >api_key</code></div><div class='preserveHtml' contenteditable=\"false\"><div class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'><div class='preserveHtml' ></div></div></div><div class='preserveHtml' ></div></div></td><td class='preserveHtml' ><div class='preserveHtml' >Bearer API key</div><div class='preserveHtml' contenteditable=\"false\"><div class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'><div class='preserveHtml' ></div></div></div><div class='preserveHtml' ></div></div></td></tr><tr class='preserveHtml' ><td class='preserveHtml' ><div class='preserveHtml' ><code class='preserveHtml' >order_uuid</code></div><div class='preserveHtml' contenteditable=\"false\"><div class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'><div class='preserveHtml' ></div></div></div><div class='preserveHtml' ></div></div></td><td class='preserveHtml' ><div class='preserveHtml' >Current order UUID</div><div class='preserveHtml' contenteditable=\"false\"><div class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'><div class='preserveHtml' ></div></div></div><div class='preserveHtml' ></div></div></td></tr><tr class='preserveHtml' ><td class='preserveHtml' ><div class='preserveHtml' ><code class='preserveHtml' >order_id</code></div><div class='preserveHtml' contenteditable=\"false\"><div class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'><div class='preserveHtml' ></div></div></div><div class='preserveHtml' ></div></div></td><td class='preserveHtml' ><div class='preserveHtml' >Current internal order ID</div><div class='preserveHtml' contenteditable=\"false\"><div class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'><div class='preserveHtml' ></div></div></div><div class='preserveHtml' ></div></div></td></tr><tr class='preserveHtml' ><td class='preserveHtml' ><div class='preserveHtml' ><code class='preserveHtml' >checkout_url</code></div><div class='preserveHtml' contenteditable=\"false\"><div class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'><div class='preserveHtml' ></div></div></div><div class='preserveHtml' ></div></div></td><td class='preserveHtml' ><div class='preserveHtml' >Generated checkout URL</div><div class='preserveHtml' contenteditable=\"false\"><div class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'><div class='preserveHtml' ></div></div></div><div class='preserveHtml' ></div></div></td></tr><tr class='preserveHtml' ><td class='preserveHtml' ><div class='preserveHtml' ><code class='preserveHtml' >refund_id</code></div><div class='preserveHtml' contenteditable=\"false\"><div class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'><div class='preserveHtml' ></div></div></div><div class='preserveHtml' ></div></div></td><td class='preserveHtml' ><div class='preserveHtml' >Current refund ID</div><div class='preserveHtml' contenteditable=\"false\"><div class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'><div class='preserveHtml' ></div></div></div><div class='preserveHtml' ></div></div></td></tr><tr class='preserveHtml' ><td class='preserveHtml' ><div class='preserveHtml' ><code class='preserveHtml' >invoice_uuid</code></div><div class='preserveHtml' contenteditable=\"false\"><div class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'><div class='preserveHtml' ></div></div></div><div class='preserveHtml' ></div></div></td><td class='preserveHtml' ><div class='preserveHtml' >Current invoice UUID</div><div class='preserveHtml' contenteditable=\"false\"><div class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'><div class='preserveHtml' ></div></div></div><div class='preserveHtml' ></div></div></td></tr><tr class='preserveHtml' ><td class='preserveHtml' ><div class='preserveHtml' ><code class='preserveHtml' >subscription_uuid</code></div><div class='preserveHtml' contenteditable=\"false\"><div class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'><div class='preserveHtml' ></div></div></div><div class='preserveHtml' ></div></div></td><td class='preserveHtml' ><div class='preserveHtml' >Current subscription UUID</div><div class='preserveHtml' contenteditable=\"false\"><div class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'><div class='preserveHtml' ></div></div></div><div class='preserveHtml' ></div></div></td></tr><tr class='preserveHtml' ><td class='preserveHtml' ><div class='preserveHtml' ><code class='preserveHtml' >card_session_origin</code></div><div class='preserveHtml' contenteditable=\"false\"><div class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'><div class='preserveHtml' ></div></div></div><div class='preserveHtml' ></div></div></td><td class='preserveHtml' ><div class='preserveHtml' >Browser origin used for card session</div><div class='preserveHtml' contenteditable=\"false\"><div class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'><div class='preserveHtml' ></div></div></div><div class='preserveHtml' ></div></div></td></tr><tr class='preserveHtml' ><td class='preserveHtml' ><div class='preserveHtml' ><code class='preserveHtml' >card_session_token</code></div><div class='preserveHtml' contenteditable=\"false\"><div class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'><div class='preserveHtml' ></div></div></div><div class='preserveHtml' ></div></div></td><td class='preserveHtml' ><div class='preserveHtml' >Generated card session token</div><div class='preserveHtml' contenteditable=\"false\"><div class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'><div class='preserveHtml' ></div></div></div><div class='preserveHtml' ></div></div></td></tr></tbody></table></div><h1 class='preserveHtml' >Appendix B — Recommended Merchant Data Mapping</h1><p class='preserveHtml' >A merchant should normally maintain its own mapping between its resources and HealthPay resources.</p><p class='preserveHtml' >Example:</p><pre class='preserveHtml' class=text><code class='preserveHtml' class='preserveHtml'><div class='preserveHtml' class='preserveHtml'>Merchant Order\n
</div><div class='preserveHtml' class='preserveHtml'> |\n
</div><div class='preserveHtml' class='preserveHtml'> +-- merchant_reference\n
</div><div class='preserveHtml' class='preserveHtml'> |\n
</div><div class='preserveHtml' class='preserveHtml'> +-- healthpay_order_uuid\n
</div><div class='preserveHtml' class='preserveHtml'> |\n
</div><div class='preserveHtml' class='preserveHtml'> +-- healthpay_order_id\n
</div><div class='preserveHtml' class='preserveHtml'> |\n
</div><div class='preserveHtml' class='preserveHtml'> +-- amount\n
</div><div class='preserveHtml' class='preserveHtml'> |\n
</div><div class='preserveHtml' class='preserveHtml'> +-- currency\n
</div><div class='preserveHtml' class='preserveHtml'> |\n
</div><div class='preserveHtml' class='preserveHtml'> +-- current_payment_status\n
</div><div class='preserveHtml' class='preserveHtml'> |\n
</div><div class='preserveHtml' class='preserveHtml'> +-- checkout_url\n
</div><div class='preserveHtml' class='preserveHtml'> |\n
</div><div class='preserveHtml' class='preserveHtml'> +-- created_at\n
</div><div class='preserveHtml' class='preserveHtml'> |\n
</div><div class='preserveHtml' class='preserveHtml'> +-- updated_at\n
</div></code></pre><p class='preserveHtml' >For refunds:</p><pre class='preserveHtml' class=text><code class='preserveHtml' class='preserveHtml'><div class='preserveHtml' class='preserveHtml'>Merchant Refund\n
</div><div class='preserveHtml' class='preserveHtml'> |\n
</div><div class='preserveHtml' class='preserveHtml'> +-- merchant_order_reference\n
</div><div class='preserveHtml' class='preserveHtml'> +-- healthpay_order_uuid\n
</div><div class='preserveHtml' class='preserveHtml'> +-- healthpay_refund_id\n
</div><div class='preserveHtml' class='preserveHtml'> +-- amount\n
</div><div class='preserveHtml' class='preserveHtml'> +-- reason\n
</div><div class='preserveHtml' class='preserveHtml'> +-- status\n
</div></code></pre><p class='preserveHtml' >The exact status values should be populated from the confirmed HealthPay API contract.</p><h1 class='preserveHtml' >Appendix C — Support Request Checklist</h1><p class='preserveHtml' >If technical support is required, the merchant should provide:</p><ul class='preserveHtml' ><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'>Merchant name/identifier</div></li><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'>Environment</div></li><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'>API endpoint</div></li><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'>HTTP method</div></li><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'>Timestamp</div></li><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'>Merchant reference</div></li><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'>HealthPay order UUID where applicable</div></li><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'>HealthPay resource ID where applicable</div></li><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'>HTTP status code</div></li><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'>Sanitized response body</div></li><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'>Relevant request body with secrets and sensitive data removed</div></li><li class='preserveHtml' ><div class='preserveHtml' class='preserveHtml'>Steps to reproduce</div></li></ul><p class='preserveHtml' >Never send an API key or other secret in a support ticket.</p><p class='preserveHtml' ></p></x-turndown>\n\nCreates a test-mode order. Saves the returned uuid into for the next requests.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"7ff6414d-f6f1-4d0c-9fc9-66841d4d7300","id":"7ff6414d-f6f1-4d0c-9fc9-66841d4d7300","name":"HealthPay PG Merchant API","type":"collection"}},"urlObject":{"path":["v1","orders"],"host":["https://gateway.pg.healthpay.com.eg"],"query":[],"variable":[]}},"response":[],"_postman_id":"c438818a-888d-4a47-8257-4b6688a18894"},{"name":"Look up order by uuid","event":[{"listen":"test","script":{"exec":["const json = pm.response.json();","if (json._id) { pm.collectionVariables.set('order_id', json._id); }","pm.test('order found', function () { pm.expect(pm.response.code).to.equal(200); });"],"type":"text/javascript","id":"6945beb4-9b11-4101-a2b6-44a9e694f6be"}}],"id":"d8e2c52b-62d6-4f99-b603-01a6cd4125a7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://gateway.pg.healthpay.com.eg/v1/orders/uuid/","description":"Check the order's status — run this again after paying via the checkout URL to see it flip to succeeded/failed.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"7ff6414d-f6f1-4d0c-9fc9-66841d4d7300","id":"7ff6414d-f6f1-4d0c-9fc9-66841d4d7300","name":"HealthPay PG Merchant API","type":"collection"}},"urlObject":{"path":["v1","orders","uuid",""],"host":["https://gateway.pg.healthpay.com.eg"],"query":[],"variable":[]}},"response":[],"_postman_id":"d8e2c52b-62d6-4f99-b603-01a6cd4125a7"},{"name":"Look up order by id","id":"daabd3ca-8f3f-4040-9f68-c2df0c018393","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://gateway.pg.healthpay.com.eg/v1/orders/","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"7ff6414d-f6f1-4d0c-9fc9-66841d4d7300","id":"7ff6414d-f6f1-4d0c-9fc9-66841d4d7300","name":"HealthPay PG Merchant API","type":"collection"}},"urlObject":{"path":["v1","orders",""],"host":["https://gateway.pg.healthpay.com.eg"],"query":[],"variable":[]}},"response":[],"_postman_id":"daabd3ca-8f3f-4040-9f68-c2df0c018393"},{"name":"Cancel order","id":"c0ee65b2-0b78-437d-98e0-a663a0f8fe52","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"reason\": \"Testing cancellation\"\n}"},"url":"https://gateway.pg.healthpay.com.eg/v1/orders//cancel","description":"Refused if the order is already paid or mid-flight — run this on a fresh order you don't intend to pay.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"7ff6414d-f6f1-4d0c-9fc9-66841d4d7300","id":"7ff6414d-f6f1-4d0c-9fc9-66841d4d7300","name":"HealthPay PG Merchant API","type":"collection"}},"urlObject":{"path":["v1","orders","","cancel"],"host":["https://gateway.pg.healthpay.com.eg"],"query":[],"variable":[]}},"response":[],"_postman_id":"c0ee65b2-0b78-437d-98e0-a663a0f8fe52"}],"id":"6b34151b-7216-47e6-91dc-e927d97ace4a","_postman_id":"6b34151b-7216-47e6-91dc-e927d97ace4a","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"7ff6414d-f6f1-4d0c-9fc9-66841d4d7300","id":"7ff6414d-f6f1-4d0c-9fc9-66841d4d7300","name":"HealthPay PG Merchant API","type":"collection"}}},{"name":"2. Checkout (pg-lrvl)","item":[{"name":"Get checkout URL","event":[{"listen":"test","script":{"exec":["const json = pm.response.json();","if (json.checkoutUrl) { pm.collectionVariables.set('checkout_url', json.checkoutUrl); }","pm.test('got a checkoutUrl', function () {"," pm.expect(pm.response.code).to.equal(200);"," pm.expect(json.checkoutUrl).to.be.a('string');","});"],"type":"text/javascript","id":"a1bb85f2-7f95-4c81-9228-ae15c3ab5b74"}}],"id":"33f44552-df01-4080-8a73-07aa48dfe747","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"customer_name\": \"Test Customer\",\n \"customer_email\": \"test@example.com\",\n \"customer_mobile\": \"+201001234567\"\n}"},"url":"https://dashboard.healthpay.com.eg/api/v1/orders//checkout-url","description":"Turns the order into a payable link. Open (check the response, or the collection variable after running) in a browser and pay with a test card:
\n4111 1111 1111 1111 / 12/26 / 123 — Visa, success\n4111 1111 1111 1112 / 12/26 / 123 — Visa, hard decline\n5123 4567 8901 2346 / 12/25 / 123 — Mastercard, success\n5078 0362 3198 5581 / 05/25 / 632 — Meeza, success
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"7ff6414d-f6f1-4d0c-9fc9-66841d4d7300","id":"7ff6414d-f6f1-4d0c-9fc9-66841d4d7300","name":"HealthPay PG Merchant API","type":"collection"}},"urlObject":{"path":["api","v1","orders","","checkout-url"],"host":["https://dashboard.healthpay.com.eg"],"query":[],"variable":[]}},"response":[],"_postman_id":"33f44552-df01-4080-8a73-07aa48dfe747"}],"id":"e1c2e2ca-adb1-4310-98fd-24998dc9156a","_postman_id":"e1c2e2ca-adb1-4310-98fd-24998dc9156a","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"7ff6414d-f6f1-4d0c-9fc9-66841d4d7300","id":"7ff6414d-f6f1-4d0c-9fc9-66841d4d7300","name":"HealthPay PG Merchant API","type":"collection"}}},{"name":"3. Refunds (pg-lrvl)","item":[{"name":"List refund requests","id":"266f6667-bd02-47d2-8194-1eda20abe58e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://dashboard.healthpay.com.eg/api/v1/refunds","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"7ff6414d-f6f1-4d0c-9fc9-66841d4d7300","id":"7ff6414d-f6f1-4d0c-9fc9-66841d4d7300","name":"HealthPay PG Merchant API","type":"collection"}},"urlObject":{"path":["api","v1","refunds"],"host":["https://dashboard.healthpay.com.eg"],"query":[],"variable":[]}},"response":[],"_postman_id":"266f6667-bd02-47d2-8194-1eda20abe58e"},{"name":"Request a refund","event":[{"listen":"test","script":{"exec":["const json = pm.response.json();","if (json.id) { pm.collectionVariables.set('refund_id', json.id); }"],"type":"text/javascript","id":"e395815a-af78-44b2-9a17-f901080b0a01"}}],"id":"486849a1-afad-4b0e-9fb5-96b9a7357a09","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"order_uuid\": \"\",\n \"reason\": \"Testing refund flow\"\n}"},"url":"https://dashboard.healthpay.com.eg/api/v1/refunds","description":"Only works on a settled (paid) order — pay via the checkout URL first. Omit \"amount\" for a full refund. Queues for admin review; approve it from Admin → Refunds → Refund Requests.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"7ff6414d-f6f1-4d0c-9fc9-66841d4d7300","id":"7ff6414d-f6f1-4d0c-9fc9-66841d4d7300","name":"HealthPay PG Merchant API","type":"collection"}},"urlObject":{"path":["api","v1","refunds"],"host":["https://dashboard.healthpay.com.eg"],"query":[],"variable":[]}},"response":[],"_postman_id":"486849a1-afad-4b0e-9fb5-96b9a7357a09"},{"name":"Look up a refund","id":"46abdbc4-bbd5-41f1-89fa-ead4726ad7ae","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://dashboard.healthpay.com.eg/api/v1/refunds/","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"7ff6414d-f6f1-4d0c-9fc9-66841d4d7300","id":"7ff6414d-f6f1-4d0c-9fc9-66841d4d7300","name":"HealthPay PG Merchant API","type":"collection"}},"urlObject":{"path":["api","v1","refunds",""],"host":["https://dashboard.healthpay.com.eg"],"query":[],"variable":[]}},"response":[],"_postman_id":"46abdbc4-bbd5-41f1-89fa-ead4726ad7ae"}],"id":"e68bb464-344f-4fec-83ac-02d3f3815cad","_postman_id":"e68bb464-344f-4fec-83ac-02d3f3815cad","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"7ff6414d-f6f1-4d0c-9fc9-66841d4d7300","id":"7ff6414d-f6f1-4d0c-9fc9-66841d4d7300","name":"HealthPay PG Merchant API","type":"collection"}}},{"name":"4. Invoices (pg-lrvl)","item":[{"name":"List invoices","id":"1fce7f4f-77c8-4dfa-bc2a-1c4048115b10","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://dashboard.healthpay.com.eg/api/v1/invoices","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"7ff6414d-f6f1-4d0c-9fc9-66841d4d7300","id":"7ff6414d-f6f1-4d0c-9fc9-66841d4d7300","name":"HealthPay PG Merchant API","type":"collection"}},"urlObject":{"path":["api","v1","invoices"],"host":["https://dashboard.healthpay.com.eg"],"query":[],"variable":[]}},"response":[],"_postman_id":"1fce7f4f-77c8-4dfa-bc2a-1c4048115b10"},{"name":"Create a draft invoice","event":[{"listen":"test","script":{"exec":["const json = pm.response.json();","if (json.uuid) { pm.collectionVariables.set('invoice_uuid', json.uuid); }"],"type":"text/javascript","id":"b5cbcf8c-88b2-4848-9d48-7e4a794da2aa"}}],"id":"a53b0b1f-ae57-4042-8a2d-d7d2cce87dda","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"customer_name\": \"Test Customer\",\n \"customer_email\": \"test@example.com\",\n \"currency\": \"EGP\",\n \"due_date\": \"2026-10-01\",\n \"items\": [\n { \"description\": \"Consultation\", \"quantity\": 1, \"unit_price\": 500 }\n ]\n}"},"url":"https://dashboard.healthpay.com.eg/api/v1/invoices","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"7ff6414d-f6f1-4d0c-9fc9-66841d4d7300","id":"7ff6414d-f6f1-4d0c-9fc9-66841d4d7300","name":"HealthPay PG Merchant API","type":"collection"}},"urlObject":{"path":["api","v1","invoices"],"host":["https://dashboard.healthpay.com.eg"],"query":[],"variable":[]}},"response":[],"_postman_id":"a53b0b1f-ae57-4042-8a2d-d7d2cce87dda"},{"name":"Look up an invoice","id":"367159aa-b018-48ba-a373-e8e62632e6e0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://dashboard.healthpay.com.eg/api/v1/invoices/","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"7ff6414d-f6f1-4d0c-9fc9-66841d4d7300","id":"7ff6414d-f6f1-4d0c-9fc9-66841d4d7300","name":"HealthPay PG Merchant API","type":"collection"}},"urlObject":{"path":["api","v1","invoices",""],"host":["https://dashboard.healthpay.com.eg"],"query":[],"variable":[]}},"response":[],"_postman_id":"367159aa-b018-48ba-a373-e8e62632e6e0"},{"name":"Send invoice (makes it payable)","id":"9b5effd9-affe-40cd-846c-1c8f5050d9ad","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://dashboard.healthpay.com.eg/api/v1/invoices//send","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"7ff6414d-f6f1-4d0c-9fc9-66841d4d7300","id":"7ff6414d-f6f1-4d0c-9fc9-66841d4d7300","name":"HealthPay PG Merchant API","type":"collection"}},"urlObject":{"path":["api","v1","invoices","","send"],"host":["https://dashboard.healthpay.com.eg"],"query":[],"variable":[]}},"response":[],"_postman_id":"9b5effd9-affe-40cd-846c-1c8f5050d9ad"},{"name":"Download invoice PDF","id":"1a995e46-c384-48a8-8967-22e977fb6ebe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://dashboard.healthpay.com.eg/api/v1/invoices//pdf","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"7ff6414d-f6f1-4d0c-9fc9-66841d4d7300","id":"7ff6414d-f6f1-4d0c-9fc9-66841d4d7300","name":"HealthPay PG Merchant API","type":"collection"}},"urlObject":{"path":["api","v1","invoices","","pdf"],"host":["https://dashboard.healthpay.com.eg"],"query":[],"variable":[]}},"response":[],"_postman_id":"1a995e46-c384-48a8-8967-22e977fb6ebe"},{"name":"Void invoice","id":"27a82c6a-9bae-413b-9621-6b49e05ba39e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://dashboard.healthpay.com.eg/api/v1/invoices//void","description":"Blocked once the invoice has been paid.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"7ff6414d-f6f1-4d0c-9fc9-66841d4d7300","id":"7ff6414d-f6f1-4d0c-9fc9-66841d4d7300","name":"HealthPay PG Merchant API","type":"collection"}},"urlObject":{"path":["api","v1","invoices","","void"],"host":["https://dashboard.healthpay.com.eg"],"query":[],"variable":[]}},"response":[],"_postman_id":"27a82c6a-9bae-413b-9621-6b49e05ba39e"},{"name":"Delete draft invoice","id":"a28b63a7-5c0b-442d-9927-96435d73a51a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://dashboard.healthpay.com.eg/api/v1/invoices/","description":"Only works on a draft that hasn't been sent yet.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"7ff6414d-f6f1-4d0c-9fc9-66841d4d7300","id":"7ff6414d-f6f1-4d0c-9fc9-66841d4d7300","name":"HealthPay PG Merchant API","type":"collection"}},"urlObject":{"path":["api","v1","invoices",""],"host":["https://dashboard.healthpay.com.eg"],"query":[],"variable":[]}},"response":[],"_postman_id":"a28b63a7-5c0b-442d-9927-96435d73a51a"}],"id":"5aeac13c-dd8f-4778-87d9-12bd0f5f1fce","_postman_id":"5aeac13c-dd8f-4778-87d9-12bd0f5f1fce","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"7ff6414d-f6f1-4d0c-9fc9-66841d4d7300","id":"7ff6414d-f6f1-4d0c-9fc9-66841d4d7300","name":"HealthPay PG Merchant API","type":"collection"}}},{"name":"5. Subscriptions (pg-lrvl)","item":[{"name":"List subscriptions","id":"9ac1c5bc-a882-4c5f-a1c8-9b25adb8f879","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://dashboard.healthpay.com.eg/api/v1/subscriptions","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"7ff6414d-f6f1-4d0c-9fc9-66841d4d7300","id":"7ff6414d-f6f1-4d0c-9fc9-66841d4d7300","name":"HealthPay PG Merchant API","type":"collection"}},"urlObject":{"path":["api","v1","subscriptions"],"host":["https://dashboard.healthpay.com.eg"],"query":[],"variable":[]}},"response":[],"_postman_id":"9ac1c5bc-a882-4c5f-a1c8-9b25adb8f879"},{"name":"Create a subscription","event":[{"listen":"test","script":{"exec":["const json = pm.response.json();","if (json.uuid) { pm.collectionVariables.set('subscription_uuid', json.uuid); }"],"type":"text/javascript","id":"aab122c8-6d2a-4938-919b-3e990ab348af"}}],"id":"f3556d33-bcb9-4838-b6eb-528d91b478a2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"customer_name\": \"Test Customer\",\n \"customer_email\": \"test@example.com\",\n \"currency\": \"EGP\",\n \"interval_unit\": \"month\",\n \"interval_count\": 1,\n \"due_days\": 7,\n \"items\": [\n { \"description\": \"Monthly plan\", \"quantity\": 1, \"unit_price\": 300 }\n ]\n}"},"url":"https://dashboard.healthpay.com.eg/api/v1/subscriptions","description":"Auto-generates and sends a normal invoice every billing cycle — no card is ever charged silently.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"7ff6414d-f6f1-4d0c-9fc9-66841d4d7300","id":"7ff6414d-f6f1-4d0c-9fc9-66841d4d7300","name":"HealthPay PG Merchant API","type":"collection"}},"urlObject":{"path":["api","v1","subscriptions"],"host":["https://dashboard.healthpay.com.eg"],"query":[],"variable":[]}},"response":[],"_postman_id":"f3556d33-bcb9-4838-b6eb-528d91b478a2"},{"name":"Pause subscription","id":"63a9cb55-b6ca-440a-a192-15d4ec6092c5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://dashboard.healthpay.com.eg/api/v1/subscriptions//pause","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"7ff6414d-f6f1-4d0c-9fc9-66841d4d7300","id":"7ff6414d-f6f1-4d0c-9fc9-66841d4d7300","name":"HealthPay PG Merchant API","type":"collection"}},"urlObject":{"path":["api","v1","subscriptions","","pause"],"host":["https://dashboard.healthpay.com.eg"],"query":[],"variable":[]}},"response":[],"_postman_id":"63a9cb55-b6ca-440a-a192-15d4ec6092c5"},{"name":"Resume subscription","id":"9b0a61e9-7531-48a1-977a-2e144d95ddf3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://dashboard.healthpay.com.eg/api/v1/subscriptions//resume","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"7ff6414d-f6f1-4d0c-9fc9-66841d4d7300","id":"7ff6414d-f6f1-4d0c-9fc9-66841d4d7300","name":"HealthPay PG Merchant API","type":"collection"}},"urlObject":{"path":["api","v1","subscriptions","","resume"],"host":["https://dashboard.healthpay.com.eg"],"query":[],"variable":[]}},"response":[],"_postman_id":"9b0a61e9-7531-48a1-977a-2e144d95ddf3"},{"name":"Cancel subscription","id":"ebfc0eca-e4ec-4a93-9223-a95d629f22f6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://dashboard.healthpay.com.eg/api/v1/subscriptions//cancel","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"7ff6414d-f6f1-4d0c-9fc9-66841d4d7300","id":"7ff6414d-f6f1-4d0c-9fc9-66841d4d7300","name":"HealthPay PG Merchant API","type":"collection"}},"urlObject":{"path":["api","v1","subscriptions","","cancel"],"host":["https://dashboard.healthpay.com.eg"],"query":[],"variable":[]}},"response":[],"_postman_id":"ebfc0eca-e4ec-4a93-9223-a95d629f22f6"}],"id":"cc43797d-44e7-4f0e-a450-a188831a1afe","_postman_id":"cc43797d-44e7-4f0e-a450-a188831a1afe","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"7ff6414d-f6f1-4d0c-9fc9-66841d4d7300","id":"7ff6414d-f6f1-4d0c-9fc9-66841d4d7300","name":"HealthPay PG Merchant API","type":"collection"}}},{"name":"6. Balance & Settlements (pg-lrvl, read-only)","item":[{"name":"Current ledger balance","id":"79d01ebc-e678-4f17-9478-0bdd82bbf58a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://dashboard.healthpay.com.eg/api/v1/balance","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"7ff6414d-f6f1-4d0c-9fc9-66841d4d7300","id":"7ff6414d-f6f1-4d0c-9fc9-66841d4d7300","name":"HealthPay PG Merchant API","type":"collection"}},"urlObject":{"path":["api","v1","balance"],"host":["https://dashboard.healthpay.com.eg"],"query":[],"variable":[]}},"response":[],"_postman_id":"79d01ebc-e678-4f17-9478-0bdd82bbf58a"},{"name":"Settlement batch history","id":"417a2af8-d6e9-4b46-9b08-8caa7e41a667","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://dashboard.healthpay.com.eg/api/v1/settlements","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"7ff6414d-f6f1-4d0c-9fc9-66841d4d7300","id":"7ff6414d-f6f1-4d0c-9fc9-66841d4d7300","name":"HealthPay PG Merchant API","type":"collection"}},"urlObject":{"path":["api","v1","settlements"],"host":["https://dashboard.healthpay.com.eg"],"query":[],"variable":[]}},"response":[],"_postman_id":"417a2af8-d6e9-4b46-9b08-8caa7e41a667"}],"id":"192e34e6-19c0-4d9e-b7ec-33be206b4170","_postman_id":"192e34e6-19c0-4d9e-b7ec-33be206b4170","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"7ff6414d-f6f1-4d0c-9fc9-66841d4d7300","id":"7ff6414d-f6f1-4d0c-9fc9-66841d4d7300","name":"HealthPay PG Merchant API","type":"collection"}}},{"name":"7. Card Sessions (gateway-pg)","item":[{"name":"Create card-iframe session","event":[{"listen":"test","script":{"exec":["const json = pm.response.json();","if (json.token) { pm.collectionVariables.set('card_session_token', json.token); }","pm.test('got a token', function () {"," pm.expect(pm.response.code).to.equal(201);"," pm.expect(json.token).to.be.a('string');","});"],"type":"text/javascript","id":"b8d69064-161a-4d00-9471-b49061e7bf03"}}],"id":"b3097489-f9d8-43ba-970a-dd690035fd95","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"origin\": \"https://your-store.example.com\"\n}"},"url":"https://gateway.pg.healthpay.com.eg/v1/card-sessions","description":"origin must be the exact https:// origin (scheme + host, no path) you'll embed card-iframe on — the token only works there. This request only gets you the token; actually saving a card needs a browser (Postman can't run the iframe / postMessage handshake). Next: open a blank HTML page on that same origin with
\n\n\n(swap in the real token value — Postman variables don't resolve inside a browser) and enter a test card. Listen for window.addEventListener('message', ...) with data.type === 'healthpay.card.tokenized' to get the saved token.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"7ff6414d-f6f1-4d0c-9fc9-66841d4d7300","id":"7ff6414d-f6f1-4d0c-9fc9-66841d4d7300","name":"HealthPay PG Merchant API","type":"collection"}},"urlObject":{"path":["v1","card-sessions"],"host":["https://gateway.pg.healthpay.com.eg"],"query":[],"variable":[]}},"response":[],"_postman_id":"b3097489-f9d8-43ba-970a-dd690035fd95"}],"id":"449366c2-471a-4b1f-9de9-d39c781cb42c","_postman_id":"449366c2-471a-4b1f-9de9-d39c781cb42c","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"7ff6414d-f6f1-4d0c-9fc9-66841d4d7300","id":"7ff6414d-f6f1-4d0c-9fc9-66841d4d7300","name":"HealthPay PG Merchant API","type":"collection"}}}],"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]}},"event":[{"listen":"prerequest","script":{"id":"c96fdb12-0503-4f05-8ea4-392c9ddc46fb","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"2b65a0f8-d281-42cc-80c9-82fa969aecc5","type":"text/javascript","packages":{},"exec":[""]}}],"variable":[{"key":"base_gateway","value":"https://gateway.pg.healthpay.com.eg"},{"key":"base_dashboard","value":"https://dashboard.healthpay.com.eg"},{"key":"api_key","value":""},{"key":"order_uuid","value":""},{"key":"order_id","value":""},{"key":"checkout_url","value":""},{"key":"refund_id","value":""},{"key":"invoice_uuid","value":""},{"key":"subscription_uuid","value":""},{"key":"card_session_origin","value":"https://your-store.example.com"},{"key":"card_session_token","value":""}]}