Card Management APIs
Thredd offer flexible and granular card management APIs to help you to create and manage the cards in your programme. See:
Cardholder Controls
You can use our API to allow your customers to take control over their card (using your mobile phone app or their online account), and perform actions such as:
-
Activate and deactivate a card
-
View transactions on a card
-
Get the latest card balance
-
Freeze and Unfreeze a card
-
Block a card
-
Order a replacement card
-
Transfer funds between cards
-
Order replacement cards
Types of API
We offer two main types of API:
-
SOAP-based Web Services — API that use the SOAP standard and exchange messages in XML format.
-
REST-based Cards API — API that use REST-based principles and exchange messages in JSON format.
Which API should you use?
Both API offer similar functionality for creating and managing cards. Our traditional SOAP-based Web Services provide a stable and mature API platform. Our new REST-based cards API are a more modern and flexible API, with new features being added all the time.
Note that over the longer-term, the Cards API will become the main API of choice for customers. Please check with your Implementation Manager for the best match for your current business requirements.
Integrated API
For your Customer Services staff who want to perform certain actions on cards, we provide an interface to our systems via the Thredd Portal. No need for you to develop your own interface. See Thredd Portal.
For developers who want to submit test transactions, you can use the Card Transaction System (CTS).
API Endpoints
Below are some of the card features that can be controlled via our API endpoints.
Card Creation |
Card Activation and Loading of Funds |
Card Management |
---|---|---|
Create cards |
Card activate or deactivate |
Change card status (e.g., Freeze /Unfreeze) |
Bulk create cards |
Card load or unload funds (to reflect balance changes) |
Change PIN |
Create virtual or physical card |
Card balance adjustments |
Update cardholder details (e.g., name and address), |
Create Master Virtual Card (MVC) |
Card balance enquiry |
Renew expiring cards |
Convert cards from virtual to physical |
Transfer funds between linked cards |
Retrieve card details |
API operate on a Card level, and can be applied to a specific card record in the system. If you require an option to span across all or multiple cards, this can be set up for your card product on our systems.
We also offer compound APIs, which combine the functionality of several API endpoints into a single API call. For example, you can create a card and activate and load it with funds at the same time.