SchemaPaymentsSecure Tokens

List secure tokens

Return a list of secure tokens that are currently saved on the terminal.

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

Filter by the unique 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.

datalist of objects

Array of saved payment details.

countintegerOptional

Number of results that we returned.

hasMorebooleanOptional

Indicates that further results are available.

limitintegerOptional

Maximum number of results that we return for each page.