Integration Quick Guide

Start your journey with our API and begin the development of your TransactionLink integration.

Before you can start building integration with TransactionLink, you will need to have at least one workflow ready and created by us. You will then need to setup your API keys, and implement a code snippet to trigger the onboarding widget.

To start onboarding real users, you need to get in touch with us to activate production access.

What is a workflow?

Your digital onboarding journey is made up of one or more workflows. Our workflows are come with a white-labelled frontend so you can get started onboarding users in the shortest time. Generally, most onboarding journeys consist of only one workflow. If you have more complex cases, such as splitting your onboarding into multiple user journeys (e.g. advanced verification for higher transaction volume), your onboarding journey will consist of multiple workflows.

Step 1: Getting sandbox access and your first workflow

If you do not have one yet, you will need to get in touch with us. Our team will work with you to understand your onboarding needs and help you craft the most suitable workflow.

You will receive sandbox access to our dashboard.

Step 2: Create your first workspace

When you log in to our dashboard for the first time, you will be prompted to create your first sandbox workspace.

A workspace is its own universe of workflows and the associated end-users who go through the workflows.

Step 3: Acquire your API keys To ensure secure authentication of your API requests.

TransactionLink utilizes API keys associated with your workspace. It is crucial to include the correct API key when making an API request; otherwise, TransactionLink will return an error.

On each account, you can create multiple workspaces. There are two types of workspaces: sandbox and live. The sandbox workspace is isolated from production and is intended for integration testing. In the sandbox environment, dummy data is returned, allowing you to test your integrations without affecting real production data.

When performing testing and development, it is important to exclusively utilize sandbox workspaces

Step 3: Make a test API request

To verify the proper functionality of your integration, initiate a test API request using your workspace API keys.

curl --request POST \
  --url \
  --header 'Content-Type: application/json' \
  --data '{

You will receive an access token in response, granting you the ability to perform further operations within our API.

	"accessToken": "<...>",
	"refreshToken": "<...>",
	"expiryDuration": 86400,
	"tokenType": "Bearer"

Step 4: Check workflow

Next steps

Congrats! Now you can proceed to learn how to integrate the workflow.

Last updated