Payment-method icon

Benefit for API only

Add Benefit to an existing API-only integration.

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

Before starting your Benefit integration:

  1. Make sure that you have set up your back end implementation.
  2. 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:

The response contains paymentMethod.type: benefit.

Make a payment

From your server, make a /payments request, specifying:

In the /payments response, note the action object. This contains the information needed to redirect the shopper.

Handle the redirect

  1. To complete the payment, redirect the shopper to the action.url returned in the /payments response.

    When using the HTTP GET method:
    For security reasons, when displaying the redirect in the app, we recommend that you use SFSafariViewController for iOS or Chrome Custom Tabs for Android, instead of WebView objects. Also refer to the security best practices for WebView.

  2. 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 redirectResult returned when the shopper was redirected back to your site.
  3. In the response note the following:

    • resultCode: use this to present the result to your shopper.
    • pspReference: our unique identifier for the transaction.

Present the payment result

Use the  resultCode that you received in the /payments/details response to present the payment result to your shopper.

The 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 refusalReason, indicating the cause of the error.
Pending or
Received
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.

If the shopper closed the browser and failed to return to your website, wait for webhooks to know the outcome of the payment. The webhooks you can receive for Benefit are:

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.

See also