v1

latestOpenAPI 3.0.12026-07-2428103163.2 KB
Organisations

Connect a payment source

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.

get/organisations/{organisationId}/connect

Path parameters

organisationIdstring uuid required

The unique Crezco ID for an organisation

Query parameters

returnUrlstring

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

Headers

Crezco-Versionstring

The requested API version

Response

OK

urlstring

Url hosted by Crezco that you should redirect the customer to in order for them to connect their payment source