Benefit Payment Gateway (PG)
Last updated: June 12, 2024
Benefit Payment Gateway (PG) enables customers to perform secure online payments in Bahrain.
Information
To enable Benefit PG payments on your account, contact your Account Manager or [email protected].
Model | Gateway |
---|---|
Payment flow | Redirect |
Payment method type | Payment Gateway |
One-step payment | |
Authorization | |
Capture | |
Refund | |
Partial refund | |
Chargeback | |
Recurring payment |
Supported countries |
|
---|---|
Supported processing and settlement currencies |
|
Benefit Payment Gateway (PG) is a solution that enables merchants to process transactions through debit cards. Payments can be processed via websites or mobile applications.
To use Benefit PG, merchants must register via one of Benefit’s supported acquirers.
Use the details below to set up your request. To get a detailed view of all required and optional fields, see our API reference.
post
https://api.checkout.com/payments
1{2"source": {3"type": "benefit"4},5"reference": 368,6"currency": "BHD",7"amount": 1000,8"processing_channel_id": "pc_ekaubqrravqupfxde7kxvd2t3i",9"success_url": "https://example.com/payments/success",10"failure_url": "https://example.com/payments/failure"11}
If you receive a 202
response with status Pending
, Benefit PG has accepted your transaction request.
1{2"id": "pay_qexughhq5l2unjpevzxovl5ksu",3"status": "Pending",4"reference": "368",5"_links": {6"self": {7"href": "https://api.checkout.com/payments/pay_qexughhq5l2unjpevzxovl5ksu"8},9"redirect": {10"href": "https://www.test.benefit-gateway.bh/payment/paymentpage.htm?PaymentID=145202215328911475"11}12}13}
To learn about payment status, you can set up webhooks to receive notifications.
You may receive the following webhooks when using Benefit PG:
Webhook | Description |
---|---|
| Sent when a merchant initiates a payment request. |
| Sent when a payment request has been successfully initiated and the payment capture is pending. |
| Sent when a payment has been successfully captured. |
| Sent when a payment has failed or has been canceled. |
| Sent when a payment has been (fully or partially) refunded. |
You can use the id
found in the payment response to retrieve details about an existing Benefit PG payment.
get
https://api.checkout.com/payments/{id}
1{2"id": "pay_qexughhq5l2unjpevzxovl5ksu",3"requested_on": "2022-06-02T08:17:02.0430752Z",4"source": {5"type": "benefit"6},7"amount": 1000,8"currency": "BHD",9"payment_type": "Regular",10"reference": "368",11"status": "Pending",12"_links": {13"redirect": {14"href": "https://www.test.benefit-gateway.bh/payment/paymentpage.htm?PaymentID=145202215328911475"15},16"self": {17"href": "https://api.checkout.com/payments/pay_qexughhq5l2unjpevzxovl5ksu"18},19"actions": {20"href": "https://api.checkout.com/payments/pay_qexughhq5l2unjpevzxovl5ksu/actions"21}22}23}
Benefit PG supports full, partial and multiple partial refunds. Note that you need to request partial refund enablement from Benefit when you sign up with them.
You can process a refund through the Dashboard or using the Refund API.
Disputes and chargebacks can be raised through the buyer's bank or through your acquiring company.
post
https://api.checkout.com/payments/{id}/refunds
1{2"action_id": "act_mg6cqtudpuzund46uee3yrkvrm",3"_links": {4"payment": {5"href": "https://api.checkout.com/payments/pay_soaizebivsxubh2pvdpsiaop6q"6}7}8}
To start testing, you'll need to:
- Register via Benefit’s supported acquirer.
- Contact your Account Manager to activate Benefit PG payments in the sandbox environment.
- Create a Benefit PG payment transaction.
- Check the transaction response in the sandbox environment.
- Complete the payment transaction and check the result status.
You can use the following Benefit test cards to test a transaction
Card number | Response code | Status |
---|---|---|
| 00 | Approved |
| 05 | Contact the issuer |
| 51 | Insufficient funds |
| 54 | Expired card |
| 55 | Invalid pin |
| 61 | Limit exceeded |
| 78 | Refer to issuer |