Syntch Gateway API

<back to all web services

GetStates

Lookup Data - Addresses
Requires Authentication
Requires any of the roles:Reseller, Merchant
The following routes are available for this service:
GET/lookup/countries/{CountryCode}/statesGets a list of states/provinces in a given country
GetStates Parameters:
NameParameterData TypeRequiredDescription
CountryCodequerystringYesISO 3166-1 alpha-2 country code

Allowable Values

  • US
  • CA
GetStatesResult Parameters:
NameParameterData TypeRequiredDescription
StatesmodelList<AbbreviatedResponseItem>NoA collection of states.
PaginationmodelPaginationStatsNoPagination stats regarding the result set.
AbbreviatedResponseItem Parameters:
NameParameterData TypeRequiredDescription
ShortNameformstringNo
LongNameformstringNo
PaginationStats Parameters:
NameParameterData TypeRequiredDescription
CurrentPageNumberformintNo
PageSizeformintNo
TotalRecordCountformintNo

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

HTTP + CSV

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

GET /lookup/countries/{CountryCode}/states HTTP/1.1 
Host: syntch.simpay.net 
Accept: text/csv

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"States":[{"ShortName":"String","LongName":"String"}],"Pagination":{"CurrentPageNumber":0,"PageSize":0,"TotalRecordCount":0}}