You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Next »

This page explains how to view, renew and revoke the keys used for the technical integration with Axepta Online from the Merchant Portal.

Key management allows the merchant or technical integrator to secure exchanges between their system and the Axepta Online platform, especially for REST API calls, server-to-server notifications and, depending on the integration mode, exchanges using HMAC keys or the encryption password.

Regular key renewal is recommended for security reasons. A controlled key rotation allows old keys to be replaced without service interruption.


Overview of Key management


Once enabled to edit API Credentials, you can

  1. create a new key for empty fields
    StatusDescription
    ActiveThe key has been generated, is valid and can be used immediately for API access
    Use casetemporary migrations or before key rotation
  2. renew an existing key
    StatusDescription
    ActiveThe key has been updated, is valid and can be used immediately for API access
    Use caseif compromise is suspected or without key rotation


  3. revoke an existing key
    StatusDescription
    InactiveThe key has been immediately deactivated and is irretrievably deleted for API access
    Use casetemporary migrations or after key rotation


 uses API key sets for your MerchantID.

Legacy API (Both used in legacy API)

Encryption Password

Primary HMAC key

REST API (Primary HMAC Key is shared and optionally used for Enhanced Webhook in REST API)

Primary HMAC key

Primary REST API key

Double run in REST API (Both optionally used for double run in REST API)

Secondary HMAC key

Secondary REST API key


In case you have integrated with our REST API you can use two key sets in parallel to rotate keys without downtime.

Using two key sets in parallel is called double run. Double run allows you to switch your systems from one key to another without interrupting live traffic.



  • No labels