Get Institution Branding - Field Descriptions
The following tables describe the fields in the response for the Get Institution Branding endpoint.
Header
The following table describes the fields that can be included in the header of the request.
| Field | Description | Type | Min Length | Max Length | Mandatory |
|---|---|---|---|---|---|
| client-id | Client identifier for the request. | String | Yes | ||
| partner-id | Partner identifier for Mastercard configuration. If not provided, uses the default partner ID. | String | No |
Response
The following table describes the fields that are included in the response.
| Field | Description |
|---|---|
| branding | Object that contains information on the branding assets and styling information for the institution. |
| logo | The file path of the institution's logo. For white backgrounds designed at 375 x 72, there is built in spacing around the logo to normalise brand sizing. |
| alternateLogo | The file path of the institution's alternate logo. For coloured backgrounds designed at 375 x 72, there is built in spacing around the logo to normalise brand sizing. |
| icon | The file path of the institution's icon. Returned for search results. Designed at 40 x 40. |
| primaryColor | The hex code for the institution's primary colour. |
| tile | The file path of the institution name logo. Designed at 160 x 72. |
| branding | End of branding object. |
Updated 7 days ago