Syntch Gateway API

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:
Name	Parameter	Data Type	Required	Description
PostalCode	query	string	Yes	The postal code to retrieve
Country	query	string	No	Optional: Country to search for specified postal code. If not provided, the US will be used

**PostalCodeDetail** Parameters:
Name	Parameter	Data Type	Required
PostalCode	form	string	No
CountryCode	form	string	No
Latitude	form	string	No
Longitude	form	string	No
City	form	string	No
State	form	string	No
CityEn	form	string	No
StateEn	form	string	No
StateCode	form	string	No
Province	form	string	No
ProvinceCode	form	string	No

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

HTTP + XML

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/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<PostalCodeDetail xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Phoenix.ZipCodeBase">
  <City>String</City>
  <CityEn>String</CityEn>
  <CountryCode>String</CountryCode>
  <Latitude>String</Latitude>
  <Longitude>String</Longitude>
  <PostalCode>String</PostalCode>
  <Province>String</Province>
  <ProvinceCode>String</ProvinceCode>
  <State>String</State>
  <StateCode>String</StateCode>
  <StateEn>String</StateEn>
</PostalCodeDetail>