API Key

Overview

The API Key is required to authenticate your application with the nstFi API.
Use this token in your API requests to ensure secure communication between your system and nstFi services.

API & Portal URLs

How to Generate Your API Token Key

You can get your API key as follows:

• Log in to your nstFi account using your Super Master Account.
• From the side menu, select Integration Settings → API Key
• Click the Add button to generate a new key.
• You will be redirected to a page where you can configure the key settings:
  • Name: A custom label for your token.
  • Expiry Date: Define when this key will expire.
  • Active Status: Choose whether the key is active or inactive.
  • Permissions: Select which API endpoints the key can access, and you can assign custom permissions like Super Rules, Create Payments, Update Payments, etc.
• After filling in the details, scroll down and click Create to generate the new API key.
• Once created, your key will appear in the list.
• Click on the Copy icon next to the key to copy it and start using this key in your integration.

**Important Notes**

• You can create up to 5 API keys only.

• If you use a token to access an endpoint without the required permissions,
  you will receive the following error:
  Status Code: 401 , Message: "The token does not have the required permissions!"

• You can edit an existing API key by clicking the Edit icon next to it. This allows you to update the name, permissions, status, or delete the key.

**Request Header**

Add "Authorization": "Bearer token" to request header. Token of demo configuration can be found here.

**Legacy API Key**

If you are using a legacy API Key, it will remain valid until it expires. After that, you will be forced to use the new version of the API Keys.

**Multi-Country Account**

Each enabled country in your portal account has a different API token key. You have to use the API token key of each country in your integration to allow your customer to pay in their local currency.

**Disable user**

Please, avoid disabling the user who created the token, as it will disable the token key.

Test (Demo) Token

To test your integration without real transactions, create a demo account by registering at https://stg.nstfi.app/admin/register , selecting Kuwait as the country, and skipping the bank details step. After completing the registration, email [email protected] to activate your demo account and enable the required features.

Public Test API Token Key

You can also use the public test token provided by nstFi.
Click the copy icon 📋 next to the token box to copy it.

SK_KWT_vVZlnnAqu8jRByOWaRPNId4ShzEDNt256dvnjebuyzo52dXjAfRx2ixW5umjWSUx