On This Page

Provide Your OAuth Credentials

If your system uses the OAuth
or OAuth with JWT
security policy, you must provide your OAuth credentials to Visa Acceptance Solutions. When Visa Acceptance Solutions sends you webhook notifications in the future, Visa Acceptance Solutions will use your OAuth credentials to access your server and deliver the notification message.

IMPORTANT

If you are only using the default mutual trust
security policy, you do not need to provide OAuth credentials to Visa Acceptance Solutions.

OAuth: The OAuth security policy with client credentials is an authentication method that is designed for applications to communicate with each other. Basic authentication is the most common mechanism for authenticating a client with the client credentials. This authentication method enables Visa Acceptance Solutions services to obtain only the relevant user data without exposing the user's credentials.
OAuth with JWT: The OAuth with JWT security policy is an authentication method in which your system sends a JSON Web Token. This method bypasses domain headers and minimizes the need for server-side authentication checks.

Endpoints

Send a POST to one of these endpoints:

Test:

POST https://apitest.visaacceptance.com/kms/egress/v2/keys-sym

Production:

POST https://api.visaacceptance.com/kms/egress/v2/keys-sym

Required Fields for Providing Your OAuth Credentials

clientRequestAction: Set to
STORE
.
keyInformation.clientKeyId: Set to the OAuth client's username.
keyInformation.expiryDuration: Set to
365
.
keyInformation.key: Set to the client's secret key.
keyInformation.keyType: Set to
oAuthClientCredentials
.
keyInformation.organizationId: Set to the organization ID or merchant ID of the organization requesting the key.
keyInformation.provider: Set to the organization ID that the requesting organization belongs to.
keyInformation.tenant: Set to
nrtd
.

Example: Providing Your 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"
    }
}