API Guide
Log In
API Guide

Connect

Calling Connect with a valid organisation ID will return a response containing a url for you to redirect the user
to the UI to manage their payment sources.

You must provide a returnUrl query parameter which will be used
to redirect the user back to your system on completion of the flow.

Calling Connect with a valid organisation ID will return a response containing a url for you to redirect the user to the UI to manage their payment sources. Depending on the organisation's configuration this is either a page where they can manage and connect any of their payment sources (bank accounts and cards), or a direct entry into the bank account connection flow.

You must provide a returnUrl query parameter which will be used to redirect the user back to your system on completion of the flow.

Path Params
uuid
required

The unique Crezco ID for an organisation

Query Params
string

The URL that we should redirect the user back to after connection is completed

Headers
string
Defaults to 2025-01-31

The requested API version

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

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