API reference

Generated from the running service on every build. 15 operations under /v1, all HMAC-signed.

Every page in this section is generated from the partner OpenAPI document that the API itself publishes. Nothing here is hand-written, so it cannot describe a route the service does not serve.

Base URL for every operation:

https://sandbox.onlink.africa

That is the only environment the partner API runs in. Every operation requires an HMAC signature and an X-OnLink-Key header — see authentication.

Download the OpenAPI 3 spec — import it into Postman or Insomnia, or generate a client from it. It is the same document these pages are generated from, so it cannot describe a different API.

An endpoint list makes this API look synchronous

It is not. A created order settles after the call that created it, so an integration built as though POST completed the trade is the one mistake this reference cannot warn you about per-operation. Read asynchronous settlement before you build against anything here.