Payer Theme

Create a payer theme associated with a creditor

Creates a new payer theme associated with a creditor. If a creditor already has payer themes, this will update the existing payer theme linked to the creditor.

<p class="restricted-notice"><strong>Restricted</strong>: This endpoint is restricted to GoCardless Embed customers. Please [contact us](https://forms.gocardless.com/l/305971/2023-01-25/535t8n){:target="_blank"} if you are interested in using this product.</p>
post/branding/payer_themes

Request

  • Base URL
    https://api.gocardless.com
  • Auth
    HTTP bearer

Headers

GoCardless-Versionstring required

Request body

Example request

{
  "payer_themes": {
    "header_background_colour": "#FFFFFF",
    "link_text_colour": "#3179D9",
    "button_background_colour": "#00A87E",
    "content_box_border_colour": "#D7D9DE",
    "links": {
      "creditor": "CR1234"
    }
  }
}

Response

Resource created successfully

Example response

{
  "payer_themes": {
    "id": "PTH123"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.