| 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 .csv suffix or ?format=csv
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: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"BrandingLogoDark":"String","BrandingLogoLight":"String","BrandingProductName":"String","BrandingCompanyName":"String","BrandingAddress1":"String","BrandingAddress2":"String","BrandingCity":"String","BrandingState":"String","BrandingPostalCode":"String","BrandingSupportEmail":"String","BrandingSupportPhone":"String","BrandingSalesEmail":"String","BrandingCopyrightYear":"String"}