| Requires the role: | Merchant |
| GET | /merchants/{merchantKey}/brandings | BETA VERSION (Subject to change). Gets branding details for the merchant key provided. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| MerchantKey | path | integer | Yes | The key of the merchant. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| BrandingLogoDark | model | string | No | Dark colored logo (CDN Path) for the reseller/instance. |
| BrandingLogoLight | model | string | No | Light colored logo (CDN Path) for the reseller/instance. |
| BrandingProductName | model | string | No | Product name for the reseller/instance. |
| BrandingCompanyName | model | string | No | Reseller name for the reseller/instance. |
| BrandingAddress1 | model | string | No | Address for the reseller/instance. |
| BrandingAddress2 | model | string | No | Address (2) for the reseller/instance. |
| BrandingCity | model | string | No | City for the reseller/instance. |
| BrandingState | model | string | No | State for the reseller/instance. |
| BrandingPostalCode | model | string | No | Zip code for the reseller/instance. |
| BrandingSupportEmail | model | string | No | Support email address for the reseller/instance. |
| BrandingSupportPhone | model | string | No | Suppport phone number for the reseller/instance. |
| BrandingSalesEmail | model | string | No | Sales email address for the reseller/instance. |
| BrandingCopyrightYear | model | string | No | The copyright year. |
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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>