| Requires the role: | Merchant |
| GET | /merchants/{merchantKey}/customers/{customerKey}/tokens | Gets a collection of card and check tokens for a customer. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| MerchantKey | path | integer | Yes | The key of the merchant. |
| CustomerKey | path | integer | Yes | The key of the customer. |
| 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 | form | string | No | |
| SortField | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| PageSize | form | short | No | |
| PageNumber | form | short | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CardTokens | model | List<CardTokenDetail> | No | A collection of card tokens. |
| CheckTokens | model | List<CheckTokenDetail> | No | A collection of check tokens. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| MerchantKey | model | int? | No | The merchant key. |
| CustomerKey | model | int? | No | The customer key. |
| CardNumber | model | string | No | The card number. |
| ExpirationDate | model | string | No | The expiration date, formatted as MMYY. |
| CardType | model | string | No | The card type. |
| NameOnCard | model | string | No | The name on the card. |
| StreetAddress | model | string | No | The street address for the card. |
| PostalCode | model | string | No | The postal code for the card. |
| Token | model | string | No | The token for the card. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| MerchantKey | model | int? | No | The merchant key. |
| CustomerKey | model | int? | No | The customer key. |
| AccountNumber | model | string | No | The account number. |
| RoutingNumber | model | string | No | The routing number. |
| NameOnCheck | model | string | No | The name on the check. |
| AccountType | model | CheckAccountType? | No | The account type, checking or savings.Allowable Values
|
| CheckType | model | CheckType? | No | The check type, personal or business.Allowable Values
|
| Token | model | string | No | The token for this check. |
| Name | Value | |
|---|---|---|
| Checking | 1 | |
| Savings | 2 |
| Name | Value | |
|---|---|---|
| Personal | 1 | |
| Business | 2 |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /merchants/{merchantKey}/customers/{customerKey}/tokens HTTP/1.1
Host: syntch.simpay.net
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
CardTokens:
[
{
MerchantKey: 0,
CustomerKey: 0,
CardNumber: String,
ExpirationDate: String,
CardType: String,
NameOnCard: String,
StreetAddress: String,
PostalCode: String,
Token: String
}
],
CheckTokens:
[
{
MerchantKey: 0,
CustomerKey: 0,
AccountNumber: String,
RoutingNumber: String,
NameOnCheck: String,
AccountType: 0,
CheckType: 0,
Token: String
}
]
}