Syntch Gateway API

<back to all web services

GetPostalCode

Lookup Data - Addresses
Requires Authentication
Requires any of the roles:Reseller, Merchant
The following routes are available for this service:
GET/lookup/postalcodes/{PostalCode}Gets details for a given postal code
GetPostalCode Parameters:
NameParameterData TypeRequiredDescription
PostalCodequerystringYesThe postal code to retrieve
CountryquerystringNoOptional: Country to search for specified postal code. If not provided, the US will be used
PostalCodeDetail Parameters:
NameParameterData TypeRequiredDescription
PostalCodeformstringNo
CountryCodeformstringNo
LatitudeformstringNo
LongitudeformstringNo
CityformstringNo
StateformstringNo
CityEnformstringNo
StateEnformstringNo
StateCodeformstringNo
ProvinceformstringNo
ProvinceCodeformstringNo

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

HTTP + JSON

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

GET /lookup/postalcodes/{PostalCode} HTTP/1.1 
Host: syntch.simpay.net 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"PostalCode":"String","CountryCode":"String","Latitude":"String","Longitude":"String","City":"String","State":"String","CityEn":"String","StateEn":"String","StateCode":"String","Province":"String","ProvinceCode":"String"}