On This Page
FILTER BY TAG

Generating a Secret Key for an Existing Merchant ID

Use this information to generate a secret key for an existing merchant ID (MID) in the
Business Center
 or by using a REST API request. The secret key and MID are required values that you must enter in the
mposUi
 instance that you create. For more information, see Creating an mposUI Instance.

Generate a Secret Key for an Existing Merchant ID in the Business Center

You can generate a secret key for an existing merchant ID (MID) in the
Business Center
. You must enter this value in the
mposUi
 instance that you create. For more information, see Creating an mposUI Instance.
Follow these steps to generate a secret key for an existing MID in the
Business Center
.
  1. In the
    Business Center
    , go to the left navigation panel and choose
    Payment Configuration > Key Management
    . The Key Management page appears.
  2. From the Merchant drop-down list, choose a merchant ID.
  3. Click
    Generate Key
    .
  4. In the Recommended Key Types list, scroll down and choose
    Acceptance Devices Secret Key
    .
  5. Click
    Generate Key
    . The Key Generation page appears.
  6. Click
    Generate Key
    . Your MID and secret key appear on the page.
  7. Click the
    Copy
     or
    Download
     icon to obtain the MID and secret key.

    ADDITIONAL INFORMATION

    IMPORTANT
    If you choose to copy the secret key instead of downloading it, save the information locally because you cannot return to the
    Business Center
     Key Generation page to obtain the same secret key. You must restart the process to obtain a new secret key.

Generate a Secret Key for an Existing Merchant ID Using a REST API Request

You can use a REST API request to generate a secret key for an existing merchant ID (MID). You must enter this value in the
mposUi
 instance you create. For more information, see Creating an mposUI Instance.
You must authenticate each request that you send to a
Cybersource
 API. To authenticate an API request, you can use a REST shared secret key or a REST certificate. For more information about authentication requirements, see the .

Endpoints:

Test:
POST
https://apitest.cybersource.com
/kms/v2/keys-sym-pos
Production:
POST
https://api.cybersource.com
/kms/v2/keys-sym-pos

Required Fields to Generate a Secret Key for an Existing Merchant ID Using a REST API Request

This field is required to generate a secret key for an existing merchant ID when using a REST API request:
keyInformation.organizationId

REST Example: Generate a Secret Key for an Existing Merchant ID Using a REST API Request

Request
{
    "keyInformation":
    [
        {
            "organizationId": "transacting_MID"
        }
    ]
}
Response to a Successful Request
{
    "submitTimeUtc": "2023-08-07T13:07:17Z",
    "status": "ACCEPTED",
    "keyInformation": [
      {
           "organizationId": "transacting_MID",
           "externalOrganizationId": "MerchantId",
           "key": "SecretKey",
           "keyId": "af922a42-6d2c-41fd-92f7-09d908647de4",
           "status": "ACTIVE",
           "expirationDate": "2033-08-07T13:07:17Z"
      }
   ]
}
RELATED TO THIS PAGE