Client

In the Sentinal system, a client refers to an entity, typically a merchant or an operator, that intends to process transactions through the system.

Registering a client

POST /v1/client/registerClient

To onboard a new client to the Sentinal system, you need to register them. This registration process will provide the client with their unique API key, which they will use for all subsequent interactions with the system.

Headers

Name	Type	Description
x-api-key*	string

Request Body

Name	Type	Description
registeredName*	string
registrationNumber*	string
countryCode*	string
email*	string
phoneNumber*	string
classification*	string	IGAMING_GLOBAL | IGAMING_LOCAL | ECOMM_GLOBAL | ECOMM_LOCAL | CRYPTO_GLOBAL | CRYPTO_LOCAL |
organizationTin*	string

200 Client registered successfully by PSP

{
    "success": true,
    "message": "Client registered successfully by PSP.",
    "content": {
        "apiKey": "35c63c5955365661ea089945e5095a3576e539e65356cc35da46ce0275e2b803",
        "secret": "9d26e2fc6467a4718861af61f38e025f0abc295ba6749b949a83ee399570b9bb"
    }
}

401 Unathorised

400: Bad Request

{
    "success": false,
    "message": "The field '{missingField}' is required",
}

Verify client status

GET https://api.sentinal.network/v1/client/verifyClientStatus

The Verify Client Status endpoint allows clients to check their current status within the Sentinal system. This status provides insights into the client's verification level, operational standing, and any potential issues or flags associated with their account.

Headers

Name	Type	Description
x-api-key*	string

200: OK Client status retrieved successfully.

{
    "success": true,
    "message": "Client status retrieved successfully.",
    "content": {
        "phoneNumber": "[phone]",
        "registeredName": "Sample Inc.",
        "registrationNumber": "1010",
        "organizationTin": "1010",
        "countryCode": "NG",
        "currency": "NGN",
        "countries": [
            {
                "name": "Nigeria",
                "countryCode": "NG"
            }
        ],
        "email": "[email protected]",
        "paymentProviders": [],
        "status": "PENDING",
        "id": "uAxxSaiTNDSYMrGdngEW"
    }
}

Add PSP Secret

POST https://api.sentinal.network/v1/client/addPSPSecret

The Add PSP Secret allows a client to save their respective PSP secret to their accounts in order for the Sentinal system to orchestrate their payments during the createPayment process.

Headers

Name	Type	Description
x-api-key	String

Request Body

Name	Type	Description
psp	String	FLUTTERWAVE | KORA
secret	String

200: OK Secret added successfully.

{
  "success": true,
  "message": "Secret added successfully."
}

Code sample: JavaScript (Node.js) using Axios

const axios = require('axios');

const data = {
  psp: 'FLUTTERWAVE | KORA',
  secret: 'your_secret'
};

axios.post('https://api.sentinal.network/addPSPSecret', data, {
  headers: {
    'x-api-key': 'your_client_api_key'
  }
})
.then((response) => console.log(response.data))
.catch((error) => console.error(error));