Sign in
secureTokens

List secure tokens

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

Note: If you want to view the details of a specific secure 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.

get/processing-terminals/{processingTerminalId}/secure-tokens

Path parameters

processingTerminalIdstring required

Unique identifier that we assigned to the terminal.

Query parameters

secureTokenIdstring

Unique identifier that the merchant assigned to the secure token.

customerNamestring

Filter by the customer's name.

phonestring

Filter by the customer's phone number.

emailstring

Filter by the customer's email address.

tokenstring

Filter by the token that the merchant used in a transaction to represent the customer's payment details.

first6string

Filter by the first six digits of the card number.

last4string

Filter by the last four digits of the card or account number.

beforestring

Return the previous page of results before the value that you specify.

You can’t send the before parameter in the same request as the after parameter.

afterstring

Return the next page of results after the value that you specify.

You can’t send the after parameter in the same request as the before parameter.

limitinteger

Limit the maximum number of results that we return for each page.

Headers

Authorizationstring required

Bearer authentication

Response

Successful request. Returns a list of secure tokens that are currently saved on the terminal.

limitinteger required

Maximum number of results that we return for each page.

countinteger required

Number of results we returned on this page.

Note: This might not be the total number of results that match your query.

hasMoreboolean required

Indicates whether there is another page of results available.

Changes

No recorded changes to this endpoint across all 1 revision of this API.