SchemaPaymentsSecure Tokens

List secure tokens

Use this method to return a paginated list of secure tokens.

Note: If you want to view a specific seure token and you have its secureTokenId, use our Retrieve Secure Token method.

Use query parameters to filter the list of results that we return, for example, to search for secure tokens by customer or by the first four digits of a card number.

Our gateway returns information about the following for each secure token in the list:

  • Payment details that the secure token represents.
  • Customer details, including shipping and billing addresses.
  • Secure token that you can use to carry out transactions.

For each secure token, we also return the secureTokenId, which you can use to perform follow-on actions.

Path parameters

processingTerminalIdstringRequired>=4 characters<=50 characters
Unique identifier that we assigned to the terminal.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

secureTokenIdstringOptional>=1 character<=200 characters
Unique identifier that the merchant assigned to the secure token.
customerNamestringOptional>=1 character<=50 characters
Filter by the customer's name.
phonestringOptional>=1 character<=15 characters
Filter by the customer's phone number.
emailstringOptional>=1 character<=100 characters
Filter by the customer's email address.
tokenstringOptional>=12 characters<=19 characters
Filter by the token that the merchant used in a transaction to represent the customer's payment details.
first6stringOptionalformat: "[0-9]{6}"
Filter by the first six digits of the card number.
last4stringOptionalformat: "[0-9]{4}"
Filter by the last four digits of the card or account number.
beforestringOptional
Points to the resource identifier that you want to receive your results before. Typically, this is the first resource on the previous page.
afterstringOptional
Points to the resource identifier that you want to receive your results after. Typically, this is the last resource on the previous page.
limitintegerOptional<=100Defaults to 10
States the total amount of results the response is limited to.

Response

Successful request. Returns a list of secure tokens that are currently saved on the terminal.
limitdouble
Maximum number of results that we return for each page.
countdouble
Number of results that we returned.
hasMoreboolean
Indicates that further results are available.
datalist of objects
Array of saved payment details.

Errors