GuidesAPI Reference
Log In
API Reference

Create Open Banking session

Create a new Open Banking session for bank account linking.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Open Banking session creation request

string
required

Liberis ID for the business

uri

URI to redirect to upon completion of the Open Banking flow. Required for mobile platforms. If not provided on web, users will see a page instructing them to close the browser window.

  • For web platforms: Use standard HTTPS URLs (e.g., https://www.example.com/seller-capital-success)
  • For mobile platforms: Use custom URI schemes (e.g., widgets://liberis-open-banking-complete)
uri

URI to redirect to during the Open Banking flow.

  • For web platforms: Can be null
  • For mobile platforms: Must be a Universal or App Link to allow bank apps to return to your app
boolean
required

Whether the session is for a mobile platform

string
enum

Platform type (optional)

Allowed:
string
required

Name of the business

Responses

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json