Syntch Gateway API

<back to all web services

GetMerchantBrandingConfigurations

Merchant Information (BETA)
Requires Authentication
Requires the role:Merchant
The following routes are available for this service:
GET/merchants/{merchantKey}/brandingsBETA VERSION (Subject to change). Gets branding details for the merchant key provided.
GetMerchantBrandingConfigurations Parameters:
NameParameterData TypeRequiredDescription
MerchantKeypathintegerYesThe key of the merchant.
MerchantBrandingConfiguration Parameters:
NameParameterData TypeRequiredDescription
BrandingLogoDarkmodelstringNoDark colored logo (CDN Path) for the reseller/instance.
BrandingLogoLightmodelstringNoLight colored logo (CDN Path) for the reseller/instance.
BrandingProductNamemodelstringNoProduct name for the reseller/instance.
BrandingCompanyNamemodelstringNoReseller name for the reseller/instance.
BrandingAddress1modelstringNoAddress for the reseller/instance.
BrandingAddress2modelstringNoAddress (2) for the reseller/instance.
BrandingCitymodelstringNoCity for the reseller/instance.
BrandingStatemodelstringNoState for the reseller/instance.
BrandingPostalCodemodelstringNoZip code for the reseller/instance.
BrandingSupportEmailmodelstringNoSupport email address for the reseller/instance.
BrandingSupportPhonemodelstringNoSuppport phone number for the reseller/instance.
BrandingSalesEmailmodelstringNoSales email address for the reseller/instance.
BrandingCopyrightYearmodelstringNoThe copyright year.

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}/brandings HTTP/1.1 
Host: syntch.simpay.net 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<MerchantBrandingConfiguration xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Gateway.RestApi.Merchants.BindingModels">
  <BrandingAddress1>String</BrandingAddress1>
  <BrandingAddress2>String</BrandingAddress2>
  <BrandingCity>String</BrandingCity>
  <BrandingCompanyName>String</BrandingCompanyName>
  <BrandingCopyrightYear>String</BrandingCopyrightYear>
  <BrandingLogoDark>String</BrandingLogoDark>
  <BrandingLogoLight>String</BrandingLogoLight>
  <BrandingPostalCode>String</BrandingPostalCode>
  <BrandingProductName>String</BrandingProductName>
  <BrandingSalesEmail>String</BrandingSalesEmail>
  <BrandingState>String</BrandingState>
  <BrandingSupportEmail>String</BrandingSupportEmail>
  <BrandingSupportPhone>String</BrandingSupportPhone>
</MerchantBrandingConfiguration>