An API key is required to make API calls. The API key has the same permissions as your user.
Where to find it
Log into the portal and click on your user profile in the top right. Scroll down to the API key section to view or create one.
Click on the edit logo to view your FULL API key.
If you don't see the API key section you don't have the proper permissions, please contact your administrator in this case.
Expiry
An API key expires after a maximum of 12 months. When creating your API key you can set your own expiry date. Starting a month before it expires you will get regular notifications sent by email reminding you that you need to renew it.
Renewal
When you are notified that your API key is about to expire follow these steps to renew your API key:
Login and click on your user profile.
Navigate to the API section and create a new API key.
Replace your old API key with your new API key in your code base.
Go back to the API section in your user profile and delete your old API key.
It is possible to use the API to automate this process, take a look at the API key endpoint.
Need help?
Do you have a question? If you didn’t find the answer you are looking for in our documentation, you can contact our Support teams for more information. If you have a technical issue or question, please contact us. We are happy to help.
We’ll help you choose the right payment solution for your business, wherever you want to sell, in-person or online. Our team of experts will happily discuss your needs.
