Sending OAuth Credentials

If you use OAuth, you must send credentials for your OAuth server so that notifications are authenticated.
To request the service, use the endpoint specified below. After you send the request, check the response message to verify that the request was successful. A 200-level response code indicates success.
For information about response codes, see
Transaction Response Codes
.

Endpoint

  • Test:
    POST
    apitest.cybersource.com
    /kms/egress/v2/keys-sym
  • Production:
    POST
    api.cybersource.com
    /kms/egress/v2/keys-sym
  • Production
     in India:
    POST api.in.cybersource.com/kms/egress/v2/keys-sym

Required Fields for Sending Your OAuth Credentials

clientRequestAction
Set the value to
STORE
.
keyInformation.clientKeyId
Set the value to the OAuth client's username.
keyInformation.expiryDuration
Set the value to
365
.
keyInformation.key
Set the value to the client's secret key.
keyInformation.keyType
Set the value to
oAuthClientCredentials
.
keyInformation.organizationId
Set the value to the organization ID of the organization requesting the key.
keyInformation.provider
Set to the value of the
organizationId
field that is assigned to the organization sending the request.
keyInformation.tenant
Set the value to
nrtd
.

Required Headers

v-c-sender-organization-id
v-c-permissions

Example: Sending Your OAuth Credentials 

        
Store oAuth Credentials
        
        
{
  "clientRequestAction": "STORE",
  "keyInformation": {
    "provider": "merchantName",
    "tenant": "nrtd",
    "keyType": "oAuthClientCredentials",
    "organizationId": "merchantName",
    "clientKeyId": "client username",
    "key": "client secret",
    "expiryDuration": "365"
  }
}
        
        
{
    "submitTimeUtc": "2022-02-18T19:49:52Z",
    "status": "SUCCESS",
    "keyInformation": {
        "provider": "org1",
        "tenant": "nrtd",
        "organizationId": "org1",
        "clientKeyId": "ef400ac1-edfe-406e-94b3-0d73be09a1a0",
        "keyId": "d8512fb5-1d8c-4f2d-e053-3cb8d30a764c",
        "key": "KTTY1LLGYR6A2LL4XZTT9W9RGCVJ5Z4XZAP6AFTRUFWLSXX0NX4N88N9EJED3BMM",
        "keyType": "oAuthClientCredentials",
        "status": "active",
        "expirationDate": "2023-02-18T19:49:52Z"
    }
}