Syntch Gateway API

<back to all web services

PatchCheckToken

Tokenization - Checks
Requires Authentication
Requires the role:Merchant
The following routes are available for this service:
PATCH/merchants/{merchantKey}/tokens/checks/{token}Updates a check token for the merchant.
PatchCheckToken Parameters:
NameParameterData TypeRequiredDescription
MerchantKeypathintegerYesThe key of the merchant.
TokenpathstringYesThe check token.
AccountNumbermodelstringNoThe account number.
RoutingNumbermodelstringNoThe routing number.
NameOnCheckmodelstringNoThe name on the check.
AccountTypemodelCheckAccountType?NoThe account type, checking or savings.

Allowable Values

  • Checking
  • Savings
CheckTypemodelCheckType?NoThe check type, personal or business.

Allowable Values

  • Personal
  • Business
CheckAccountType Enum:
NameValue
Checking1
Savings2
CheckType Enum:
NameValue
Personal1
Business2
CheckTokenDetail Parameters:
NameParameterData TypeRequiredDescription
MerchantKeymodelint?NoThe merchant key.
CustomerKeymodelint?NoThe customer key.
AccountNumbermodelstringNoThe account number.
RoutingNumbermodelstringNoThe routing number.
NameOnCheckmodelstringNoThe name on the check.
AccountTypemodelCheckAccountType?NoThe account type, checking or savings.

Allowable Values

  • Checking
  • Savings
CheckTypemodelCheckType?NoThe check type, personal or business.

Allowable Values

  • Personal
  • Business
TokenmodelstringNoThe token for this check.

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PATCH /merchants/{merchantKey}/tokens/checks/{token} HTTP/1.1 
Host: syntch.simpay.net 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	MerchantKey: 0,
	Token: String,
	AccountNumber: String,
	RoutingNumber: String,
	NameOnCheck: String,
	AccountType: 0,
	CheckType: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	MerchantKey: 0,
	CustomerKey: 0,
	AccountNumber: String,
	RoutingNumber: String,
	NameOnCheck: String,
	AccountType: 0,
	CheckType: 0,
	Token: String
}