Client-Side Implementation

iOS v6

• Current Braintree SDKs
• Android v5
• iOS v6
• JavaScript v3
• Previous Versions
• Android v4
• iOS v5
• JavaScript v2

Setup

Determine which merchant account to use

This will determine which PayPal credentials are used for the transaction, and must match the merchant account specified with any other calls in the transaction lifecycle (e.g. Transaction.sale). Many merchants use a separate merchant account for local payments. Other merchants use separate merchant accounts for transactions in different currencies. It is not possible to switch merchant accounts between the start and finish of a local payment transaction, so it is important to determine the correct one from the start.

Get the SDK

CocoaPods

Include Braintree/LocalPayment in your podfile:

pod 'Braintree/LocalPayment'

Swift Package Manager

Include the BraintreeLocalPayment and BraintreeDataCollector frameworks.

Carthage

Include the BraintreeCore, BraintreeLocalPayment, BraintreeDataCollector, and PPRiskMagnes frameworks.

Invoke payment flow

You can implement a custom UI, such as your own iDEAL button.

The following is a list of valid paymentType, countryCodeAlpha2, and currencyCode values for each Local Payment Method:

The paymentTypeCountryCode parameter is only required for payment methods with multiple potential country codes. If a paymentTypeCountryCode is not provided, then the countryCode value will be used as the paymentTypeCountryCode.

The following is a list of required parameters for each Local Payment Method, as well as any applicable transaction limits:

Initialize a BTLocalPaymentClient and then call startPaymentFlow(). This will launch an ASWebAuthenticationSession:

var client: BTAPIClient!
var localPaymentClient: BTLocalPaymentClient!

override func viewDidLoad() {
    super.viewDidLoad()

    self.client = BTAPIClient(authorization: "<#CLIENT_AUTHORIZATION#>")

    let idealButton = UIButton(frame: CGRect(x: 0, y: 0, width: 60, height: 120))
    idealButton.addTarget(self, action: #selector(idealButtonTapped(button:)), for: UIControlEvents.touchUpInside)
    self.view.addSubview(idealButton)
}

func idealButtonTapped(button: UIButton) {
    self.localPaymentClient = BTLocalPaymentClient(apiClient: self.client)

    let request = BTLocalPaymentRequest()
    request.paymentType = "ideal"
    request.currencyCode = "EUR"
    request.amount = "1.01"
    request.givenName = "Jon"
    request.surname = "Doe"
    request.phone = "639847934"
    request.address = BTPostalAddress()
    request.address.countryCodeAlpha2 = "NL"
    request.address.postalCode = "2585 GJ"
    request.address.streetAddress = "836486 of 22321 Park Lake"
    request.address.locality = "Den Haag"
    request.email = "lingo-buyer@paypal.com"
    request.shippingAddressRequired = false
    request.localPaymentFlowDelegate = self

    localPaymentClient.startPaymentFlow(localPaymentRequest) { (result, error) in
        ...
    }
}

func localPaymentStarted(_ request: BTLocalPaymentRequest, paymentID: String, start: @escaping () -> Void) {
    // Do preprocessing if necessary before calling start()
    start()
}

Shipping addresses

If you need a shipping address to ship physical goods, set shippingAddressRequired to true on your BTLocalPaymentRequest. This setting will prompt your customer to provide shipping details. If you have already collected these details from your customer, you can pass the shipping details within BTLocalPaymentRequest to avoid having your customer provide them again.

If you are not shipping physical goods, then use the default value of false for shippingAddressRequired. This setting will prompt your customer to provide just the basic information like givenName, surname, phone, and email. If you have already collected these details from your customer, you can pass them on BTLocalPaymentRequest to avoid having your customer provide them again.