API Keys

This section describes what API keys are and how to retrieve them.

Rave authenticates your API requests using your account’s API keys. If you do not include your key when making an API request or use one that is incorrect or outdated, Rave returns an error.

All API requests exist in either test or live mode, and one mode cannot be manipulated by data in the other. To get your live and test API keys sign up here

There are also two types of API keys: publishable and secret.

  • Publishable API keys are meant solely to identify your account with Rave, they aren’t secret. In other words, they can safely be published in places like your Rave JavaScript code, or in an Android or iPhone app. Publishable keys only have the power to create a transaction.

  • Secret API keys should be kept confidential and only stored on your own servers. Your account’s secret API key can perform any API request to Rave without restriction.

-Encryption Key is meant to be used in Android SDK integrations, and other mobile integrations where storing the secret key is not allowed.

Obtaining your API Keys

Your API keys are available in the Dashboard by navigating to Settings - > API.

2870

Use the toggle to switch between live and test mode.

🚧

Only use your test API keys for testing and development.

This ensures you don't accidentally modify your live customers or transactions.

If you cannot see your API keys in the Dashboard, this means you do not have access to them. Contact your Rave account’s owner and ask to be added to their team as an admin.

Test and live modes

The test and live modes function almost identically, with a few necessary differences:

  • In test mode, payments are not processed by card networks or payment providers, and only our Test cards and Test bank accounts must be used

Next Steps