Overview

A merchant can use the REST 2.0 API Credentials Report to generate, rotate, and manage API keys.

The REST 2.0 API Credentials Report is available to a Control Panel user with the ‘Developer only’ role or the ‘Temp’ role, regardless of whether the user has Admin permissions.

For information about API keys, see Authentication.
For information about Nuvei REST API 2.0, see REST 2.0 (Beta Release).

API Keys

An API key is a secure identifier that authenticates a REST 2.0 API request. If a merchant makes a request, the merchant includes the API key in the request header to validate the identity and permissions of the calling system. Multiple API keys can be generated per entity ID and site name pair, allowing merchants flexibility in key rotation, security separation, and operational management.

Behavior of API Keys

Each parent entity or child entity displays its own API key (only), if defined.
A parent key is not displayed within a child entity view and cannot be edited from within a child entity.
If a child entity does not have an API key, then the child entity automatically inherits the parent API key.

Supported Types of API Keys

The user-interface supports the following types of API keys:

Operations API Key – For payments, disputes, and data-related operations.
Dispute API Key – For authentication of dispute-related endpoints provided by Nuvei.

REST 2.0 API Credentials Report

The following information appears in the REST 2.0 API Credentials Report:

Parent Entity ID

For ease of API key management of multiple entities under a single parent organization, if an API key is generated for a parent entity ID, all child entities of the parent receive the same API key.
Entity ID – A unique identifier for a merchant account or business entity in the Nuvei system.
Site Name – Name of a specific site or platform associated with the API key.
API Key – Unique API key associated with a specific entity ID and site name. A merchant can create and use multiple keys for different purposes, and can determine which key to use for processing.

Actions

The following actions can be performed in the REST 2.0 API Credentials Report:

Generate an API key – To generate an API key for a corresponding entity ID and site name pair, press the button.
Copy an API key for processing – After generating multiple keys for an entity ID and site name pair, a merchant can copy the relevant API key for use as per processing requirements. Each API key can be associated with a specific site or entity, enabling flexibility and the control of which API key to use for each transaction.