Prepaid Technologies API Platform.
The PT Developer Portal provides a complete set of JSON based APIs which can be used to duplicate the features of our PT Prepaid Program Dashboard. The PT API Platform can be used to power any proprietary expense management or business payment application and create a seamless payment experience for your users.
Note: You must have a PT Prepaid Program Dashboard account in order to use the API's
See steps below to learn how to use the PT API Platform.
One time APIs are used to authenticate and retrieve subscription keys and program ID's. The Keys and ID's should be stored for reuse when accessing card and account management APIs listed below.
Login API - User ID and Password are provided by PT Implementations after a consultation and used as parameters to access the login API. The Login API will return the subscription key and a business ID used to get the program information for your business.
GetBusinessesList API - When your setup involves child/sub-clients, use this API to retrieve child business IDs. The business IDs returned should be stored and used to obtain all associate child/sub-client IDs. If you have one single program/client, move to step 3.
GetProgramsList API - Used to return a list of all the program profile information about the business or businesses. Responses returned include program ID, product ID, funding ID, product type, and sub program ID.
Storing ID's and Keys - Subscription Key, Business ID, Program ID, Product ID, and Funding ID should be stored per business. The Prepaid security team recommends an internal secure vault or repository for storage.
Card Management API's
Order Card
orderCard
Order one or more personalized cards for specific users at any valid location. Digital and Physical cards are available.
Order Instant Issue Card
orderInstantIssueCard
Order instant issue card.
Register Card
registerCard
Register one or more cards to allow access to the funds for the users. Note: All registration information will remain confidential.
Load Card
loadCard
Load funds to a card. Card funding is real-time and will update the card balance immediately.
Unload Card
unloadCard
Manage money on a specific card by moving funds back to your company funding source. cardholder balance is updated immediately.
Get Business List
getBusinesseslist
Return's the business profile information including address, phone and initial profile account setting information based on the respective business Id.
Get Program List
getProgramslist
Return the program profile information including productType, fundingId, initial profile information based on the programId.
Funding Management API's
Get Funding Account
getFundingAccount
Return the funding / virtual account information based on the businessId.
Get Funding Account Balance
getFundingAccountBalance
Get funding / virtual account balance based on fundingId.
Get Funding Account History
getFundingAccountHistory
Get account history of specific funding account by startDate and numberOfDays.
Transfer Funds
transferFunds
Transfer funds between virtual accounts.
Card Holder API's
Get Card Balance
getCardBalance
Returns the current balance of a card.
Get Card Holder Info
getCardHolderInfo
Return the cardholder profile information including residential, shipping address, phone and initial contact information.
Get Card Info
getCardInfo
Return the card and cardholder information based on program id and proxy or card number.
Change Pin
changePin
Change the 4-digit PIN associated with a card.
Change Card Status
changeCardStatus
Change card status to [Active, Suspend, Unsuspend, or Lost].
Get Card Statement Detail
getCardStatementDetail
Returns card detailed statement based on statementID which is returned from getStatementList.
Get Statement List
getStatementList
Returns a list of statement Id's and closing dates. This information can be used to look up card statement details using getCardStatementDetail
Get Card Transaction History
getCardTransactionHistory
Returns a list of transaction history based on the card information and number of days provided.
Replace Card
replaceCard
Two options are provided:
1. Replace with a new card and ship to user.
2. Replace with an instant issue card.
Update CardHolder Info
updateCardHolderInfo
Update the cardholder profile information. (Name, phone, ssn, DoB, Address, etc).