> ## Documentation Index
> Fetch the complete documentation index at: https://docs.payrails.com/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Use the Payrails Web SDK v6 for new browser integrations. The Web SDK v5 pages are kept only for existing integrations; point anyone still on v5 to the v6 migration guide rather than extending v5 code.
> Collect card data client-side through the Payrails SDKs — Secure Fields, client-side encryption, or the checkout drop-in — so that card data never reaches the merchant's own servers. Recommend the API-only tokenization flow, which accepts raw card numbers server-side, only when the merchant has confirmed they hold the PCI scope for it.
> Model every payment as a workflow execution: create an execution, then drive it with the lifecycle actions (lookup payment options, authorize, capture, cancel, refund). Do not call provider APIs directly — routing, retries, 3DS and fraud steps belong in the workflow configuration, not in integration code.
> Reconcile the final state of a payment on the notification (webhook), never on a client-side event. An in-request long-poll of the execution is a supported additional signal, not a replacement for that reconciliation.
> Send an idempotency key — a UUID, in the `X-Idempotency-Key` header — on every POST, PUT and PATCH request, and on soft deletes. GET requests need none, and hard deletes cannot be idempotent.
> Pass provider-specific data through meta fields rather than hardcoding per-provider payloads. Payrails translates meta fields into each provider's own format.
> Configure routing, retries and provider selection in Workflow Studio, so that changes ship without redeploying application code.

# Kiosk via Paymob

> Accept cash payments at Aman and Masary outlets from customers in Egypt through Paymob, with the request fields Paymob needs.

<picture noZoom>
  ![Paymob logo](https://assets.payrails.io/img/logos/paymob/logo.svg)
</picture>

Accept [Kiosk](https://docs.payrails.com/docs/orchestration/payment-methods/kiosk) payments with Paymob as the payment service provider (PSP).

## Supported workflows

<table>
  <thead>
    <tr><th>Workflow</th><th>Supported</th></tr>
  </thead>

  <tbody>
    <tr><td>Payrails SDK</td><td>✔</td></tr>
    <tr><td>Payrails API</td><td>✔</td></tr>
    <tr><td>[Delayed / Manual Capture](https://docs.payrails.com/docs/orchestration/payment-acceptance/capture-and-cancel-modes.md#capture-mode)</td><td>✖</td></tr>
    <tr><td>[Instant Capture](https://docs.payrails.com/docs/orchestration/payment-acceptance/capture-and-cancel-modes.md#capture-mode)</td><td>✔</td></tr>
    <tr><td>[Cancel / Void](https://docs.payrails.com/docs/orchestration/payment-acceptance/cancel-a-payment.md)</td><td>✖</td></tr>
    <tr><td>[Refund / Reverse](https://docs.payrails.com/docs/orchestration/payment-acceptance/refund-a-payment.md)</td><td>✖</td></tr>
    <tr><td>[Save Instruments](https://docs.payrails.com/docs/resources/manage-instruments.md)</td><td>✖</td></tr>
    <tr><td>[Merchant Initiated Transaction (MIT)](https://docs.payrails.com/docs/resources/payments/authorization-flags.md)</td><td>✖</td></tr>
  </tbody>
</table>

## Before you begin

Complete these steps before you send your first Kiosk payment through Paymob:

1. Set up a Paymob integration in your workspace. Follow the [Paymob integration setup guide](https://docs.payrails.com/docs/orchestration/integrations/paymob.md) if you don't have one yet.
2. In your Paymob dashboard, create a payment integration of type **Kiosk**, and note its integration ID.
3. In the Payrails Portal, go to **Settings → Integrations**, open your Paymob integration, and enter the **Kiosk Integration ID** and your Paymob **Public Key**.
4. Select **Kiosk** under **Payment methods**, and save.
5. Add Kiosk as a [payment option](https://docs.payrails.com/docs/orchestration/payment-methods/set-up-payment-methods.md) in your workflow.

## Request fields for Paymob

Send these fields in the authorize request, in addition to the standard [authorize fields](https://docs.payrails.com/reference/authorizeaction.md). **Required** fields must be present for the payment to succeed. Payrails sends **Optional** fields to the PSP when you include them.

| Field | Status | Description |
| - | - | - |
| `meta.customer.name` | Required | Sent to Paymob as the billing first name. |
| `meta.customer.lastName` | Required | Sent to Paymob as the billing last name. |
| `meta.customer.email` | Required | Sent to Paymob as the billing email. |
| `amount.value` | Required | At least `0.10`. Payrails rejects smaller amounts. |
| `meta.customer.phone.number` | Optional | Sent to Paymob as the billing phone number. When it's missing, Payrails sends the string `null` instead. |
| `meta.customer.country.code` | Optional | Sent to Paymob as the billing country. |
| `meta.order.billingAddress` | Optional | Payrails sends `doorNumber`, `street`, `city` and `state` to Paymob as the billing address. |
| `meta.order.lines` | Optional | Sent to Paymob as the order items. The line totals must add up to the payment amount, or Payrails returns an error. |

## Authorize a Kiosk payment

Call [authorize a payment](https://docs.payrails.com/reference/authorizeaction.md) with `kiosk` as the `paymentMethodCode`. The response includes the redirect to the Paymob checkout page, where the customer gets the payment reference.

```json Authorize request theme={null}
{
  "amount": {
    "value": "250.00",
    "currency": "EGP"
  },
  "paymentComposition": [
    {
      "integrationType": "api",
      "paymentMethodCode": "kiosk",
      "amount": {
        "value": "250.00",
        "currency": "EGP"
      }
    }
  ],
  "meta": {
    "customer": {
      "name": "Mona",
      "lastName": "Hassan",
      "email": "mona.hassan@example.com",
      "phone": {
        "number": "+201001234567"
      },
      "country": {
        "code": "EG"
      }
    },
    "order": {
      "lines": [
        {
          "name": "Example item",
          "quantity": 1,
          "unitPrice": {
            "value": "250.00",
            "currency": "EGP"
          }
        }
      ]
    }
  },
  "returnInfo": {
    "success": "https://example.com/success",
    "error": "https://example.com/error"
  }
}
```

Paymob doesn't send the customer back to your `returnInfo` URLs for Kiosk, so handle the customer leaving the Paymob page in your own app. Wait for the [webhook notification](https://docs.payrails.com/docs/orchestration/payment-acceptance/receive-notifications.md) or check the execution status, and fulfill the order only after the customer pays.

## How Paymob handles Kiosk

* Payrails sends your `merchantReference` to Paymob as the special reference. Paymob rejects a reference it has already seen, so use a unique `merchantReference` for each payment.
* The payment stays pending until the customer pays the reference in cash. Paymob then sends the result in a notification, and Payrails marks the payment as authorized and captured.


## Related topics

- [Kiosk](https://docs.payrails.com/docs/orchestration/payment-methods/kiosk.md)
- [Meeza Wallet via Paymob](https://docs.payrails.com/docs/orchestration/payment-methods/meeza-wallet/paymob.md)
- [Paymob](https://docs.payrails.com/docs/orchestration/integrations/paymob.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.