API Keys
  • 11 Jun 2024
  • 1 Minute to read

API Keys


Article summary

API Keys

To integrate OrkestaPay into your project, either via API or using one of our plugins, you need integration keys.

Enter the OrkestaPay portal and go to the “Developers” section, where you will find the keys needed to start your integration.

OrkestaPay (9)(1)

Secret Keys and Public Keys

OrkestaPay provides 4 integration keys: 2 public keys and 2 secret or sensitive keys that must be safeguarded during the integration process. 

  • Merchant ID:  A unique identifier for your business. Along with the device key, it generates a fingerprint of the device where the payment is made, aiding the anti-fraud process. This is used on the client side.

  • Client ID: This key, along with the secret key, allows authentication to communicate with the OrkestaPay API. It is used on the server side.

  • Client Secret: This key, together with the access key, enables authentication to communicate with the OrkestaPay API. It is used on the server side.

  • Public Key: This key, along with the business ID, generates a fingerprint of the device where the payment is made, assisting the anti-fraud process. This is used on the client side.

Regenerate Integration Keys

If you suspect that your integration keys have been compromised, you can regenerate them. The previous keys will then become obsolete. To do this, go to the “Developers” section, and at the bottom, you will find the option to generate new keys. You must confirm this action to proceed.

OrkestaPay (10)(1)

Test Mode & Production Mode

When performing integration tests, remember to switch the mode of operation (the switch is shown in the top bar) and copy the correct keys, as these will change depending on the mode.


Was this article helpful?

What's Next