Overview
Run Pay by Bank inside an Android or iOS app, so customers can authorise a bank payment without leaving it.
The PaySuite Mobile SDK sends the Pay by Bank payment request for you, presents
the provider's bank selection in an in-app sheet and resumes the transaction once
the customer returns. It is part of the same PaymentProcessor you use for cards,
Apple Pay and Google Pay.
How it works
The customer chooses Pay by Bank in your app and the SDK opens the bank selection sheet. They pick their bank and authorise the payment; depending on the bank, that happens in the sheet, in an in-app browser or in the bank's own app.
When the customer is handed back through the returnUrl you supplied, the SDK
resumes the transaction once and reports the outcome through the payment result
callback. If the provider is still processing it, the result is Pending with
the transaction id so you can retrieve the final status. The customer can cancel
the sheet at any time before the bank authorisation completes.
As with the APIs, the payment is PENDING immediately after processing and
moves to SUCCESS once the bank transfer settles. The payment result tells you
whether the authorisation completed; retrieve the transaction by id to learn
when the money moved - see Get the final status.
What you need
- Pay by Bank enabled on your account. It is not enabled by default, so contact us to have it enabled.
- An Advanced Payments
installationIdand a client token, as described in Authentication Token. - The Mobile SDK added to the app, as described in Setup.
- An HTTPS
returnUrlon a domain your app owns, registered as an App Link on Android and a Universal Link on iOS - see Return URL setup. - A billing address whose
countryCodeisGBR. Pay by Bank is only available in supported countries; when the API returns the supported list during initiation, the SDK checks the billing address against it.
What the SDK handles
- Creates the payment request and the resume requests - no Pay by Bank API call is made from your app.
- Shows the bank selection and authorisation flow in its own sheet.
- Hands off to an installed banking app and takes the customer back through your return link.
- Reports the transaction id as soon as the API assigns it, before the payment finishes, so you can track it in flight.
- Reports the payment outcome through the same result callback as cards and wallets.
Getting started
- Pre-Requisites and Setup - shared with cards and wallets.
- Payment Setup - create the processor and register its callbacks.
- Return URL setup - let the bank hand the customer back to your app.
- Take a payment - start a Pay by Bank payment.
- Testing - complete the journey in MITE.
Related documentation
- Pay by Bank overview - how Pay by Bank works and what it shares with Cards & Wallets.
- Your Payment Page - the API requests the SDK makes on your behalf.
- Transaction id callback - receive the transaction id while the payment is in progress.
- Retrieve a transaction - get the final status once the transfer settles.