# QPay for Payment Setup API

To accept QPay payments, you must:

1. Create a payment setup.
2. Confirm the payment.
3. Redirect the customer to QPay.

---

## Create a payment setup

Call the [Create a payment setup](https://api-reference.checkout.com/tag/Payment-Setups/#operation/createAPaymentSetup) endpoint.

> **Information**
>
> Your base URL's `{prefix}` value is unique to your account and environment. To learn how to retrieve your base URLs for the sandbox and production environments, see [API endpoints](https://www.checkout.com/docs/developer-resources/api/api-endpoints.md).

**Production**

`POST` `https://{prefix}.api.checkout.com/payments/setups`

**Sandbox**

`POST` `https://{prefix}.api.sandbox.checkout.com/payments/setups`

### Request example

```json
{
  "amount": 1000,
  "currency": "QAR",
  "description": "QPay payment",
  "payment_methods": {
    "qpay": {
      "national_id": "28765432101",
      "description": "Order ORD-5023-4E89"
    }
  },
  "settings": {
    "success_url": "https://example.com/payments/success",
    "failure_url": "https://example.com/payments/failure"
  }
}
```

In the request body, provide the following:

| Field | Description |
| --- | --- |
| `amount`<br>`number` | The payment amount, in the [minor currency unit](https://www.checkout.com/docs/payments/accept-payments/format-the-amount-value). <br><br>Minimum: 1 <br><br>**Required** |
| `currency`<br>`string` | Three-letter ISO 4217 [currency code](https://www.checkout.com/docs/developer-resources/codes/currency-codes.md). <br><br>Supported value: `QAR` <br><br>**Required** |
| `description`<br>`string` | A description of the payment. <br><br>Max length: 100 <br><br>**Required** |
| `payment_methods.qpay.description`<br>`string` | A description of the payment order. Alphanumeric characters only. <br><br>Max length: 255 <br><br>**Required** |
| `payment_methods.qpay.national_id`<br>`string` | The customer's Qatari national ID. Write-only — not returned in responses. <br><br>Must start with `2` or `3`, followed by 10 digits. <br><br>Pattern: `^(2\|3)\d{10}$` <br><br>**Required** |
| `settings.failure_url`<br>`string` | The URL to redirect the customer to if the payment fails. <br><br>Format: URI <br><br>Max length: 1024 <br><br>**Required** |
| `settings.success_url`<br>`string` | The URL to redirect the customer to if the payment is successful. <br><br>Format: URI <br><br>Max length: 1024 <br><br>**Required** |
| `billing`<br>`object` | The customer's billing details. |
| `billing.address`<br>`object` | The customer's billing address. <br><br>Required if `billing` is provided. |
| `billing.address.address_line1`<br>`string` | The first line of the billing address. <br><br>Required if `billing` is provided. |
| `billing.address.city`<br>`string` | The city of the billing address. <br><br>Required if `billing` is provided. |
| `billing.address.country`<br>`string` | The country of the billing address. <br><br>Required if `billing` is provided. |
| `reference`<br>`string` | A reference you can use to identify the payment. <br><br>Max length: 80 |

### Response example

```json
{
  "id": "set_rcmepwrchqab2wsergcafvijfy",
  "processing_channel_id": "pc_wzjki6hw5puepb5fnvqlizj2e4",
  "amount": 1000,
  "currency": "QAR",
  "payment_type": "Regular",
  "reference": "ORD-5023-4E89",
  "description": "QPay payment",
  "payment_methods": {
    "qpay": {
      "status": "ready",
      "flags": []
    }
  },
  "available_payment_methods": [
    "qpay"
  ],
  "settings": {
    "success_url": "https://example.com/payments/success",
    "failure_url": "https://example.com/payments/failure"
  }
}
```

The response returns a `payment_methods` object, which contains the payment methods enabled on your account.

When all required fields are present, the `payment_methods.qpay` object shows a `ready` [status](https://www.checkout.com/docs/payments/accept-payments/accept-a-payment-using-the-payment-setup-api.md#Payment_method_status).

---

## Confirm the payment

Confirm the payment by calling the [Confirm a payment setup](https://api-reference.checkout.com/tag/Payment-Setups/#operation/confirmAPaymentSetup) endpoint and provide:

- The payment setup `id` as the `{id}` path parameter.
- `qpay` as the `{payment_method_name}` path parameter.

### Request example

**Production**

`POST` `https://{prefix}.api.checkout.com/payments/setups/{id}/confirm/qpay`

**Sandbox**

`POST` `https://{prefix}.api.sandbox.checkout.com/payments/setups/{id}/confirm/qpay`

### Response example

```json
{
  "id": "pay_7eil5osdlcdehe62et5aihec4q",
  "status": "Pending",
  "customer": {
    "id": "cus_mydbq4wrfp3excwlexeefsv3be"
  },
  "_links": {
    "self": {
      "href": "https://{prefix}.api.sandbox.checkout.com/payments/pay_7eil5osdlcdehe62et5aihec4q"
    },
    "redirect": {
      "href": "https://sbapi.ckotech.co/qpay-external/redirect-to-qpay?pun=52h7saoi5edthll6ceec"
    }
  }
}
```

---

## Redirect the customer

Redirect the customer to the `redirect.href` URL from the response. The customer completes the payment on the QPay page and is then redirected back to your `settings.success_url` or `settings.failure_url`.