Introduction
...
The fastest way to get your integration up and running is to use our Quick Start guide, which walks you through the essential integration steps. We've tried to make this documentation user-friendly, but if you have any questions, please head to our Discord Server. <TODO - setup the server>
...
API Protocols
The PT API uses GET and POST requests to communicate and HTTP response codes to indicate status and errors. All requests must include a Content-Type of application/json and the body must be valid JSON. All responses are in standard JSON.
API Design Guidelines
Allowed HTTP methods with PT APIs
...
GET /cardholders?q=firstName:joe AND age:[20 TO 30]
...
PT APIs Status Codes
200 – OK
Everything is working
201 – CREATED
A new resource has been created
204 – NO CONTENT
The resource was successfully deleted, no response body
304 – NOT MODIFIED
The date returned is cached data (data has not changed)
400 – BAD REQUEST
The request was invalid or cannot be served. The exact error should be explained in the error payload. E.g. „The JSON is not valid “.
401 – UNATHORIZED
The request requires user authentication.
403 – FORBIDDEN
The server understood the request but is refusing it or the access is not allowed.
404 – NOT FOUND
There is no resource behind the URI.
500 – INTERNAL SERVER ERROR
This is a generic error response with no details. If an unhandled error occurs on the server-side then the stack trace will be logged and not returned as a response.
...
PT API is built on the Prepaid Technologies Platform, which processes millions of dollars of payments annually and inherits all scalability, reliability, and security features of the Prepaid Technologies platform.
Digital Banking
Cardholders need a way to manage their accounts. This includes viewing balances, tracking spending, and accessing monthly statements. Digital banking is how we describe any user interface that provides these functions for cardholders.
PT API Components
Four components of PT API product are below :
...
Prepaid Technologies creates a master funds account for every business that enrolls in PT API. This account can be used to instantly fund cardholder accounts, enabling a wide variety of product use cases.
...
The PT API uses GET and POST requests to communicate and HTTP response codes to indicate status and errors. All requests must include a Content-Type of application/json and the body must be valid JSON. All responses are in standard JSON.
Digital Banking
Cardholders need a way to manage their accounts. This includes viewing balances, tracking spending, and accessing monthly statements. Digital banking is how we describe any user interface that provides these functions for cardholders.
...
Parent-Client Hierarchy
To manage the card programs for clients using the Prepaid Technologies platform, a parent client hierarchy is created. There are two business models to support client requirements.
Business Model 1
It has 3 general levels as explained below:-
Group Level - This represents the complete client business or corporation. The client admin users will have direct access to this hierarchy level. In the PT system, this is identified with
parentId.Client Level - This represents the individual client business units. So a corporation can have multiple business units known as “Client”. In the PT system, this is identified with
customerId.Program Level - This represents financial products like gift cards, rewards, payroll, etc. So a business unit can have multiple enrollments to financial products known as “Program”. In the PT system, this is identified with
rowed.
...
Business Model 2
It has 2 general levels as explained below:-
Client Level - This represents the individual client business units. So a corporation can have multiple business units known as “Client”. In the PT system, this is identified with
customerId.Program Level - This represents financial products like gift cards, rewards, payroll, etc. So a business unit can have multiple enrollments to financial products known as “Program”. In the PT system, this is identified with
rowed.
...