Introduction

The Velocity API is organised around REST. You can use the API in sandbox mode which will allow you to simulate success or failure without interacting with payment networks.

Authentication

The Velocity API uses API keys to authenticate requests. You can view and manage your API keys in the Velocity Dashboard. Your API keys carry many privileges. Follow best practices to keep your keys safe. Don’t embed secret or restricted API keys in source code or client-side applications

Usage

All API requests require an API key obtained from the admin dashboard. Include your API key in the request header as shown below.

curl --location 'https://api.velocityafrica.net/sales-orders' \
--header 'Content-Type: application/json' \
--header 'X-API-Key: gH13ni...' \

Errors

Velocity uses conventional HTTP response codes to indicate the success or failure of an API request. In general: Codes in the 2xx range indicate success. Codes in the 4xx range indicate an error that failed given the information provided. Codes in the 5xx range indicate an error with Velocity's servers.