Search Saved Cards
Use GET /payment/v1/cards to search cards stored for the merchant. Send the merchant identifier in the merchantId request header.
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
cardId |
long |
No | Internal card identifier. |
merchantId |
long |
No | Merchant filter. The authenticated header remains authoritative. |
subMerchantId |
long |
No | Sub-merchant identifier. |
buyerId |
long |
No | Buyer identifier. |
externalCustomerId |
string |
No | Customer identifier in the merchant system. |
partnerId |
long |
No | Partner identifier. |
walletId |
long |
No | Wallet identifier. |
cardAlias |
string |
No | User-defined card name. |
cardBrand |
string |
No | Card brand. |
cardType |
CardType |
No | CREDIT_CARD, DEBIT_CARD, or PREPAID_CARD. |
cardUserKey |
string |
No | Stored-card user key. |
cardToken |
string |
No | Stored-card token. |
cardBankName |
string |
No | Bank name. |
cardAssociation |
CardAssociation |
No | Card association such as VISA or MASTER_CARD. |
page |
integer |
No | Zero-based page number; minimum 0, default 0. |
size |
integer |
No | Page size; minimum 1, default 10. |
Response Fields
The response is a paginated data collection. Each card can contain cardNumber, binNumber, lastFourDigits, expireYear, expireMonth, cardHolderName, cardUserKey, cardToken, cardAlias, cardType, cardAssociation, cardBrand, cardBankName, and cardBankId.
Import a Migrated Card
Use POST /payment/v1/cards when a previously stored card is migrated into TokenPay. The JSON body supports cardHolderName (maximum 255 characters), cardNumber (validated card number), expireYear (4 characters), expireMonth (2 characters), cardAlias (maximum 255 characters), onMerchantCardUserKey, and onMerchantCardToken. A successful request returns 204 No Content.