API Reference

Welcome to the Sentinal® API Reference. This section provides detailed information about our API endpoints, request parameters, response formats, and examples to help you integrate seamlessly with the Sentinal® system.

Base URL

All API requests should be made to:

Prod:

https://{country-code}-api.sentinal.network

Sandbox:

https://{country-code}-sandbox.sentinal.network

Country Codes for Integration

Please use the appropriate country code from the list below based on the country you are integrating with:

• ng - Nigeria

• ke - Kenya

• gr - Greece

• th - Thailand

• gh - Ghana

Authentication

Every API request requires authentication. Ensure you include your API key in the x-api-key header of every request.

Endpoints

1. Client Registration

   • Endpoint: /registerClient

   • Method: POST

   • Description: Onboard a new client to the Sentinal system.

2. Verify Client Status

   • Endpoint: /verifyClientStatus

   • Method: GET

   • Description: Check the current status of a client within the Sentinal system.

3. Submit Basket

   • Endpoint: /submitBasket

   • Method: POST

   • Description: Submit a new basket for processing.

4. Verify Transaction

   • Endpoint: /verifyTransaction

   • Method: POST

   • Description: Verify a transaction's details, including VAT, fees, and settlement amount. The system will approve or decline based on the client's standing.

5. Webhooks

   • Description: Real-time updates for various events in the Sentinal system.

   • Subscribe Endpoint: /subscribeToClient

   • Events: Client Change, New Basket, New Transaction, Transaction Change.

Sequence diagram

Rate Limits

We have guidelines in place to ensure you don't get rate limited. However If you ever do exceed this limit, you'll receive a 429 Too Many Requests response.

Errors

Our API returns standard HTTP response codes. For errors, we also include error messages to help you understand the issue.

Support

If you encounter any issues or have questions about our API, please contact our support team at [email protected]