Developer Onboarding

Integrating Anchor APIs in your applications.

Here is a guide for developers integrating our APIs

Sign up on Anchor

To start using Anchor, visit this link to request an invite to the Anchor Dashboard. Once you receive the invite, proceed to the Anchor Sign Up page and complete the sign-up process to create your organization account.

After signing up, you will be able to sign in and gain access to the Anchor Dashboard, a centralised platform where you can view and manage all your operations within Anchor.

Our APIs are available in two environments: Sandbox Environment and Live (Production) Environment.

The sandbox environment works just like the live environment and contains API operations that allow you to easily test and simulate different activities, from customer and deposit account creation, to incoming payments or transfers.

The Live environment allow you to transact with real money.

Here is link to our API References:

Create and Get your API keys from Anchor Dashboard

API keys give you access to interact and call our endpoints. API keys are essential for interacting with Anchor's API services securely. Here's a step-by-step guide on how to set up API keys on Anchor:

  1. Log into Anchor Dashboard.
  2. Select Developers and click on API keys on the left navigation menu
  3. Click Create API Key at the top right of the screen.
  4. Give your API key a Label for identification and select an expiration date.
  5. Add the permissions you would like your API keys to have and click Create API Key at the button right of the screen to create it.

Things to Note When Creating API Keys
Creating and managing API keys comes with responsibilities to ensure the security of your organization account and data. Here are some best practices to follow:

  1. Avoid Hardcoding API Keys: Never embed API keys directly in your application's source code. Instead, use environment variables or in configuration files outside of your application's source tree. This prevents accidental exposure of your keys in public repositories.
  2. Change API Keys Periodically: Change your API keys at regular intervals, even if they are still in use. Changing keys helps prevent potential vulnerabilities and adds an extra layer of security to your application.
  3. Regularly Delete Unneeded Keys: API keys should be periodically reviewed. Delete any keys that are no longer in use or needed for your application. This minimizes the potential attack surface and ensures that only essential keys are active.
Create Webhooks and Listen to Events.

You can quickly create webhooks from your dashboard to listen to specific events that happen within your organization
To create a webhook from the Anchor Dashboard, follow these steps:

  1. Log in to your Anchor Dashboard.
  2. Click on the Settings >> Click on the Developers tab.
  3. Click on the Webhooks tab >> Click on the Add Webhook button.
    On the Webhook Information Page:
  4. Enter the URL you want your webhook to be sent to.
  5. Give your webhook a label. Should you create more that one webhook, this name will help to identity the webhook from the list.
  6. Select your delivery mode.
  7. Choose the option to enable Support Included. By default, this is set to false. When this option is enabled, every webhook that is related to a specific resource will have the full resource included in the payload of the event - for example, the customer.created event will include the full customer resource.
    On the Add Events page:
  8. Check the boxes for the kind of events you want to include.
  9. Click on the Create Webhook button.
    Your webhook will be created.
To get test funds in sandbox, use the simulate transfer button in dashboard

You can simulate incoming payment to get test funds in sandbox mode. Below are the specific steps to fund an account in sandbox

  1. In the sandbox environment, go to the Accounts page, select Deposit Accounts then click on Simulate Transfer button.
  2. Fill the form by filling out your API Keys, Source Account Name and Source Account Number, and select the Virtual Account Number (Virtual Nuban) you want to fund.
    (Note the the Source Account Name and Source Account Number can be random values).
  3. The fund will reflect in the deposit account linked to the Virtual Nuban.

Need Help?

Visit our API references.

For real-time support during integration, join our Slack workspace directly using this link.