On This Page
Custom Card Read
Use the information in this section to obtain data from custom cards such as gift cards,
loyalty program cards, and employee cards when the app is in Local mode. This service
cannot be used to perform payment functions.
IMPORTANT
Custom Card Read is supported for non-PCI cards
only. To use this service, the card type must be on your allowlist. To add a card type
to your allowlist, contact your implementation manager.
To retrieve the card data, swipe the card’s magnetic stripe through the payment device.
The custom card read-only function reads and returns the raw card identifier to your app
or point-of-sale (POS) system. You can then use the raw data within your app or POS
system.
These are examples of how you might use the Custom Card Read feature:
- Custom gift card:Use the card number to check a balance or process a payment in your private gift card network.
- Employee card:Use the card number to look up an employee's profile or account.
Endpoints
The endpoint is the same for the test and production environments.
Test:
wss://{terminal IP address:port number}/
Production:
wss://{terminal IP address:port number}/