v1

latestOpenAPI 3.0.2Apache License 2.02026-07-13109285691.8 KB

Payors

Get Branding

Get the payor branding details.

get/v1/payors/{payorId}/branding

Path parameters

payorIdstring uuid required

The account owner Payor ID

Response

HTTP Ok, key created

payorNamestring required

The name of the payor

logoUrlstring uri required

<p>The URL to use for this payor’s logo</p> <p>This will be an immutable system-generated URL</p>

collectiveAliasstring

How the payor has chosen to refer to payees

supportContactstring

The payor’s support contact address

dbaNamestring

The payor’s 'Doing Business As' name

Example response

{
  "supportContact": "support@example.com",
  "collectiveAlias": "Contractors",
  "dbaName": "Key West Imports",
  "logoUrl": "https://images.example.com/450ecb66-df18-4d0c-b557-f718782775df/logo.png",
  "payorName": "Key West Imports, Inc"
}