Overview
The Open Banking API allows you to process payments securely and efficiently by redirecting customers to their banking app or portal. Once a payment is initiated, the customer is directed to their bank for authentication and authorization. This method provides a secure and frictionless experience for customers while bypassing traditional card networks.
Features
Transaction Information
To ensure the smooth processing and tracking of open banking payments, the API uses several key identifiers and fields.
Payment Intent: Each open banking transaction must be associated with a payment intent. This unique identifier allows you to track the entire transaction lifecycle from initiation to completion.
Transaction ID: Once a transaction is processed, a transaction ID will be generated. This ID can be used to track the transaction through various states.
Customer Information
It is mandatory to include the customer’s name and email with each transaction. This information helps you identify the transaction, whether it's linked to an invoice or order, or if a refund is needed. If email receipts are enabled, the customer will receive a receipt at the provided email address. The email address may also be used to send payment confirmations if your integration supports it.
Additional information
You can include extra data in a JSON-encoded string called merchant_data. This feature is useful when integrating with third-party systems that require additional fields, such as order details, inventory, or multiple invoice references.
Redirect URL
After submitting the payment request, the API returns a banking server redirect URL in the response. The customer must be redirected to this URL, where they can log into their bank account and authorize the payment. Once the payment is approved, they will be redirected back to a predefined return URL entered in the the intent.
Endpoints
POST openbankings: This endpoint processes an Open Banking payment and returns a URL where the customer can be redirected to complete the transaction.