Get Tokens
Get cards tokens
GET https://<Platform-host>/api/cards
Request
Query Parameters
page
integer
Specify the page number that needs to be retrieved (default is 1)
size
integer
A limit on the number of objects to be returned. The limit can range between 1 and 100, and the default is 10.
card_updater_type
string
Type of card account update - updated, expired, closed, no_participating, contact_cardholder_advice, unknown, opt_out, enrolled Note: The account/merchant needs to be enrolled for the Card Account Updater in order of the card to be update automatically
card_updater_updated_at[from]
string
Specifies the start date for retrieving cards that were automatically enrolled by the card updater service. This does not include manual card updates or changes made by via update token API.
card_updater_updated_at[to]
string
Specifies the end date for retrieving cards that were automatically enrolled by the card updater service. This does not include manual card updates or changes made by via update token API
data
array
Card tokens
Required
data[i].id
string
Card token ID
Required
data[i].merchant_id
string
Merchant ID
Required
data[i].name
string
Name associated with this card
Required
data[i].exp_month
integer
Expiration month
Required
data[i].exp_year
integer
Expiration year
Required
data[i].last_4
string
Last four digit of the card
Required
data[i].brand
string
Card brand
Required
data[i].country
string
Country where the card is issued
Required
data[i].type
string
Type of card - Credit | Debit | Gift | Prepaid
Required
data[i].expires_at
string
Card token expiration timestamp
Optional
data[i].surcharge_allowed
string
True | False. True if surcharge is allowed on the card
Required
data[i].created_at
string
Timestamp when card token was created
Required
data[i].address_line1
string
Address line 1 associated with Cardholder's billing address
Optional
data[i].address_line2
string
Address line 2 associated with Cardholder's billing address
Optional
data[i].address_city
string
City associated with Cardholder's billing address
data[i].address_state
string
State associated with Cardholder's billing address
Optional
data[i].address_country
string
Country associated with Cardholder's billing address
Optional
data[i].address_zip
string
Zip code associated with the card
Optional
data[i].email
string
Cardholder Email
Optional
data[i].phone_number.cc
string
Cardholder Phone Country Code
Optional
data[i].phone_number.subscriber
string
Cardholder Phone Number
Optional
data[i].card_updater
object
Card updater information details only when card account updater is enabled
Optional
data[i].card_updater.status
string
Values - enrolled | closed Required if the card_updater object is present
Required
data[i].card_updater.type
string
Values - updated, expired, closed, no_participating, contact_cardholder_advice, unknown, opt_out, enrolled Required if the card_updater object is present
Required
data[i].card_updater.enrolled_at
string
Timestamp indicating when the card was enrolled in the Card Account Updater service. Required if the card_updater object is present Note: This date is not the same as the token creation date
Required
data[i].card_updater.updated_at
string
Timestamp indicating when the last update was received. Required if the card_updater object is present
Required
meta
object
Metadata for this response
Required
meta.total
integer
Total batches in this response
Required
meta.current_page
integer
Current page
Required
meta.total_pages
integer
Total number of pages for this search
Required
curl --location --request GET 'http://<Platform-host>/api/cards' \
--header 'Authorization: Basic <YOUR_API_SECRET>'
Last updated