Our Android Drop-in renders Benefit in your payment form, and redirects the shopper to the Benefit app or website where they can complete the payment.
Before you begin
This page explains how to add Benefit to your existing Android Drop-in integration. The Android Drop-in integration works the same way for all payment methods. If you haven't done this integration yet, refer to our Drop-in integration guide.
Before starting your Benefit integration:
Show Benefit in your payment form
Drop-in uses the
countryCode and the
amount.currency from your /paymentMethods request to show the available payment methods to your shopper.
To show Benefit in your payment form, specify in your /paymentMethods request:
Make a payment
When the shopper proceeds to pay, Drop-in returns the
paymentComponentData.paymentMethodto your server.
From your server, make a /payments request, specifying:
paymentComponentData.paymentMethodfrom your client app.
- shopperName: The shopper's full name.
- shopperEmail: The shopper's email address.
- telephoneNumber: The shopper's telephone number.
returnUrl: URL to where the shopper should be redirected back to after they complete the payment. Get this URL from the Component in the
The /payments response contains an
action object with the information needed to redirect the shopper.
If your integration is set up correctly, the
action object is passed from your server to the client.
Check the payment result
Drop-in redirects the shopper to complete the payment. When the shopper returns back to your app, Drop-in provides the
From your server, make a POST /payments/details request providing:
actionComponentData.detailsobject from Drop-in.
You receive a response containing:
resultCode: Use this to present the payment 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.