Skip to end of metadata
Go to start of metadata

You are viewing an old version of this content. View the current version.

Compare with Current View Version History

« Previous Version 3 Next »

This guide teaches you how to:

  • Login as client user to Prepaid Technologies platform

  • Get customer list

  • Get customer program list

  • Registering card

  • Search card account

Before you get started

  • You must have an environment set up to send HTTP requests, such as Postman, cURL, or a script. Click the button below to download our Postman collection.

    • <TODO - generate the Postman collection>

  • You must subscribe to the product using the Developer Portal.

  • You must obtain the Primary key and Secondary key from the Developer Portal.

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.

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.

Sandbox

https://pt-api.azure-api.net

Instructions

Step 1: Authenticate

Use the Login credentials provided by Prepaid Technologies and login to the Prepaid API system.

  • EndPoint - login

  • Post request to URI - https://portal.in-prepaid.com/_ah/api/userendpoint/v1/login

  • Pass User Identification(Username) to the loginID parameter and User password to password parameter.

  • After a successful login, a session(sessionId) is created for the logged-in user and is authenticated to access the authorized APIs.

  • Link to the API: Login API

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

    • sessionId

    • customerId

  • Also, refer to the screenshot below for a successful call.

Step 2: Get the Customer list by Parent.

  • EndPoint - getCustomerListByParent

  • Post request to URI - https://prepaid-portal.appspot.com/_ah/api/customerendpoint/v1/getCustomerListByParent

  • Pass Session Identifier(sessionId) and Customer Identifier(parentId) from the response received from the Login API in step 1.

  • Use the Customer Identifier from Login API as the Parent Identifier in the input for the API.

  • This API will return all client/customer’s set up under the Parent.

  • Refer to the screenshot below for a successful call returning one client/customer.

<TODO - Step 3 to 5>

Step 3: Get Customer program list

  • If more than one client/customer was returned in the above API (getCustomerListByParent), then identify the client/customer parameters required for subsequent API calls.

  • Pass Session Identifier(sessionId) and Customer Identifier(customerId) of the client/customer from the response received from the above API (getCustomerListByParent).

  • Filter your customer programs based on your filter criteria based on the below parameters. You can pass the default value as true

    • showAutoCreated

    • showBranded

  • Link to the API: Get Customer Program List

  • Reatin the response parameters which will be needed for subsequent API calls:

    • rowId - (Which is also called cpId or custProgId)

    • clientId

    • fundingId

  • Also, refer the screenshot below for a successful call.

  • NOTE:  This call will return all Programs associated with the customerId used for input. In most cases you will only have one Program, but there are situations where multiple Programs could be configured. Consult with your PT program manager for direction on the Programs that are set up for each client/customer.

Step 4: Registering cards:

Note: This process assumes cards have already been ordered and are present at the time this API is used.
Note: Please follow Steps 1-3 to have the required input parameters for further calls.

  • Have Proxy Number(proxyKey) or PAN Number(panNumber) ready to pass for the cards to register.

  • Further, you can Register cards as per the requirement,

    • Single Card

    • Multiple Cards

  • In case of registering multiple cards use orderDetails parameter and pass the list of proxyKey or panNumber respectively.

  • If a single card is registered, then you get a response orderId instantly, in case of multiple card registration, our processor, FIS, could take some time to confirm the registration process.

  • Tip: orderDetails should be passed as per the requirement to register single or multiple cards.

  • Please refer the API documentation, https://prepaid-uat-portal.appspot.com/api-docs/index.html#/Order_Management_APIs/registerCards

Step 5: Searching and obtaining account details (including Direct Deposit Account information)

 Note: Please follow Steps 1-3 to have the required input parameters for further calls.

  • Pass Session Identifier(sessionId) and Customer Program Identifier value to cpId parameter or Pass Client Identifier value to clientID parameter - You can pass any value based on the requirement. One of the following is mandatory.

  • You can pass any one of the following parameters based on your search requirement

    • Pass Proxy number value to the proxyKey parameter

    • Pass Card number value to the cardNum parameter

    • Pass First Name value to the first parameter

    • Pass Last Name value to the last parameter

    • Pass Social Security Number value to the ssn parameter

  • Link to API: Search Account

  • Please refer to the following screenshots for sample calls.

  • No labels