Add an API credential

POST {{baseUrl}}/companies/:companyId/apiCredentials

Creates an API credential for the company account identified in the path. In the request, you can specify which merchant accounts the new API credential will have access to, as well as its roles and allowed origins. The response includes several types of authentication details: * API key: used for API request authentication. * Client key: public key used for client-side authentication. * Username and password: used for basic authentication. > Make sure you store the API key securely in your system. You won't be able to retrieve it later. If your API key is lost or compromised, you need to generate a new API key. To make this request, your API credential must have the following roles: * Management API—API credentials read and write

Request Body

{"roles"=>["Checkout webservice role"], "allowedOrigins"=>["https://www.mystore.com"], "associatedMerchantAccounts"=>["{{YOUR_MERCHANT_ACCOUNT}}_AU", "{{YOUR_MERCHANT_ACCOUNT}}_EU", "{{YOUR_MERCHANT_ACCOUNT}}_US"]}

HEADERS

RESPONSES

status: OK

{"id":"YOUR_API_CREDENTIAL","username":"YOUR_USERNAME","clientKey":"YOUR_CLIENT_KEY","allowedIpAddresses":[],"roles":["Checkout webservice role"],"active":true,"allowedOrigins":[{"id":"YOUR_ALLOWED_ORIGIN","domain":"https://www.mystore.com","_links":{"self":{"href":"https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL/allowedOrigins/YOUR_ALLOWED_ORIGIN"}}}],"_links":{"self":{"href":"https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL"},"allowedOrigins":{"href":"https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL/allowedOrigins"},"company":{"href":"https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT"},"generateApiKey":{"href":"https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL/generateApiKey"},"generateClientKey":{"href":"https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL/generateClientKey"}},"apiKey":"YOUR_API_KEY","password":"YOUR_PASSWORD","associatedMerchantAccounts":["YOUR_MERCHANT_ACCOUNT_AU","YOUR_MERCHANT_ACCOUNT_EU","YOUR_MERCHANT_ACCOUNT_US"]}