Authentication and Credentials

On this page:

Overview

All Opayo PI requests are made using HTTPS and must be authenticated. We use HTTP Basic authentication, which is a simple and secure method of enforcing access controls.

Important: All requests are made using HTTPS to ensure the security of your customers’ sensitive information.

Important: When connecting to Opayo's servers, an SSL handshake will take place. Normally, this will go smoothly, but before going live with any integration, you must to check that you have the latest root certificates for Opayo's certificate issuing authority installed on your servers.You can obtain the latest root certificate from here.

Installing this certificate can differ according to your website and your hosting solution, but a good place to start is here or this site.

If you need further help configuring your SSL certification chain, you can contact support@opayo.io.

Pi Credentials

You will find your Pi credentials in your account on MySagePay. If you don't have credentials yet, you can use a sandbox account available for our test environment.

Credentials are specific to the test or live environments. When you encounter a problem connecting with an environment, check that you are using the correct credentials.

Important:

  • When you create new credentials, they immediately render all existing credentials invalid.
  • You must replace your expired credentials with the new ones in any integration with our REST API, or your calls will not be authorised.
  • You must record and save your new credentials securely.
  • Pi credentials do not work for any legacy or alternative integration methods.

Retrieve Your Integration Key and Password

Before integrating with Pi or accessing our TEST environment or LIVE environment, you must follow these steps to retrieve your Integration Key (username) and Integration Password:

  1. Sign in to your MySagePay Administrator account. Use the credentials provided during your account setup.
  2. On the Administrator tab, in the Password details section, check the disclaimer box.
    Note: You are agreeing that by creating new credentials, your existing Opayo API implementations may not function before you replace your legacy credentials in them with the new credentials.
  3. Click Create API credentials.
  4. Record, save, and secure the:
    • Environment. This is the Test or Live environment the credentials apply to.
    • Vendor Name. The vendorname for the account.
    • Integration Key. The value for the Integration key (your username).
    • Integration Password. The value for the Integration password.