Introduction

Welcome to PT API. It is Prepaid Technologies' end-to-end platform that makes it simple to create digital banking and branded card experiences. This documentation includes comprehensive information for building financial products and integrating with PT API.

...

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 Design Guidelines

Allowed HTTP methods with PT APIs

1. GET
   The GET method is used to retrieve information from the given server using a given URI. Requests using GET should only retrieve data and should have no other effect on the data.

2. POST
   A POST request is used to send data to the server.

3. PUT
   Replaces all current representations of the target resource with the uploaded content.

4. DELETE
   Removes all current representations of the target resource given by a URI.

Standard PT API Query parameters

Paging

limit/offset parameter enables pagination for the client application. PT supports Offset Pagination implementation. Limit/Offset Paging would look like GET /cards?limit=20&offset=100. This query would return the 20 rows starting with the 100th row.
Example of pagination with 20 cards in each call:-

• A client makes a request for the most recent cards: GET /cards?limit=20

• On scroll/next page, client makes second request GET /cards?limit=20&offset=20

• On scroll/next page, client makes third request GET /cards?limit=20&offset=40

Filtering

Filtering consists in restricting the number of queried resources by specifying some attributes and their expected values.
URL parameters is the easiest way to add basic filtering to REST APIs. If you have an /cards endpoint, you can filter via the property name such as GET /cards?status=active or GET /cards?status=active&expDate=12242021

Sorting

Sorting the result of a query on a collection of resources. A sort parameter should contain the names of the attributes on which the sorting is performed, separated by a comma.

Glossary

About the Platform

...