Kiosk via Paymob

Accept Kiosk payments with Paymob as the payment service provider (PSP).

Supported workflows

Workflow	Supported
Payrails SDK	✔
Payrails API	✔
Delayed / Manual Capture	✖
Instant Capture	✔
Cancel / Void	✖
Refund / Reverse	✖
Save Instruments	✖
Merchant Initiated Transaction (MIT)	✖

Before you begin

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

Set up a Paymob integration in your workspace. Follow the Paymob integration setup guide if you don’t have one yet.
In your Paymob dashboard, create a payment integration of type Kiosk, and note its integration ID.
In the Payrails Portal, go to Settings → Integrations, open your Paymob integration, and enter the Kiosk Integration ID and your Paymob Public Key.
Select Kiosk under Payment methods, and save.
Add Kiosk as a payment option in your workflow.

Request fields for Paymob

Send these fields in the authorize request, in addition to the standard authorize fields. 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 with kiosk as the paymentMethodCode. The response includes the redirect to the Paymob checkout page, where the customer gets the payment reference.

Authorize request

{
  "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 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.

Getting Started

Payment Orchestration

Token Vault

Analytics & Reporting

Fraud Management

Chargebacks

Monitoring

Resources

Use Cases

Supported workflows

Before you begin

Request fields for Paymob

Authorize a Kiosk payment

How Paymob handles Kiosk

​Supported workflows

​Before you begin

​Request fields for Paymob

​Authorize a Kiosk payment

​How Paymob handles Kiosk

Supported workflows

Before you begin

Request fields for Paymob

Authorize a Kiosk payment

How Paymob handles Kiosk