QPay via Checkout.com

Accept QPay payments with Checkout.com as the payment service provider (PSP).

Supported workflows

Before you begin

Complete these steps before you send your first QPay payment through Checkout.com:

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

Request fields for Checkout.com

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.shopperInput.nationalId`	Required	The customer’s Qatari national ID.
`meta.order.description`	Required	Sent to Checkout.com as the payment description and as the QPay description.
`meta.order.lines`	Optional	Payrails sends line items that have a `unitPrice` and a `quantity` to Checkout.com as order items.
`meta.customer.name`, `meta.customer.lastName`	Optional	Sent to Checkout.com as the customer name.
`meta.customer.email`	Optional	Sent to Checkout.com as the customer email.

Authorize a QPay payment

Call authorize a payment with qpay as the paymentMethodCode. The response includes the redirect to the QPay page.

Authorize request

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

After the customer confirms the payment, QPay returns them to your success or error URL. Confirm the result through webhook notifications or the execution status before you fulfill the order.

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.
Each QPay payment is a new customer-initiated payment.

Getting Started

Payment Orchestration

Token Vault

Analytics & Reporting

Fraud Management

Chargebacks

Monitoring

Resources

Use Cases

Supported workflows

Before you begin

Request fields for Checkout.com

Authorize a QPay payment

How Checkout.com handles QPay

​Supported workflows

​Before you begin

​Request fields for Checkout.com

​Authorize a QPay payment

​How Checkout.com handles QPay

Supported workflows

Before you begin

Request fields for Checkout.com

Authorize a QPay payment

How Checkout.com handles QPay