Connect your instance

Payment Services is powered by Commerce Services and deployed as SaaS (software as a service). You connect your Commerce instance using an API key and a private key, and specify the data space in the configuration using the Commerce Services Connector. You set up this connection only once.

  • If you have already connected your instance, by obtaining and using your API credentials and configuring Commerce Services, you can proceed to setting up your testing sandbox.
  • If you still need to connect your instance, see the information in this topic about obtaining API credentials and configuring Commerce Services.
  • If you are unsure whether your instance is connected, navigate to System > Services > Commerce Services Connector and view the public and private API key values in the Sandbox Keys and Production Keys sections, and the Project and Data Space fields in the SaaS Identifier section. If those values are present, then your instance is connected.

Obtain API credentials

To consume a Commerce SaaS service, you must use your instance’s API keys (Commerce public API key and a private key) for both sandbox and production, which are created and managed in your My Account Dashboard. The key pair can be created for a Commerce account—one for sandbox and one for production—though only one pair can be actively used at a time.

NOTE

Need help with accessing your My Account dashboard? See Create a Commerce account.

A public API key, once created, is always available in your My Account Dashboard. It can be copied or deleted as needed. The private API key becomes visible when you create a public API key for either sandbox or production; it is only available for copying or saving from the ensuing dialog box and cannot be accessed later.

A given API key pair is valid for all Commerce Services in an environment, so if you already have Commerce Services configured for your instance, your API key pair is already present in the Commerce Services Connector.

If your API key is lost, a new API key pair must be generated and applied to the Commerce Services Connector configuration in the Admin. If the wrong keys are configured or none exist in the config, an account verification error dialog appears in Payment Services notifying you that the account was not verified.

See a list of available Commerce Services that use the API.

To learn how to generate an API key for either sandbox or production environments, see Credentials.

IMPORTANT

It is recommended that you do not regenerate an API key pair and change the SaaS identifier and/or data space on an active production instance. You will lose data for your instance if they are modified.

Configure Commerce Services

The same API key can be used across instances, but each instance must have its own SaaS Data Space.

Now that you have obtained your credentials, you can configure your SaaS project and Saas Data Space.

  1. On the Admin sidebar, go to Sales > Payment Services.

  2. Click Configure Commerce Services.

    This option is visible if you have not yet configured Commerce Services for your account.

    You are directed to the configuration area in the Admin, Stores > Settings > Configuration > Commerce Services Connector, to configure your Commerce Services Connector.

  3. To configure your Commerce Services, follow the steps described in SaaS configuration.

On this page