v1

latestOpenAPI 3.0.0ISC2026-07-249501.1 MB
Ecommerce

View card tokens

Allows you to view all saved card tokens based on the given criteria.

<!-- theme: info -->

📘 Note

Nexio does not currently support returning terminal tokens from this endpoint. Instead, use the terminal's token with the View card token details endpoint.

Saved card tokens can be used to process through any MID on your account. They are not restricted to a specific merchant account or currency.

<!-- theme: warning -->

⚠️ Try It

To use the Try It feature for this endpoint, you can use the credentials for your Sandbox API user.

You can include any of the possible filters, or none of them, in your request. For example, /card/v3/?expirationYear<2024&merchantId=000999 to return all records for the given merchantId and a card expiration year before 2024.

<div style="display:none;">

Request parameters

  • limit
  • offset
  • createdAt
  • updatedAt
  • merchantId
  • merchantIds
  • customerRef
  • expirationMonth
  • expirationYear
  • accountUpdaterStatus
  • shouldUpdateCard
  • lastAccountUpdaterUpdate
  • pauseAccountUpdater
  • cardType
  • firstSix
  • lastFour
  • token
  • cardHolderName

Response parameters

  • limit
  • offset
  • hasMore
  • rows.key
  • rows.merchantId
  • rows.customerRef
  • rows.expirationMonth
  • rows.expirationYear
  • rows.accountUpdaterStatus
  • rows.shouldUpdateCard
  • rows.lastAccountUpdaterUpdate
  • rows.pauseAccountUpdater
  • rows.createdAt
  • rows.updatedAt
  • rows.cardType
  • rows.firstSix
  • rows.lastFour
  • rows.token
  • rows.cardHolderName
  • random-nnnn
</div>
get/card/v3

Query parameters

limitinteger
Example:12

The number of records to return.

offsetinteger
Example:10

The offset. Used to view records further along the list.

createdAtstring
Example:2024-02-21T05:39:59.000Z

The date and time the payment record was created in Nexio.

updatedAtstring
Example:2024-03-27T14:14:57.000Z

The date and time at which the payment record was most recently updated in Nexio.

merchantIdstring
Example:000999

The merchant ID associated with the card token. This value is used as the input for an exact search.

merchantIdsstring
Example:000999,1111111

A comma-separated list of one or more merchant IDs. Each value is used as the input for an exact search of the merchant ID for a card token.

customerRefstring
Example:customer123

Customer identifier. If included in the request, the system only searches for exact matches to the value.

expirationMonthstring
Example:12

The one-digit or two-digit month in which the card expires. This value is used as the input for an exact search.

expirationYearstring
Example:28

The year (typically two-digit) in which the card will expire. This value is used as the input for an exact search.

cardTypestring
Example:visa

The card type specified when the card token was created. This value is used as the input for a fuzzy search.

cardHolderNamestring
Example:Doe

The cardholder's name as it appears on the card. This value is used as the input for a fuzzy search.

firstSixstring
Example:479300

The first six digits of the card number. This value is used as the input for a fuzzy search.

lastFourstring
Example:1238

The last four digits of the card number. This value is used as the input for a fuzzy search.

accountUpdaterStatusstring
Example:isExcluded

The card's account updater status with legacy providers. This parameter has been deprecated. For a list of possible values and meanings, see the account updater card status table in Guides. This value is used as the input for a fuzzy search.

lastAccountUpdaterUpdatestring
Example:accountClosed

The most recent update to the card token from Account Updater. Possible values to search are cardExpiration, cardNumber, or accountClosed. This value is used as the input for a fuzzy search.

pauseAccountUpdaterstring
Example:false

This parameter has been deprecated. For Nexio internal use only.

shouldUpdateCardstring
Example:true

The Boolean value that indicates whether Account Updater is enabled for this card token. This value is used as the input for an exact search.

Response

Success

limitinteger

The maximum number of records returned in a response (starting from the default or specified offset query parameter).

offsetinteger

The offset indicates how many card token records were skipped before beginning to return records in a response. If both offset and limit were used together, the offset records were skipped before starting to count the records to limit.

hasMoreboolean

Will be true if there are more records after the current paged response. Use the limit and offset query parameters to display paged results.

random-nnnnstring

Used for sandbox/testing only. The parameter name includes a random set of numbers as part of the name and includes a random value in the response.

This parameter and value have no meaning except to remind you to create a flexible integration with the Nexio API.