Syntch Gateway API

GetMerchantAddress

Administration - Merchant Management

**Requires Authentication**
Requires any of the roles:	Reseller, Merchant

The following routes are available for this service:
GET	/merchants/{merchantKey}/addresses	Gets a collection of addresses matching the merchant key provided.

**GetMerchantAddress** Parameters:
Name	Parameter	Data Type	Required	Description
MerchantKey	path	integer	Yes	The key of the merchant addresses to fetch.

**MerchantAddressCollection** Parameters:
Name	Parameter	Data Type	Required	Description
MerchantAddresses	model	List<MerchantAddress>	No	A collection of addresses.

**MerchantAddress** Parameters:
Name	Parameter	Data Type	Required	Description
MerchantKey	model	int	No	Unique (system-generated) identifier.
AddressType	model	string	No	Shipping or Billing address type.
AddressKey	model	int	No	The unqique database key for the address.
StreetAddress1	model	string	No	The street of the address.
StreetAddress2	model	string	No	The street of the address.
StreetAddress3	model	string	No	The street of the address.
City	model	string	No	The city of the address.
State	model	string	No	The state of the address.
PostalCode	model	string	No	The postal code of the address.
Country	model	string	No	The country of the address.
Telephone	model	string	No	The telephone number.
EmailAddress	model	string	No	The email address.

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 /merchants/{merchantKey}/addresses HTTP/1.1 
Host: syntch.simpay.net 
Accept: application/xml

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

<MerchantAddressCollection xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Gateway.RestApi.Merchants.BindingModels">
  <MerchantAddresses>
    <MerchantAddress>
      <AddressKey>0</AddressKey>
      <AddressType>String</AddressType>
      <City>String</City>
      <Country>String</Country>
      <EmailAddress>String</EmailAddress>
      <MerchantKey>0</MerchantKey>
      <PostalCode>String</PostalCode>
      <State>String</State>
      <StreetAddress1>String</StreetAddress1>
      <StreetAddress2>String</StreetAddress2>
      <StreetAddress3>String</StreetAddress3>
      <Telephone>String</Telephone>
    </MerchantAddress>
  </MerchantAddresses>
</MerchantAddressCollection>