Syntch Gateway API

<back to all web services

GetMerchantAddress

Administration - Merchant Management
Requires Authentication
Requires any of the roles:Reseller, Merchant
The following routes are available for this service:
GET/merchants/{merchantKey}/addressesGets a collection of addresses matching the merchant key provided.
GetMerchantAddress Parameters:
NameParameterData TypeRequiredDescription
MerchantKeypathintegerYesThe key of the merchant addresses to fetch.
MerchantAddressCollection Parameters:
NameParameterData TypeRequiredDescription
MerchantAddressesmodelList<MerchantAddress>NoA collection of addresses.
MerchantAddress Parameters:
NameParameterData TypeRequiredDescription
MerchantKeymodelintNoUnique (system-generated) identifier.
AddressTypemodelstringNoShipping or Billing address type.
AddressKeymodelintNoThe unqique database key for the address.
StreetAddress1modelstringNoThe street of the address.
StreetAddress2modelstringNoThe street of the address.
StreetAddress3modelstringNoThe street of the address.
CitymodelstringNoThe city of the address.
StatemodelstringNoThe state of the address.
PostalCodemodelstringNoThe postal code of the address.
CountrymodelstringNoThe country of the address.
TelephonemodelstringNoThe telephone number.
EmailAddressmodelstringNoThe email address.

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 /merchants/{merchantKey}/addresses HTTP/1.1 
Host: syntch.simpay.net 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"MerchantAddresses":[{"MerchantKey":0,"AddressType":"String","AddressKey":0,"StreetAddress1":"String","StreetAddress2":"String","StreetAddress3":"String","City":"String","State":"String","PostalCode":"String","Country":"String","Telephone":"String","EmailAddress":"String"}]}