API keys

Learn how to manage API keys in the Mambu Payments (formerly Numeral) dashboard

Generate API key

Generating an API key is the first step to integrating the Mambu Payments API. To generate an API key:

Your API will be displayed and can be copied to your clipboard. Please note that it will only be shown once and can no longer be accessed after you exit or refresh the page.

⚠️

Do not share API keys

Do not share your API key in publicly accessible areas, such as your GitHub repository, in client-side code, or in log management tools.

If your API key gets compromised, you can disable it and create a new one directly from the Mambu Payments dashboard.

ℹ️

Expiration date

Mambu Payments supports setting expiration dates for API keys. This helps you enforce rotation policies and reduce the risk of long-lived, unused, or compromised credentials.

API key permissions

API keys can have one of three permissions:

PermissionDescription
readAPI key can be used to retrieve resources.
modifyAPI key can be used to modify resources, which includes updating and approving / rejecting them.
writeAPI key can be used to create new resources.

Access API keys

API keys can be accessed in the dashboard or using the List API keys API endpoint.

Disable API key

To manually disable an API key before it expires, go the API key to disable and click on Actions > Disable.