Overview
The List Saved Cards endpoint retrieves all saved cards for a specific customer identifier. This endpoint returns only safe, tokenized card information without exposing sensitive details like full card numbers. Use this endpoint to display saved payment methods to customers, allowing them to select from their previously saved cards for faster checkout experiences.Key Features
🔍 Safe Card Display
- Returns masked card numbers (e.g.,
XXXXXXXXXXXX0003
) - Shows only non-sensitive card metadata
- No exposure of full card numbers or CVV
🎯 Filtered Results
- Filter by customer identifier
- Returns only cards belonging to the specified customer
- Organized, easy-to-parse card information
💳 Complete Card Context
- Card network and type information
- Expiry dates for validation
- Custom nicknames for easy identification
- Cardholder names for verification
Required Parameters
Parameter | Type | Location | Description |
---|---|---|---|
identifier | string | Query | Unique identifier for the card owner (customer ID, user ID, etc.) |
Response Format
The API returns an array of saved card objects, each containing:Field | Type | Description |
---|---|---|
card_token | string | Unique token for the saved card |
identifier | string | Customer identifier |
cardholder_name | string | Name on the card |
nickname | string | Custom card nickname (may be empty) |
card_type | string | Card type (CREDIT, DEBIT, PREPAID) |
network | string | Card network (VISA, MASTERCARD, etc.) |
masked_pan | string | Masked card number showing only last 4 digits |
expiry_month | integer | Card expiry month (1-12) |
expiry_year | integer | Card expiry year |
Usage Examples
Basic Card Listing
Request:Implementation Examples
Frontend Card Display
Backend Integration
Security Considerations
🔒 Data Protection
- Only masked card numbers are returned
- No sensitive data (CVV, full PAN) is exposed
- Secure token-based identification
🎯 Access Control
- Customer identifier filtering prevents data leakage
- Proper authentication required
- Cards are only visible to authorized merchants
⏰ Expiry Handling
- Check expiry dates before using cards
- Implement expiry warnings in your UI
- Remove or prompt for updates on expired cards
Error Handling
Status Code | Description | Action |
---|---|---|
200 | Success | Process the returned cards |
401 | Unauthorized | Check authentication credentials |
404 | No cards found | Show “no saved cards” message |
500 | Server error | Retry request or show error message |
Best Practices
- Cache Responsibly: Cache card lists but refresh periodically
- Expiry Validation: Always check if cards are expired before displaying
- Error Handling: Provide clear messaging for empty or error states
- Security: Never log or store the returned card information
- UI/UX: Group cards by type or network for better organization
Use Cases
Checkout Flow
Display saved cards during checkout for faster payment processing.Account Management
Show customers their saved cards in account settings with options to delete.Payment Method Selection
Allow customers to choose from saved cards or add new ones.Recurring Payments
Use saved cards for subscription or recurring payment setups.Related Endpoints
- Save Card - Save new cards for customers
- Delete Saved Card - Remove saved cards
- Create Order - Use saved cards in new orders
Authorizations
Client app ID. You can find your app id in the merchant dashboard.
Client secret key. You can find your secret in the merchant dashboard.
Merchant ID. You can find your merchant ID in the merchant section of the merchant dashboard.
Query Parameters
Unique identifier to filter saved cards