--- title: "List secure tokens" method: GET path: "/processing-terminals/{processingTerminalId}/secure-tokens" tags: ["secureTokens"] --- # List secure tokens `GET /processing-terminals/{processingTerminalId}/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/tokenization/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. ## Path parameters - `processingTerminalId` string, required ## Query parameters - `secureTokenId` string - `customerName` string - `phone` string - `email` string - `token` string - `first6` string - `last4` string - `before` string - `after` string - `limit` integer ## Headers - `Authorization` string, required ## Response `200` Successful request. Returns a list of secure tokens that are currently saved on the terminal. - SecureTokenPaginatedListWithAccountType - `limit` integer, required — Maximum number of results that we return for each page. - `count` integer, required — Number of results we returned on this page. **Note:** This might not be the total number of results that match your query. - `hasMore` boolean, required — Indicates whether there is another page of results available. - `links` Link[] — Reference links to navigate to the previous page of results or to the next page of results. - `rel` string, required — Indicates the relationship between the current resource and the target resource. - `method` string, required — HTTP method that you need to use with the target resource. - `href` string, required — URL of the target resource. - `data` SecureTokenWithAccountType[], required — Array of saved payment details. - `secureTokenId` string, required — Unique identifier that the merchant created for the secure token that represents the customer's payment details. - `processingTerminalId` string, required — Unique identifier that we assigned to the terminal. - `mitAgreement` 'unscheduled' | 'recurring' | 'installment' — Indicates how the merchant can use the customer's card details, as agreed by the customer: - `unscheduled` - Transactions for a fixed or variable amount that are run at a certain pre-defined event. - `recurring` - Transactions for a fixed amount that are run at regular intervals, for example, monthly. Recurring transactions don't have a fixed duration and run until the customer cancels the agreement. - `installment` - Transactions for a fixed amount that are run at regular intervals, for example, monthly. Installment transactions have a fixed duration. - `customer` RetrievedCustomer — Object that contains the customer's contact details and address information. - `firstName` string — Customer's first name. - `lastName` string — Customer's last name. - `dateOfBirth` string, date — Customer's date of birth. The format for this value is **YYYY-MM-DD**. - `referenceNumber` string — Identifier of the transaction, also known as a customer code. For requests, you must send a value for **referenceNumber** if the customer provides one. - `billingAddress` RetrievedAddress — Object that contains information about the address. - `address1` string — Address line 1. - `address2` string — Address line 2. - `address3` string — Address line 3. - `city` string — City. - `state` string — Name of the state or state abbreviation. - `country` string — Two-digit country code for the country that the business operates in. The format follows the [ISO-3166-1](https://www.iso.org/iso-3166-country-codes.html) standard. - `postalCode` string — Zip code or postal code. - `shippingAddress` RetrievedShipping — Object that contains information about the customer and their shipping address. - `recipientName` string — Recipient's name. - `address` RetrievedAddress — Object that contains information about the address. - `address1` string — Address line 1. - `address2` string — Address line 2. - `address3` string — Address line 3. - `city` string — City. - `state` string — Name of the state or state abbreviation. - `country` string — Two-digit country code for the country that the business operates in. The format follows the [ISO-3166-1](https://www.iso.org/iso-3166-country-codes.html) standard. - `postalCode` string — Zip code or postal code. - `contactMethods` ContactMethod[] — Array of polymorphic objects, which contain contact information. The value of the type parameter determines which variant you should use: - `email` - Email address - `phone` - Phone number - `mobile` - Mobile number - `fax` - Fax number - union - object — email variant - `type` 'email', required — Discriminator value: email - `value` string, required — Email address. - object — phone variant - `type` 'phone', required — Discriminator value: phone - `value` string, required — Phone number. - object — mobile variant - `type` 'mobile', required — Discriminator value: mobile - `value` string, required — Mobile number. - object — fax variant - `type` 'fax', required — Discriminator value: fax - `value` string, required — Fax number. - `notificationLanguage` 'en' | 'fr' — Language that the customer uses for notifications. This code follows the [ISO 639-1](https://www.iso.org/iso-639-language-code) alpha-2 standard. - `source` union, required — Polymorphic object that contains the payment method that we tokenized. The value of the type parameter determines which variant you should use: - `ach` - Automated Clearing House (ACH) details - `pad` - Pre-authorized debit (PAD) details - `card` - Payment card details - object — ach variant - `type` 'ach', required - `nameOnAccount` string, required — Customer's name. - `accountNumber` string, required — Customer's account number. - `routingNumber` string, required — Routing number of the customer's account. - `accountType` 'checking' | 'savings' — Indicates the customer's account type. - object — pad variant - `type` 'pad', required - `nameOnAccount` string, required — Customer's name. - `accountNumber` string, required — Customer's account number. - `transitNumber` string, required — Five-digit code that represents the customer's banking branch. - `institutionNumber` string, required — Three-digit code that represents the customer's bank. - `accountType` 'checking' | 'savings' — Indicates the customer's account type. - object — Object that contains the customer's card details. - `type` 'card', required — Discriminator value: card - `cardholderName` string, required — Cardholder's name. - `cardNumber` string, required — Primary account number of the customer's card. - `expiryDate` string — Expiry date of the customer's card. - `cardType` string — Card brand of the card, for example, Visa. - `currency` 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYR' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LTL' | 'LVL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRO' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STD' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'USS' | 'UYI' | 'UYU' | 'UZS' | 'VEF' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XOF' | 'XPF' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL' — Currency of the transaction. The value for the currency follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard. - `debit` boolean — Indicates if the card is a debit card. - `surcharging` Surcharging — Object that contains surcharge information. Our gateway returns this object only if the merchant adds a surcharge to transactions. - `allowed` boolean, required — Indicates if the merchant can add a surcharge when the customer uses this card. - `amount` integer — Surcharge amount to add to the transaction. **Note:** Our gateway returns the surcharge amount only if you include a transaction amount in the request. - `percentage` number, double — Surcharge rate that the merchant configures on their account. - `disclosure` string — Statement that informs the customer about the surcharge fee. - `token` string, required — Token that the merchant can use in future transactions to represent the customer's payment details. The token: - Begins with the six-digit identification number **296753**. - Contains up to 12 digits. - Contains a single check digit that we calculate using the Luhn algorithm. - `status` 'notValidated' | 'cvvValidated' | 'validationFailed' | 'issueNumberValidated' | 'cardNumberValidated' | 'bankAccountValidated', required — Outcome of a security check on the status of the customer's payment card or bank account. **Note:** Depending on the merchant's account settings, this feature may be unavailable. - `customFields` CustomField[] — Array of customField objects. - `name` string, required — Name of the custom field. - `value` string, required — Value for the custom field. ## Other responses - `400` — Invalid request - `401` — Identity could not be verified - `403` — Do not have permissions to perform this action - `406` — Not acceptable - `500` — An error has occured --- [API](https://skmtc.dev/payroc/apis/schema.md) · [All operations](https://skmtc.dev/payroc/apis/schema/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/payroc/schema/revisions/1d9d3e305945/schema)