Set up on the Test Environment


  • Make sure you have completed your Product Setup Form to enable us to configure your programme-specific Thredd setup.
  • Enable us to exchange security keys between Thredd and your card manufacturer so that we can generate the PAN stock in our systems, which is required to create physical cards.



For project scoping and scheduling information, contact your Thredd Implementation Manager and refer to the following Thredd documentation: Project Initiation Document (PID), Project Scoping Document (PSD) and Project Requirements Document (PRD).

Step 1: Get Access to our UAT Environment

Ensure you have secure access to all the required Thredd systems:

  • Provide Thredd with a list of IP addresses allowed to use the API.
  • Some clients may require VPN access to Thredd to use the API.
  • Ensure you have the required user credentials and codes needed to submit API requests:
    You need a username and password, which must be included in the authorisation header of your API request. Your Implementation Manager will provide you with your credentials.
  • You will need an Issuer Code, supplied by Thredd. This must be included in the body of your API request.



When Thredd has set you up with access to the test system, we recommend you start with a simple check of the status of the API to make sure you can connect. See Service Status Check.

Step 1.1. Access to the Thredd generic test product

Thredd will provide you with access to a generic Thredd UAT product setup (test environment), shared to all of our clients, where you can start exploring the API. The test product setup provides a restricted set of card functionality, which enables you to perform basic actions such as: create and load cards, manage PINs, change card status and change card velocity groups. This includes a link to the UAT URL.

Step 1.2. Access to your own dedicated setup

Thredd configures your dedicated programme on the test environment, with unique credentials, based on the details agreed in your Product Setup Form (PSF). At this stage transactions are managed within the test environment and not via the card scheme network.

Step 2: Test your Integration

Decide which API calls you need. This depends on the Thredd External Host Interface (EHI) mode you are using. For example:

  • If you are set up for EHI mode 1 and 4, you mainly use the API related to card creation, card management and authorisation.
  • If you are set up for EHI modes 2 and 3, you may need to use other API for updating the balance on the card.

When you have selected your mode:

  • Test your EHI integration. For more information, see the External Host Interface section.
  • Submit test API call transactions to the Thredd test system. See API Explorer. View the results and fix any errors.

When you are satisfied that you understand how the API works, build your front-end user application with the API functionality included.

Step 3: Create CHIP Profile and White Test Plastics

Create test card tokens and generate white test plastics. These are generic, non-branded cards with test keys on the card. Your Implementation Manager will work with your card manufacturer to produce test cards:

  • Thredd generates a card file for any test cards that have been created and manually sends to the card manufacturer.
  • The card manufacturer produces white test plastics in line with the agreed project plan. Test cards are sent to the relevant parties (e.g. the Program Manager and Visa or Mastercard).
  • Testing is undertaken in line with the agreed scope.