🛠️ Get API credentials

Sign up for Crezco’s testing environment via the Support Portal.

🧱 Create an organisation

Next ensure you've successfully created an organisation

🔗 Get a link to a hosted connection flow

Call the /connect endpoint with the organisation Id to get a link the hosted connection flow for that organisation.

The response should contain a URL that you should immediately redirect the user to

Example request

GET https://api.partners.uat.crezco.com/organisations/{organisationId}/connect
?returnUrl=https://yourapp.com/bank-return

Example response

{
  "url": "https://your-partner-name.flows.crezco.com/connections/XYZ"
}

🏦 Select the “Crezco Sandbox – GB” bank in the flow

In the hosted flow UI, choose Crezco Sandbox – GB from the list of banks.

Then on the next page scan the QR code on your phone or click to go straight to the banks website. This should redirect you to the test Crezco Sandbox - GB banking website.

Once on the test website, select InstantlyCompleted as the connection option (this will instantly connect the bank account to the organisation).

The simulator will then generate up to two test bank accounts which will be visible when you are redirected back to the hosted flow.

On this final page you should see all the connected bank account for that organisation.

🔁 User returns and you fetch connected bank details

From the final connection page in the hosted flow the user can click to return to your application.

As soon as the bank accounts have been connected, you should be able to get the details of the connected bank to display in your UI or use them to create pay runs. You can fetch the connected bank details by calling the GET /organisations/{organisationId}/bank-accounts endpoint

Example request

GET https://api.partners.uat.crezco.com/organisations/{organisationId}/bank-accounts

Example response

[
	{
        "bankAccountId": "e016bca5-34dc-4a14-9ee4-1a62083d0a6d",
        "organisationId": "30d4dbc2-a4fa-47c6-a4f7-13dd207e6dc1",
        "accountRoutingName": "Crezco Personal - Current Account - GB",
        "institutionCode": "crezco-sandbox-gb",
        "institutionName": "Crezco Sandbox - GB",
        "country": "GB",
        "currencyCode": "GBP",
        "sortCode": "12-34-56",
        "accountNumber": "12345678",
        "lastBalance": "1234.56",
        "lastBalanceUpdated": "2025-07-16T02:56:19.338Z",
        "status": "Disconnected",
        "singlePaymentConstraints": {
            "allowImmediatePayment": true,
            "allowScheduledPayment": true,
            "minDateOffset": 0,
            "maxDateOffset": 364,
            "offsetDaysType": "Calendar"
        },
        "batchPaymentConstraints": {
            "allowImmediatePayment": true,
            "allowScheduledPayment": true,
            "minDateOffset": 0,
            "maxDateOffset": 364,
            "offsetDaysType": "Calendar"
        },
        "lastUpdated": "2025-07-16T19:27:38.1178392Z",
        "lastConnected": "2025-07-15T16:15:59.7052797Z"
    },
]