Getting started

Create a User Account

Use the /users/new endpoint to create a new user account. This will be your entry point to the Splice platform.

curl --request POST \
  --url https://sandbox.splice.africa/users/new \
  --header 'Authorization: Basic' \
  --header 'Content-Type: application/json' \
  --data '{
  "email": "",
  "name": "",
  "password": "",
  "telephone": "",
  "username": ""
}'

Authenticating API Requests

With your username and password, you can authenticate your API requests using basic authentication. This ensures that your requests are authorized and authenticated.

You can learn more about this in the Authorization guide here

Creating Your Institution Account

use the /institutions/new endpoint to register your institution on the Splice platform.

Here's a sample request to create an institution account:

curl --request POST \
  --url https://sandbox.splice.africa/institutions/new \
  --header 'Content-Type: application/json' \
  --data '{
  "country_code": "+254",
  "customer_identifier": "Email",
  "identity_endpoint": "",
  "institution_name": "",
  "institution_type": "Fintech",
  "local_currency_code": "KES",
  "receiving_transaction_limit": 1,
  "recv_payment_notif_endpoint": "",
  "send_payment_notif_endpoint": "",
  "user_id": ""
}'

Two important fields in this request are related to webhooks:

1. send_payment_notif_endpoint: This should be a valid URL where Splice will send HTTP POST requests to notify your system of outgoing (sent) payments that have been settled.
2. recv_payment_notif_endpoint: This should be a valid URL where Splice will send HTTP POST requests to notify your system of incoming (received) payments that have been settled.

You can learn more about webhooks in the Webhooks guide

Request Account Activation

After creating your institution account, it will be INACTIVE. You won't be able to access certain endpoints until your account is activated. To activate your Institution account, send an email to our support team at support@splice.africa with a request for activation. Once a Splice representative activates your account, you'll be ready to start making authenticated requests.