Features (Developer Portal)

Register a Single Card

Objectives

This feature enables the client to implement the card registration process for a single card. To register the card the cardholder information is needed with the Proxy number (proxyKey) or PAN number (panNumber) ready to pass for the card to be registered. This process will return the orderId instantly for the single card that is registered.

User personas

1. Reloadable Cards

2. Cards valued over $1,000

3. ATM withdrawals needed

PT APIs to support this feature

• Login with Client user

• Call getCustomerProgramList to get the customerProgramId

• Call registerCards to execute the card registration process and get the orderId

Open

Need help

Please use the Postman script to call this process in the PT sandbox environment. Click the button below to download our Postman collection.

• <TODO - generate the Postman collection>

Some history

Registration of card is required by Federal Law if the card is reloadable, allows for ATM withdrawals, or was issued with a value greater than $1,000. Cards valued over $1,000 cannot be used until the registration information is provided. A card cannot be reloaded and/or its ATM PIN will not be active for ATM withdrawals until the cardholder registers his/her card. All registration information will remain confidential and not be resold or used for any marketing purposes.

Constraints

This process assumes cards have already been ordered and are present at the time this API is used.

Releases

Next steps

Register Multiple Card

Objectives

This feature enables the client to implement a bulk registration process for multiple cards together. To register multiple cards, cardholders' information is needed with the list of Proxy numbers (proxyKey) or PAN numbers (panNumber) ready to pass for the cards to be registered. This process will return the list of orderIdfor multiple cards that are registered.

User personas

1. Reloadable Cards

2. Cards valued over $1,000

3. ATM withdrawals needed

PT APIs to support this feature

• Login with Client user

• Call getCustomerProgramList to get the customerProgramId

• Call registerCards to execute the card registration process and get the list of orderId

Open

Need help

Please use the Postman script to call this process in the PT sandbox environment. Click the button below to download our Postman collection.

• <TODO - generate the Postman collection>

Some history

Registration of card is required by Federal Law if the card is reloadable, allows for ATM withdrawals, or was issued with a value greater than $1,000. Cards valued over $1,000 cannot be used until the registration information is provided. A card cannot be reloaded and/or its ATM PIN will not be active for ATM withdrawals until the cardholder registers his/her card. All registration information will remain confidential and not be resold or used for any marketing purposes.

Constraints

This process assumes cards have already been ordered and are present at the time this API is used.

In multiple card registration, our processor could take some time to confirm the registration process.

Releases

Next steps

Order Inventory

Objectives

This feature enables the client to order instant issue cards or personalized card inventory by specifying the number of cards that will be shipped to the specified address. To order the personalized cards, orderDetails object needs to be provided. This process will return the order status with the card object/s.

User personas

1. Instant Issue Cards

   1. Instant Issue Payroll Order,

   2. Personalized Payroll Order,

   3. Reloadable-Corporate Reward Order,

   4. Non-Reloadable-Corporate Reward Orde,

   5. Instant Corporate Reward Order,

   6. Direct Order - CORP

2. Personalized Cards

PT APIs to support this feature

• Login with Client user

• Call getCustomerProgramList to get the customerProgramId

• Call orderCards to execute the card registration process and get order status

Need help

Please use the Postman script to call this process in the PT sandbox environment. Click the button below to download our Postman collection.

• <TODO - generate the Postman collection>

Some history

Constraints

The order for multiple personalized cards may take some time to be placed with the processor hence the details might not be visible immediately.

Releases

Next steps

Service Cards

Objectives

This feature enables the client to search and manage cardholders and cards under their customer program.

User personas

1. Cardholder Management Portal

2. Augment existing Client applications

PT APIs to support this feature

• Search card - /searchAccount

• Search cardholder - /searchAccount

• Cardholder Information - /getCardHolderInfo

• Edit Cardholder Profile - /updateCardHolderInfo

• Load Card - /loadCard

• Unload Card - /Unloadcardbyproxy

• Duplicate Card - /replaceCard

• Change Card Status - /changeCardStatus

• Load History - /getTxnHistory

Edit Cardholder Profile

Load Card

Unload Card

Change Card Status

Load History

Need help

Please use the Postman script to call this process in the PT sandbox environment. Click the button below to download our Postman collection.

• <TODO - generate the Postman collection>

Some history

Many clients need an interface to manage their cardholders and cards. This feature is focused to provide the basic functionality to manage the cardholders and cards.

Constraints

Client user session Id is needed to perform these API calls. So login call need to be done before these API calls.

Releases

Next steps