On This Page

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

Getting Started with REST Developer Guide

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"
      }
   ]
}