On This Page
FILTER BY TAG

Create REST–API Response Key

To enable message-level encryption (MLE) for your SDK integration, you must create a REST–API response key. This section describes how to create and test a REST–API response key.

Overview of MLE

Message-Level Encryption (MLE) enables you to store information or communicate with other parties while helping to prevent uninvolved parties from understanding the stored information. Enabling MLE requires you to create a
P12 certificate
 or
shared secret key pair
 for encrypting your requests and a
REST – API Response MLE
 key for decrypting received responses. If your organization is using meta keys, your security keys must be created by the same portfolio or merchant account.

Step 3A: Create or Submit a REST—API Response MLE Key

Before you can enable your system to support MLE, you must create or upload a
REST—API response MLE
 certificate. After creating or uploading the certificate, you can extract the certificate's key to begin enabling MLE. If your organization is using meta keys, the
shared secret key pair
 and
REST – API response MLE
 key must be created by the same portfolio or merchant account.
Follow these steps to create or submit an API Response MLE certificate in the
Business Center
:
  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 – API Response MLE
    , and then click
    Generate key
    .
  5. Choose one of these options to download your key:
    • To create a new API response MLE certificate, click
      Download key
       .
    • To upload your own certificate, enter your public PEM-formatted certificate in the text box, and then click
      Download key
       . The
      .pem
       file downloads to your desktop. If prompted by your system, approve the location to which the file downloads.
  6. If you are creating a certificate, the Set a Password window appears. Create a password for the certificate by entering the password into the
    New Password
     and
    Confirm Password
     fields, and then click
    Generate key
    .
    The
    .p12
     file downloads to your desktop. If prompted by your system, approve the location to which the key downloads.
    To create or submit another key, click
    Generate another key
    . To view all of your created keys, go to the Key Management page.
    IMPORTANT
    Securely store the
    .p12
     file and password in your system. These credentials are required in order to implement certain products, and you must be able to access them.
  7. Click
    Cancel
    .
    The Key Management page appears.
  8. Click the
    Key Type
     filter and choose
    REST-API Response MLE
    .
  9. Click the
    Expires At
     filter and choose
    All Dates
    .
  10. Click
    Search
    .
  11. Find the REST–API Response key that you created in the Search Results table and save its key ID.
    The key ID is needed to test and configure your system to use MLE.
Test Your REST–API Response MLE Key
To test your REST–API Response key, see Test Your REST–API Response MLE Key.

Step 3B: Test Your REST-API Response Key

Follow these steps to verify that your API response MLE key is working:
  1. Go to the REST API Reference page in the
    Cybersource
     Developer Center:
  2. On the left navigation panel, choose an API that supports MLE. For testing purposes, you can choose
    Intelligent Commerce > Intelligent Commerce Product > Enroll a Card
    .
    MLE support is indicated by
    Request MLE
     and
    Response MLE
     at the top of the screen.
  3. Choose the
    MLE Configuration
     tab.
  4. In the Message Level Encryption Credentials section, enter your API response MLE key credentials:
    • Response encryption:
       Enter the key ID of your REST—API response MLE key.
      You saved this key ID in Step 10 in the Create or Submit a REST—API Response MLE Key section in Enable Message-Level Encryption.
    • Response decryption:
       Click
      Browse
       to submit your own private decryption key from your local system. Only
      .p12
       files are supported.
  5. Click
    Update Credentials
    .
  6. From the
    Send
     drop-down menu, choose
    Send Request with Message Level Encryption
    .
  7. Click
    Send
    .
  8. If a
    Success: HTTP Status Code: 201
     message displays in the Response section, your REST—API response MLE key is verified as properly configured.
RELATED TO THIS PAGE