API Onboarding Process (See Diagram)

Definitions/Terminology

• PT API Platform - a set of services and applications made up of the PT Developer Portal, PT Program Dashboard, and APIs.

• APIs – a combination of application program interface modules used to send and receive data to/from our systems.

• PT Developer Portal – the portal used to control and manage the APIs. This includes documentation about each API as well as instructions on how to use the APIs. This portal is primarily designed to provide your technical team with the information they need to use the APIs and access to the test Sandbox.

• PT Program Dashboard – a portal where your prepaid program (i.e., Paycard, Corporate Disbursement) will be configured. This portal also serves as the user interface your company will use to view and manage your prepaid program(s).

• Login Credentials – the user name / password used to access the PT Program Dashboard. This is the same user name / password that will be used to obtain the prepaid program data needed for various APIs (see One Time Setup Instructions).

• Subscription Key – used as a security parameter to call the PT APIs. The key is provided when calling the login API with the provided credentials.

Below is an overview of steps required to integrate with us using our APIs.

1. Client Agreement – a client agreement needs to be executed before we can work together. This agreement specifies the prepaid products your business plans to use as well as each parties’ obligations, including terms associated with using the APIs. Contact a member of our sales team if you have not completed this step.

2. Request Access to the PT Developer Portal – as a part of this process you will be asked to complete an API request form describing your companies desire to leverage our APIs.

3. Consultation – a member of our implementations & integration team will reach out to you once the API request form is completed and submitted. You will be issued access to the PT Developer Portal during this process. As a part of this process, we will confirm which prepaid products you need and describe how our APIs can be leveraged to meet your needs. Once you have access to the PT Developer Portal you can access all API documentation and details on how to use the APIs in both our sandbox and production environments.

4. Program Set Up & Onboarding – Next, our implementations & integration team will configure the prepaid program(s) for your company. During this process, you will be issued login credentials to obtain prepaid program ID’s as well as access the PT Program Dashboard. Once you have access to the APIs, you should get your subscription keys and related program ID’s. This data will be required to use the APIs. See the sections below called one time setup Instructions and storing your keys and id’s.

5. Sandbox Testing – once you are complete with your understanding of the APIs and development, you can test using the sandbox environment.

6. Production – when you are done developing and testing in the sandbox environment you will get access to production environment.

One Time Setup Instructions

The below steps are required to be executed before any of the APIs can be used. These steps will provide you with the necessary, static data required to use various APIs. This data should be stored in a secure location (see Storing Your Keys and ID’s). This will need to be executed one time in the sandbox environment and one time in the production environment given the prepaid program ID’s will be different for each environment.

Step 1: Authenticate to our environment with the "login" API. (see API Solutions for more details)

Use the login credentials provided by Prepaid Technologies (in step 4 above) and execute the “login" API. Once executed and authenticated, you will be provided with a business ID that should be stored in a secure location for future use with the APIs.

• API Name = "login"

• Post request to URI - https://{environment}/api/User/v1/login

• Pass the provided subscription key to the Ocp-Apim-Subscription-Key parameter and the username and password to the request body.

• Retain the response parameter below, it will be needed for subsequent API calls:

  • businessId

Step 2: Get the Program ID, Funding ID, and Product ID from our "getProgramsList" API.

(Note: If you are a group client you will need execute the getBusinessesList API to retrieve child businessId's to use in the getProgramList API below. Please store businessId's in a secure location for later use.)

• API Name = "getProgramsList"

• Post request to URI - https://{environment}/api/Program/v1/getProgramsList

• Pass the provided subscription key to the Ocp-Apim-Subscription-Key parameter and the businessID in the request body.

• This API will return program profile information.

• Retain the response parameters as they will be needed for subsequent API calls:

  • programId

  • fundingId

  • productId

Storing your Keys and ID's

You should create a secure location to store subscription keys and prepaid program ID's. Prepaid Technologies suggests a password secured encrypted vault that uses a two-factor authentication method for access. This type of storage is available through several 3rd party providers. During the implementation phase we can discuss options with you if you have questions.

The following Keys and ID's should be stored in your vault to help simplify access to Prepaid APIs.

• Subscription key

• Username and password

• Business ID's

• Program ID's

• Funding ID's

• Product ID's

Know the Environments

There are two environments: sandbox and production. Sandbox is a test environment that simulates the production environment without dealing with real money or sensitive personal data.

Sandbox: https://sandbox-api.in-prepaid.com

Production: https://api.in-prepaid.com

This guide assumes you're using sandbox. When you have received approval to start validating your program in production, simply swap out the URL and API keys.