# Benefit Payment Gateway for Payment Setup API

To accept Benefit Payment Gateway (PG) payments, you must:

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

---

## 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": "BHD",
  "reference": "ORD-5023-4E89",
  "processing_channel_id": "pc_wzjki6hw5puepb5fnvqlizj2e4",
  "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 values: `BHD`, `AED` <br><br>**Required** |
| `processing_channel_id`<br>`string` | The [processing channel's](https://www.checkout.com/docs/business-operations/use-the-dashboard/manage-processing-channels.md) unique identifier. <br><br>**Required** |
| `reference`<br>`string` | A unique reference for the payment. Must be a unique alphanumeric value. <br><br>Max length: 80 <br><br>**Required** |
| `settings`<br>`object` | Settings for the payment. <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 after a successful payment. <br><br>Format: URI <br><br>Max length: 1024 <br><br>**Required** |
| `description`<br>`string` | A description of the payment. <br><br>Max length: 100 |

### Response example

```json
{
  "id": "set_rcmepwrchqab2wsergcafvijfy",
  "processing_channel_id": "pc_wzjki6hw5puepb5fnvqlizj2e4",
  "amount": 1000,
  "currency": "BHD",
  "payment_type": "Regular",
  "reference": "ORD-5023-4E89",
  "description": "Benefit Payment Gateway payment",
  "payment_methods": {
    "benefit": {
      "status": "ready",
      "flags": []
    }
  },
  "available_payment_methods": [
    "benefit"
  ],
  "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.

Providing all required fields sets the `payment_methods.benefit` object to 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.
- `benefit` as the `{payment_method_name}` path parameter.

### Request example

**Production**

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

**Sandbox**

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

### Response example

```json
{
  "id": "pay_qexughhq5l2unjpevzxovl5ksu",
  "status": "Pending",
  "reference": "ORD-5023-4E89",
  "_links": {
    "self": {
      "href": "https://{prefix}.api.checkout.com/payments/pay_qexughhq5l2unjpevzxovl5ksu"
    },
    "redirect": {
      "href": "https://www.benefit-gateway.bh/payment/paymentpage.htm?PaymentID=145202215328911475"
    }
  }
}
```

---

## Redirect the customer

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