Meta Keys

A meta key is an API key that a portfolio account or merchant account user can assign to multiple transacting MID accounts simultaneously. This capability can be useful for managing dozens or hundreds of transacting MIDs.
Meta keys are available for these APIs:
  • REST
  • Simple Order API
  • SOAP
  • SCMP

Hierarchy of Meta Keys

Meta keys can be assigned throughout the three-level hierarchy:
  • Portfolio account
  • Merchant account
  • Transacting MID account
Portfolio accounts and merchant accounts can both create meta keys. The key can be assigned to a select group in the hierarchy or to all of the nodes in the hierarchy.
In this diagram, if the portfolio user assigns a meta key to all of the transacting MIDs, every transacting MID in the diagram is assigned the key. If one of the merchant accounts assigns a meta key to all of the transacting MIDs, only the transacting MIDs belonging to the merchant account are assigned the key.

Figure:

Portfolio Hierarchy Example

Overview of Meta Keys

When you are logged in to a portfolio account or merchant account in the
Business Center
, you can assign a meta key to either a static subset of transacting MIDs or to all current and future transacting MIDs. If you choose to assign a meta key to only a subset of transacting MIDs, you can reassign the key later to all current and future transacting MIDs.
When using a meta key, the portfolio account or merchant account user submits the transaction on the transacting MID's behalf. However, the transaction belongs to the transacting MID. Searching for or reporting on the transaction is performed at the transacting MID level. However, the portfolio account, merchant account, and transacting MID user can all perform follow-on transactions to the initial transacting. For example, capture, void, and refund.
Your portfolio account must be configured for meta keys. Merchant accounts can use meta keys only when they belong to a portfolio account that has meta keys enabled. To enable your portfolio for meta keys, contact your
Cybersource
 representative. Merchant accounts that do
not
 belong to a portfolio account are not eligible for meta keys.
Transacting MIDs cannot assign meta keys but can assign regular keys. For security reasons, do not give the meta key to transacting MID users, which are the merchants.
WARNING
When a meta key expires, it expires for all transacting MIDs to which it is assigned. All transactions using that meta key will fail. Careful monitoring is necessary to track meta key expiration dates. You must create and assign a new key before the previous key expires. The length of time after which a key expires depends on the API for which the key was created. Read the instructions for the API key you will use.

Using Meta Keys

Follow the instructions in these sections to create and assign meta keys.
Meta Keys

Submit API Requests Using Meta Keys

This section contains all of the information you need in order to submit an API transaction using meta keys.
Meta Keys

Regenerate a Meta Key

When any security key expires, it must be updated. If you update the meta key manually, you must reassign merchants to it, which can be time-consuming. Meta key regeneration enables you to update the meta key with all of its assignments intact, streamlining the process.
  1. On the left navigation panel, navigate to
    Payment Configuration > Key Management
    .
    The Key Management page appears.
  2. Use the Search Filters to find the key you want to regenerate.
    Results appear in the Search Results table.
  3. Click the
    Regenerate meta key
     button for the key you want to regenerate.
    The Key Generation page opens. The new key appears on the screen. The original key remains active until its original expiration date.
  4. Provide the new key details to the merchants associated with the affected MIDs, and instruct them to update the information wherever it is used.
Meta Keys