Authentication

The GBiPayments API uses a key pair (Public and Secret Keys) for authentication. To make an authenticated request to our API, you need to pass custom headers as described in this section.

Obtain the Keys

The Public and Secret keys can be copied from the merchant dashboard under the specific merchant account details as described here. These keys should be sent as headers with the header names; public-key and secret-key

Please ensure that your keys are stored safely and not shared with the public. In the event your keys are compromised, please contact us immediately for assistance. You an alternatively regenerate the secret key from within your merchant account dashboard

Request Headers

For most of the API requests, only the public-key header is required. Scenarios that require the secret-key header will be described accordingly;

Header Name	Value	Required
Content-Type	application/json	YES
x-api-version	API version (currently 1)	YES
public-key	The Public Key as obtained from the merchant account settings	YES
secret-key	The Secret Key as obtained from the merchant account settings. Required for specific situations as the document will guide	NO