VEvelopaymentsapi
Payors

Get Branding

Changed on

Get the payor branding details.

get/v1/payors/{payorId}/branding

Request

  • Base URL
    https://api.sandbox.velopayments.com
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://api.sandbox.velopayments.com/v1/login

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"
}

Changes

  • dd71433847a6Revision changes
    • breaking

      the / response's property type changed from no type to object for status

    • breaking

      the / response's property type changed from no type to object for status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      response property errors/items/locationType deprecated

    • info

      response property errors/items/locationType deprecated

    • info

      response property errors/items/locationType deprecated

    • info

      response property errors/items/reasonCode deprecated

    • info

      response property errors/items/reasonCode deprecated

    • info

      response property errors/items/reasonCode deprecated

  • 1b2abf26b5d6Revision changes
    • breaking

      the response's body type changed from object to no type for status

    • breaking

      the response's body type changed from object to no type for status

    • breaking

      the / response's property type changed from object to no type for status

    • breaking

      the / response's property type changed from object to no type for status

    • warning

      added the new requestParam enum value to the // response property for the response status

    • warning

      added the new requestParam enum value to the // response property for the response status

    • warning

      added the new requestParam enum value to the // response property for the response status