SchemaPaymentsSecure Tokens

List secure tokens

Use this method to return a [paginated](https://docs.payroc.com/api/pagination) 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](https://docs.payroc.com/api/schema/payments/secure-tokens/retrieve) 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.

Authentication

AuthorizationBearer

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

Path parameters

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

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

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.

afterstringOptional

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.

limitintegerOptional<=100Defaults to 10
Limit the maximum number of results that we return for each page.

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 we returned on this page.

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

hasMoreboolean
Indicates whether there is another page of results available.
datalist of objects
Array of saved payment details.

Errors