Skip to main content

Adyen credentials API (1.0)

Download OpenAPI specification:Download

Use this API to store the Adyen integration credentials. For more information on integrating Adyen with NewStore, see this guide.

Update credentials for Adyen payment devices and APIs

Updates the set of credentials used to authenticate Adyen payment devices and APIs.

Authorizations:
newStoreAccessToken
Request Body schema: application/json
company
required
string non-empty

The company part of the User Name configured in Adyen. If the Adyen User Name is ws_12345@Company.Example then the company is Company.Example.

username
required
string non-empty

The user part of the User Name configured in Adyen. If the Adyen User Name is ws_12345@Company.Example then the username is ws_12345.

password
required
string non-empty

The password configured in Adyen.

account
required
string non-empty

The Adyen merchant account to be used as the default.

Responses

Request samples

Content type
application/json
{
  • "company": "Company.Example",
  • "username": "ws_12345",
  • "password": "password",
  • "account": "Example_POS"
}

Update credentials for Adyen payment devices and APIs for the specified merchant account

Updates the set of credentials used to authenticate Adyen payment devices and APIs for the specified merchant account.

Authorizations:
newStoreAccessToken
path Parameters
merchant_account_id
required
string

The Adyen merchant account identifier for which to update credentials.

Request Body schema: application/json
company
required
string non-empty

The company part of the User Name configured in Adyen. If the Adyen User Name is ws_12345@Company.Example then the company is Company.Example.

username
required
string non-empty

The user part of the User Name configured in Adyen. If the Adyen User Name is ws_12345@Company.Example then the username is ws_12345.

password
required
string non-empty

The password configured on Adyen.

Responses

Request samples

Content type
application/json
{
  • "company": "Company.Example",
  • "username": "ws_12345",
  • "password": "password"
}

Update credentials for Adyen webhooks

Updates the set of credentials used to authenticate Adyen webhooks.

Authorizations:
newStoreAccessToken
Request Body schema: application/json
username
required
string non-empty

The username configured on Adyen.

password
required
string non-empty

The password configured on Adyen.

Responses

Request samples

Content type
application/json
{
  • "username": "username",
  • "password": "password"
}

Update credentials to authorize Adyen webhooks

Updates the set of credentials used to authorize the Adyen webhooks.

Authorizations:
newStoreAccessToken
Request Body schema: application/json
hmac
required
string

The secret HMAC key used to sign notifications.

Responses

Request samples

Content type
application/json
{
  • "hmac": "someHMACkey"
}

Update credentials for Adyen webhooks for the specified merchant account

Updates the set of credentials used to authenticate the Adyen webhooks for the specified merchant account.

Authorizations:
newStoreAccessToken
path Parameters
merchant_account_id
required
string

The Adyen merchant account identifier for which to update notification credentials.

Request Body schema: application/json
username
required
string non-empty

The username configured on Adyen.

password
required
string non-empty

The password configured on Adyen.

Responses

Request samples

Content type
application/json
{
  • "username": "username",
  • "password": "password"
}

Update credentials for Adyen webhooks for the specified merchant account

Updates the set of credentials used to authorize the Adyen webhooks for the specified merchant account

Authorizations:
newStoreAccessToken
path Parameters
merchant_account_id
required
string

The Adyen merchant account identifier for which to update notification credentials.

Request Body schema: application/json
hmac
required
string

The secret HMAC key used to sign notifications.

Responses

Request samples

Content type
application/json
{
  • "hmac": "someHMACkey"
}