An Organisation represents your customer and Pay Runs belong to an Organisation. Generally, an Organisation is a business and so may have to go through a KYC process with Crezco to unlock certain features, such as cross border payments.
To create an Organisation you will need to call the Organisation endpoint
User Information
All Organisations have users and to process payments we need to know who they are.
We provide a simple list of roles to capture the main responsibilities of the users registered within the organisation.
In rare occasions our compliance department may need to reach out to users using the details provided, but that will be strictly for verification purposes. Crezco will never use the user information provided here for anything other than KYC/KYB.
Example
{
"partnerClientId": "Your-Unique-ID",
"companiesHouseNumber": "11752182",
"companyName": "Crezco LIMITED",
"users": [
{
"email": "[email protected]",
"firstName": "Joe",
"lastName": "Bloggs",
"role": "Admin",
"active": true
}
]
}
Response
You will receive a 201 response with the OrganisationId of the newly created Organisation.
Connecting Bank Accounts
A user will have to connect a bank account used by the Organisation to enable the checkout for Pay Runs. This is facilitated quickly and securely through the banks open banking infrastructure, usually the user's mobile banking app.
To start the process you must redirect the user to the connect endpoint with their OrganisationId. This will initiate the connection workflow and send the user through their bank's Open Banking accounts workflow.
For full details see the connect endpoint API reference
A returnUrl must be provided; this specifies where the user will be sent following the completion of the account selection and then connection.
The bank account connection process may be repeated as many times as necessary - either to connect more bank accounts or to reconnect bank accounts which have become deactivated.
Each connection workflow may result in connecting 0, 1, or multiple bank accounts.
Example
https://payments.example.com/organisations/{organisationId}/connect?redirectUrl=https://www.example.com/{organisationId}
Here the redirect has been specified to return the user to an endpoint that includes the OrganisationId in the path.
Following successful connection an Organisation will have references to these bank accounts through the API