| Requires the role: | Merchant |
| GET | /merchants/{merchantKey}/tokens/cards | Gets a collection of card tokens for the merchant. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| MerchantKey | path | integer | Yes | The key of the merchant. |
| CustomerKey | query | integer | No | Constrain the records returned to those occurring on or after this value. Default is to apply no constraint. |
| BeginningDate | query | DateTime? | No | Constrain the records returned to those occurring on or after this value. Default is to apply no constraint. |
| EndingDate | query | DateTime? | No | Constrain the records returned to those occurring on or before this value. Default is to apply no constraint. |
| SortField | query | string | No | The field by which the records will be sorted. Default is 'Date'.Allowable Values
|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SortDirection | query | string | No | The direction in which the records will be sorted. Default is 'asc'.Allowable Values
|
| SortField | query | string | No | The field name by which the records will be sorted. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| PageSize | query | short | No | The number of records per page. Default is 20. |
| PageNumber | query | short | No | The page number to fetch. Default is 1. |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /merchants/{merchantKey}/tokens/cards HTTP/1.1
Host: syntch.simpay.net
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
[{"MerchantKey":0,"CustomerKey":0,"CardNumber":"String","ExpirationDate":"String","CardType":"String","NameOnCard":"String","StreetAddress":"String","PostalCode":"String","Token":"String"}]