| 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 .xml suffix or ?format=xml
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: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<ArrayOfCardTokenDetail xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Gateway.RestApi.Tokens.Responses">
<CardTokenDetail>
<CardNumber>String</CardNumber>
<CardType>String</CardType>
<CustomerKey>0</CustomerKey>
<ExpirationDate>String</ExpirationDate>
<MerchantKey>0</MerchantKey>
<NameOnCard>String</NameOnCard>
<PostalCode>String</PostalCode>
<StreetAddress>String</StreetAddress>
<Token>String</Token>
</CardTokenDetail>
</ArrayOfCardTokenDetail>