---
title: "Get Branding"
method: GET
path: "/v1/payors/{payorId}/branding"
tags: ["Payors"]
---

# Get Branding

`GET /v1/payors/{payorId}/branding`

## Request

- Base URL: `https://api.sandbox.velopayments.com`
- URL: `https://api.sandbox.velopayments.com/v1/payors/{payorId}/branding`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://api.sandbox.velopayments.com/v1/login`

Get the payor branding details.

## Path parameters

- `payorId` string, uuid, required

## Response `200`

HTTP Ok, key created

- PayorBrandingResponse
  - `payorName` string, required: The name of the payor
  - `logoUrl` string, uri, required: <p>The URL to use for this payor’s logo</p> <p>This will be an immutable system-generated URL</p>
  - `collectiveAlias` string: How the payor has chosen to refer to payees
  - `supportContact` string: The payor’s support contact address
  - `dbaName` string: The payor’s 'Doing Business As' name

## Other responses

- `400`: Invalid request. See Error message payload for details of failure
- `403`: The authentication does not have permissions to access the resource This usually occurs when there is a valid authentication instance (client or user) but they do not have the required permissions
- `404`: Payor Id Not Found

## Changes

- **2020-10-30** `dd71433847a6`: 2 breaking, 18 info
  - the `errors/items/` response's property type changed from no type to `object` for status `400`
  - the `errors/items/` response's property type changed from no type to `object` for status `403`
  - added the optional property `errors/items/errorCode` to the response with the `400` status
  - added the optional property `errors/items/errorCode` to the response with the `403` status
  - …16 more
- **2020-01-28** `1b2abf26b5d6`: 4 breaking, 3 warning
  - the response's body type changed from `object` to no type for status `400`
  - the response's body type changed from `object` to no type for status `403`
  - the `errors/items/` response's property type changed from `object` to no type for status `400`
  - the `errors/items/` response's property type changed from `object` to no type for status `403`
  - …3 more
- **2019-12-11** `a0b19fa311c0`: 3 info
  - added the media type `application/json` for the response with the status `400`
  - added the media type `application/json` for the response with the status `404`
  - added the non-success response with the status `403`
- **2019-04-05** `80a25d86e9a1`: 2 info
  - api tag `Payors` added
  - api tag `Payor Branding` removed
- **2019-03-29** `0c34292d9984`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/velopaymentsapi/apis/velo-payments-apis/changes/v1/payors/:payorId/branding/get.md)

---

[API](https://skmtc.dev/velopaymentsapi/apis/velo-payments-apis.md) - [All operations](https://skmtc.dev/velopaymentsapi/apis/velo-payments-apis/llms.txt) - [OpenAPI document](https://skmtc.dev/velopaymentsapi/apis/velo-payments-apis/revisions/05c3f09fc50a?raw)