1. Onboard Businesses
Only businesses that have connected their account to Titus within your platform can accept payments through Titus. So the first step is enable businesses using your platform to onboard with Titus.
Ensure that you’ve gone through the Prerequisites before continuing!
1. Create a business onboarding linkCopied!
The first step is to create a signed business onboarding link. It must include the id you use for the business in your system. See Business Connections for options.
Example Server-Side Request
const externalId = 'vendor_123';
const requestUrl = `https://api.gotitus.com/v1/business-connections/connect-url`;
const response = await fetch(requestUrl, {
method: 'POST',
headers: {
'Content-Type': 'application/json',
'x-api-key': 'YOUR_TITUS_API_KEY',
},
body: JSON.stringify({
// where "externalId" is an id that you use for the business/vendor in
// your system
externalId: 'vendor_123',
}),
});
const { url } = await response.json()
2. Surface the button somewhere in your applicationCopied!
You need to add a button somewhere inside of your application for businesses to click to connect their account to Titus. See Design Guidance for UI implementation guidance.
When that button is clicked, it should make a request to your backend to get the Titus URL and redirect the business to the URL.
When the business opens the Titus-provided URL:
-
They log in or create a Titus business account
-
They authorize your platform to view their payment activity
-
Upon approval, a
platform_business
is created and they will be redirected back to your site.
3. Track the Connection via WebhookCopied!
After the business accepts, Titus will trigger webhook events for business_connection.created
and business_connection.updated
:
{
"type": "business_connection.created",
"payload": {
"externalId": "vendor_123",
"businessId": "789",
"platformId": "YOUR_PLATFORM_ID",
}
}
Use externalId to correlate with businesses in your system and update them as necessary, such as setting them as having connected to Titus.
Your Titus dashboard will show all connected businesses and their payout history
Next Step
Now, you’re ready to add Titus as a payment method in the checkout flows of connected businesses.