Meta Keys

A meta key is an API key that a portfolio or account-level user can assign to multiple merchants IDs (MIDs) simultaneously. This can be useful for managing dozens or hundreds of MIDs.
Meta Keys are available for the following APIs:
  • REST
  • Simple Order API
  • SOAP
  • SCMP
When you are logged in to a portfolio or account in the Business Center, you can assign a meta key to either a static subset of MIDs or to all current and future MIDs. If you choose to assign a meta key to only a subset of MIDs, you can reassign the key later to all current and future MIDs.
When using a meta key, the portfolio or account submits the transaction on the MID's behalf. However, the transaction belongs to the MID. Searching for or reporting on the transaction is done at the MID-level. However, the portfolio, account, and merchant can all perform follow-on actions to the transaction. For example, capture, void, and refund.
Your portfolio must be configured for meta keys. Accounts can use meta keys only if they are under a portfolio that has meta keys enabled. To enable your portfolio for meta keys, contact your
representative. Accounts that are not under a portfolio are not eligible for meta keys at this time.
MIDs cannot assign meta keys but can assign regular keys. For security, do not give the meta key to merchants.
When a meta key expires, it expires for all 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.
Back to top