Accept Benefit payments using our APIs, and build your own payment form to have full control over the look and feel of your checkout page.
Before you begin
These instructions explain how to add Benefit to your existing API-only integration. The API-only integration works the same way for all payment methods. If you haven't done this integration yet, refer to our API-only integration guide.
Before starting your Benefit integration:
- Make sure that you have set up your back end implementation.
- Add Benefit in your test Customer Area.
Build your payment form for Benefit
Include Benefit in the list of available payment methods. You don't need to collect any information from the shopper in your payment form.
We provide logos for Benefit which you can use on your payment form. For more information, refer to Downloading logos.
If you are using the /paymentMethods endpoint to show available payment methods to the shopper, specify the following:
- countryCode: BH
- amount.currency: BHD
- amount.value: The value of the payment.
- channel: Specify Web, iOS, or Android.
The response contains
Make a payment
From your server, make a /payments request, specifying:
- shopperName: The shopper's full name.
- shopperEmail: The shopper's email address.
- telephoneNumber: The shopper's telephone number.
The /payments response contains an
action object with the information needed to redirect the shopper.
Handle the redirect
- To complete the payment, redirect the shopper to the
action.urlreturned in the /payments response.
After the shopper is redirected back to your website, check the payment result by making a POST /payments/details request, specifying:
details: Object that contains the URL-decoded
redirectResultreturned when the shopper was redirected back to your site.
You receive a response containing:
resultCode: Use this to present the result to your shopper.
pspReference: Our unique identifier for the transaction.
Present the payment result
resultCode values you can receive for Benefit are:
|resultCode||Description||Action to take|
|Authorised||The payment was successful.||Inform the shopper that the payment has been successful.|
|Cancelled||The shopper cancelled the payment while on Benefit's website.||Ask the shopper whether they want to continue with the order, or ask them to select a different payment method.|
|Error||There was an error when the payment was being processed.||Inform the shopper that there was an error processing their payment. The response contains a
|The shopper has completed the payment but the final result is not yet known.||Inform the shopper that you've received their order, and are waiting for the payment to be completed.
To know the final result of the payment, wait for the AUTHORISATION webhook.
|Refused||The payment was refused by the Benefit.||Ask the shopper to try the payment again using a different payment method.|
|eventCode||success field||Description||Action to take|
|AUTHORISATION||false||The transaction failed.||Cancel the order and inform the shopper that the payment failed.|
|AUTHORISATION||true||The shopper successfully completed the payment.||Inform the shopper that the payment has been successful and proceed with the order.|
|OFFER_CLOSED||true||The shopper did not complete the payment.||Cancel the order and inform the shopper that the payment timed out.|
Test and go live
To test Benefit payments, use the test card details provided by Tap.
Before you can accept live Benefit payments, you need to submit a request for Benefit in your live Customer Area.