Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This guide teaches you how to:

  • Client Login as client user to Prepaid Technologies platform

  • Get Customer customer list

  • Get Customer customer program list

  • Registering Cardcard

  • Search card account

Before you get started

...

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

    API’s

    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(customerIdparentId) from the response received from the getCustomerListByParent 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.NOTE: This API will return all client/customer’s set up under the Parent.

<TODO - Step 3 to 5>

Step 3: Get Customer program list

...