On This Page
FILTER BY TAG

Create a Shared Secret Key Pair

You must create a shared secret key pair to use JWT message security. How you create your shared secret key pair is determined by your
Cybersource
 account type.
Transacting merchant account users can create their own unique shared secret key. Portfolio and merchant account users must create a
meta key
 of a shared secret key. Meta keys enable an organization administrator to create a single shared secret key. That key is assigned to some or all transacting merchants in their organization. The purpose of meta key is to reduce the time needed to manage an organization's keys. For example, by assigning the same meta key to all of your transacting merchants, you need to update only one key when it expires instead of having to update each transacting merchant's key when it expires.
For more information about meta keys, see the Meta Key Creation and Management section in the
Creating and Using Security Keys User Guide
.
Merchant Account
If you are using a merchant account, see Merchant Account User: Create a Meta Key.
Portfolio Account
If you are using a portfolio account, see Portfolio User: Create a Meta Key.
Transacting Merchant Account
If you are using a transacting merchant account, see Creating a Shared Secret Key Pair. Transacting merchant accounts are also referred to as
transacting MIDs
.
transacting merchant

Creating a Shared Secret Key Pair

Follow these steps to create a shared secret key pair:
IMPORTANT
Only transacting merchant account users can complete this task.
  2. On the left navigation panel, choose
    Payment Configuration > Key Management
    .
  3. Click
    + Generate key
     on the Key Management page.
  4. Under REST APIs, choose
    REST – Shared Secret
     and then click
    Generate key
    .
    The REST API Shared Secret Key page appears.
  5. Click
    Download key
     .
    The
    .pem
     file downloads to your desktop.
To create or upload another key, click
Generate another key
. To view all of your created keys, go to the Key Management page.
IMPORTANT
Securely store the key credentials and
.pem
 file in your system. These credentials are required in order to implement certain products, and you must be able to access them.
What to do next
To test your shared secret key pair, see Test Your Shared Secret Key Pair.
acquirer

Merchant Account User: Create a Shared Secret Meta Key

This section describes how to create a meta key as a merchant account user in the
Business Center
.
IMPORTANT
Only merchant account users can complete this task.
IMPORTANT
If you would like to create meta keys using the API, contact your support team for more information.
Follow these steps to create a meta key for a shared secret key pair:
  1. Log in to the
    Business Center
    :
  2. On the left navigation panel, choose
    Payment Configuration > Key Management
    .
    If you are using a portfolio account to create a meta key for one of your merchant accounts, you can switch to a merchant account by clicking
    Switch merchant
    .
    The Quick Merchant Switch page appears.
    Choose the merchant account ID that you want to switch to, and click
    Switch
    .
  3. In the
    Merchant ID
     search filter, choose your merchant account ID.
    If you logged in from a portfolio user account or the account (
    _acct
    ) level, verify that the merchant ID you choose does not contain
    _acct
     in the ID name.
  4. Click
    + Generate Key
    .
    The Create Key page appears.
  5. Choose
    REST – Shared Secret
     and click
    Generate key
    .
    The Key options window appears.
  6. Check the
    Create as a Meta-Key
     box and click
    Continue
    .
  7. Choose one of these options to assign the key:
    • To assign this key to all accounts in the current portfolio, choose
      All current and future Merchant IDs
      , click
      Create key
      , and continue to the Create Key page. All future merchant IDs will be automatically assigned this key. You are done and do not need to proceed with the following steps.
    • To assign this key to a specific merchant or group of merchants, choose
      Custom Merchant ID selection
       and then click
      Create key
      . This key is not automatically assigned to any future merchants. Proceed to the following steps.
  8. Click
    + Add custom merchant ids
    . The Add Custom Merchant IDs page appears.
    By default, all merchant IDs are shown in the Merchant IDs table. To limit the list to a subset of merchant IDs, click
    + Add filter
    , choose a search filter from the drop-down menu, and click
    Search
    .
  9. Check one or more transacting MID account boxes, and click
    Submit
    .
    The Key Generation page opens.
  10. Click
    Create key
    .
    Continue to the Create Key page to view your new key.
    You can also generate a new key by clicking
    + Generate Key
     again.

AFTER COMPLETING THE TASK

To test your shared secret key pair, see Test Your Shared Secret Key Pair.
acquirer

Portfolio User: Create a Shared Secret Meta Key

This section describes how to create a meta key as a portfolio user in the
Business Center
.
IMPORTANT
Only portfolio account users can complete this task.
IMPORTANT
If you would like to create meta keys using the API, contact your support team for more information.
Follow these steps to create a meta key for a shared secret key pair:
  1. Log in to the
    Business Center
    :
  2. On the left navigation panel, choose
    Payment Configuration > Key Management
    .
  3. In the
    Merchant Id
     field, choose your portfolio ID if it is not already chosen by default.
  4. Click
    + Generate Key
    .
    The Create Key page appears.
  5. Choose
    REST – Shared Secret
     and click
    Generate key
    .
    The Key options page appears.
  6. Check the
    Create as a Meta-Key
     box and click
    Continue
    .
  7. Choose one of these options to assign the key:
    • To assign this key to all accounts in the current portfolio, choose
      All current and future Merchant IDs
      , click
      Create key
      , and continue to the Create Key page. All future merchant IDs will be automatically assigned this key. You are done and do not need to proceed with the following steps.
    • To assign this key to a specific merchant or group of merchants, choose
      Custom Merchant ID selection
       and then click
      Create key
      . This key is not automatically assigned to any future merchants. Proceed to the following steps.
  8. Click
    + Add custom merchant ids
    . The Add Custom Merchant IDs page appears.
    By default, all merchant IDs are shown in the Merchant IDs table. To limit the list to a subset of merchant IDs, click
    + Add filter
    , choose a search filter from the drop-down menu, and click
    Search
    .
  9. Check one or more transacting MID account boxes, and click
    Submit
    .
    The Key Generation page opens.
  10. Click
    Create key
    .
    Continue to the Create Key page to view your new key.
    You can also generate a new key by clicking
    + Generate Key
     again.

AFTER COMPLETING THE TASK

To test your shared secret key pair, see Test Your Shared Secret Key Pair.

Test Your Shared Secret Key Pair

After creating your key certificate, you must verify that your key can successfully process API requests. Follow these steps to validate your key certificate in the Developer Center and the
Business Center
.
  1. Under Authentication and Sandbox Credentials, go to the Authentication Type drop-down menu and choose
    HTTP Signature
    .
  2. Enter your organization ID in the
    Organization ID
     field.
  3. Enter your key, also known as your private key, in the
    Key
     field.
  4. Enter your secret key, also known as your public key, in the
    Shared Secret Key
     field.
  5. Click
    Update Credentials
    .
RELATED TO THIS PAGE