| Requires the role: | Merchant |
| POST | /merchants/{merchantKey}/tokens/checks | Creates a check token for the merchant. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| MerchantKey | path | integer | Yes | The key of the merchant. |
| CustomerKey | path | integer | No | The key of the customer. |
| AccountNumber | model | string | Yes | The account number. |
| RoutingNumber | model | string | Yes | The routing number. |
| NameOnCheck | model | string | Yes | The name on the check. |
| AccountType | model | CheckAccountType | No | The account type, checking or savings. Default is checking.Allowable Values
|
| CheckType | model | CheckType | No | The check type, personal or business. Default is personalAllowable Values
|
| TokenFormat | model | TokenFormat? | No | The token format for this cardAllowable Values
|
| Name | Value | |
|---|---|---|
| Checking | 1 | |
| Savings | 2 |
| Name | Value | |
|---|---|---|
| Personal | 1 | |
| Business | 2 |
| Name | Value | |
|---|---|---|
| Uid | 1 | |
| Integer | 2 | |
| CardFormat | 3 |
| 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. |
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /merchants/{merchantKey}/tokens/checks HTTP/1.1
Host: syntch.simpay.net
Accept: application/json
Content-Type: application/json
Content-Length: length
{"MerchantKey":0,"CustomerKey":0,"AccountNumber":"String","RoutingNumber":"String","NameOnCheck":"String","AccountType":"Checking","CheckType":"Personal","TokenFormat":"0"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"MerchantKey":0,"CustomerKey":0,"AccountNumber":"String","RoutingNumber":"String","NameOnCheck":"String","AccountType":"0","CheckType":"0","Token":"String"}