Skip to main content

API keys

What are API keys and why are they needed?

In the Toolkit API Keys consist of 2 values: a unique ID key and a randomly generated alphanumeric value. Both of these values are used in almost all requests to the Fena Payments API. They are needed so that you can authenticate your organisation when your application communicates with our API. Do not leave your keys in the public domain, otherwise this may lead to negative consequences, including loss or damage to your organisation’s account, etc.

Creating an API key

In the settings menu, go to the section called “API Keys” and click the “Generate API key” button and begin creating an API key

fena page settings screenshot

Here you can see the form for creating an API key. Let's look at each of the fields:

  • API key name - the field is free to enter. Designed so that you can distinguish different keys from each other.
  • Description - optional field. Here you can add a more detailed description of the key, for example, its purpose
  • Role - the role with the access rights that you think are most suitable for this API key.
  • Webhook/Payment Notification URL - URL address where notifications about changes in payment status will be sent. The webhook API specification can be found 'here'.
  • Redirect URL - URL address to which the user who makes payments will be redirected after completion.
  • Status - enable/disable API key. Requests that use disabled API keys will be blocked on the toolkit API side.

After all the required fields are completed, click the "Generate API key" button and you will be taken back to the general page of all API keys, where you can see the newly created API key.

fena page settings screenshot