The GET Search Secure Token Links method enables the merchant to search token links by multiple parameters. It returns detailed information for token links that match the specified query.
Versions
The POST Search Token Links method is supported identically in AndDone API versions 2.1, 2.2, and 2.3.
|
URI
|
secure/tokenlinks/list
|
|
Method
|
POST
|
|
Authorization
|
API Key Authorization
|
|
x-api-key
|
API key {env_merchantAccessKey}
|
|
x-app-key
|
Merchant ID or App Key {env_merchantId}
|
|
x-version
|
API version (e.g., 2.1)
|
|
Origin
|
URL or IP address provided to AndDone as an allowed origin.
|
|
Content-Type
|
application/json
|
Query Parameters
| email |
Filter for token links associated with this email address. |
| status |
Filter for token links in this status. Possible values: NA, Created, Completed, Expired, Invalidated, Failed. |
| phone |
Include token links associated with this phone number. |
| statuses |
Include token links in these statuses (comma-separated list). |
| title |
Filter for a token link with this title. |
| paymentDescription |
Filter for token links with this payment description. |
| invoiceNumber |
Filter for token links with this invoice number. |
| expiryDate |
Filter for token links with this expiry date. |
| fromExpiryDate |
Include links with expiry on or after this timestamp (start of expiry window). |
| toExpiryDate |
Include links with expiry on or before this timestamp (end of expiry window). |
| fromDate |
Include links created on or after this timestamp (start of created window). |
| toDate |
Include links created on or before this timestamp (end of created window). |
| freeTextSearch |
Search for token links matching this free-text keyword. |
| tokenLinkId |
Filter for token links with this token link ID. |
| startRow |
Zero-based row offset for pagination (the first record to return). |
| pageSize |
Maximum number of records to return per page. |
| sortField |
Field name to sort by (must be a sortable property, such as createdAt, expiryDate, status, or title). |
| asc |
Sort direction: true for ascending, false for descending. |
Sample Request
https://api.uat.anddone.com/secure/tokenlinks/list?fromDate=2025-01-01&toDate=2025-01-31&sortField=createdAt&asc=true&startRow=0&pageSize=50
Response
Body Response Example (JSON)