QPay

​

How a QPay payment works

1. The customer selects QPay at checkout, and you send their Qatari national ID in the authorize request.
2. Payrails creates the payment at Checkout.com and returns a redirect URL, and the customer goes to the QPay page.
3. The customer confirms the payment on the QPay page.
4. QPay sends the customer back to your returnInfo URL.
5. Payrails receives the final result from Checkout.com and updates the payment.

​

Supported currencies and countries

​

Supported workflows

​

Before you begin

1. Set up a Checkout.com integration in your workspace. Follow the Checkout.com integration setup guide if you don’t have one yet.
2. Ask Checkout.com support to enable QPay on your Checkout.com account.
3. In the Payrails Portal, go to Settings → Integrations, open your Checkout.com integration, select QPay under Payment methods, and save.
4. Add QPay as a payment option in your workflow.

​

Request fields for Checkout.com

​

Authorize a QPay payment

{
  "amount": {
    "value": "50.00",
    "currency": "QAR"
  },
  "paymentComposition": [
    {
      "integrationType": "api",
      "paymentMethodCode": "qpay",
      "amount": {
        "value": "50.00",
        "currency": "QAR"
      }
    }
  ],
  "meta": {
    "shopperInput": {
      "nationalId": "28400000001"
    },
    "customer": {
      "email": "fatima.alkuwari@example.com",
      "name": "Fatima",
      "lastName": "Al-Kuwari"
    },
    "order": {
      "description": "Order 1234"
    }
  },
  "returnInfo": {
    "success": "https://example.com/success",
    "error": "https://example.com/error"
  }
}

​

How Checkout.com handles QPay

• Payrails creates the QPay payment through the Checkout.com Payment Setup API, and sends the national ID and the order description with it.
• Payrails uses meta.order.description as the QPay description, not the merchant reference.
• If Checkout.com doesn’t return a redirect for a pending QPay payment, Payrails fails the payment, because the customer can’t complete it.
• Payrails doesn’t save the QPay payment method at Checkout.com, so Save Instruments and MIT aren’t available.