Sign in

v1

latestOpenAPI 3.0.12026-07-2356172250.9 KB
Tokens

Search Tokens

Retrieve the list of payment tokens based on filter criteria. Enabling multi-merchant support, the search includes tokens across all related merchants.

get/rest/v2/tokens

Query parameters

token-idstring

A unique identifier for the token. Used to search for a specific token.

merchant-legacy-token-idstring

Merchant-provided identifier. Used to retrieve the token associated with this legacy ID.

updated-start-datestring

Filters tokens updated after this date/time. Used to define the start of a date range.

updated-end-datestring

Filters tokens updated before this date/time. Used with updated-start-date to define a date range.

date-filter'custom_range' | 'last_24_hours' | 'yesterday' | 'last_week' | 'last_month' | 'last_180_days'

Preset date filters. Use custom_range to specify custom start and end dates.

date-format'MM-dd-yyyy hh:mm a' | 'MM-dd-yy HH:mm' | 'MM-dd-yy HH:mm z' | 'yyyy-MM-dd HH:mm' | 'yyyy-MM-dd HH:mm z'

Specifies the format of the date values. Required if updated-start-date and updated-end-date are provided.

pagestring

Page number for paginated results.

page-sizestring

Number of results per page.

isDescending'true' | 'false'

Indicates whether results should be listed in descending order.

Headers

api-keystring required

An access API key issued to you by Xplor Pay.

Response

Success

payloadTypestring

Type of payload returned in the response.