Benefit Redirect Component

This page explains how to add Benefit to your existing iOS Components integration.

Requirements

Select the server-side flow that your integration uses:

API reference

You do not need to send additional fields for Benefit. To see optional fields that you can send for all payment methods, choose the endpoint you integrated:

• /sessions: This is the default with Components v5.0.0 or later.
• /payments: If you implemented an additional use case.

Component configuration

v5.0.0 or later

If your integration uses iOS Components v5.0.0 or later, configure and create an instance of the Benefit Component:

let paymentMethods = session.sessionContext.paymentMethods
// Check that the payment method is supported before showing the Component.
guard let paymentMethod = paymentMethods.paymentMethod(ofType: .other("benefit")) else { return }
let component = InstantPaymentComponent(paymentMethod: paymentMethod,
                                        context: context,
                                        order: nil)
self.currentComponent = component
// Set the session as the delegate.
component.delegate = session
component.initiatePayment()

v4.x.x

If your integration uses an earlier version of iOS Components:

// Check that the payment method is supported before showing the Component.
guard let paymentMethod = paymentMethods.paymentMethod(ofType: BenefitPaymentMethod.self) else { return }
let style = FormComponentStyle()
let component = BenefitComponent(paymentMethod: paymentMethod,
                                apiContext: context,
                                style: style)
present(component)

There are no configuration steps specific to Benefit required for Components.

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