Branding Themes

Overview

URL https://api.xero.com/api.xro/2.0/BrandingThemes
https://api.xero.com/api.xro/2.0/BrandingThemes/{BrandingThemeID}/PaymentServices
Methods Supported GET, POST
Description Retrieve a list of branding themes
Apply a payment service to a branding theme
Retrieve the payment services applied to a branding theme

Payment service details can only be accessed by specifically certified payment service partners. See our payment services integration guide for more details.

GET BrandingThemes

The following elements are returned in a GET BrandingThemes response

BrandingThemeID Xero identifier
Name Name of branding theme
SortOrder Integer - ranked order of branding theme. The default branding theme has a value of 0
CreatedDateUTC UTC timestamp of creation date of branding theme

Example response for BrandingThemes

GET https://api.xero.com/api.xro/2.0/BrandingThemes

Example response for an individual BrandingTheme

GET https://api.xero.com/api.xro/2.0/BrandingThemes/a94a78db-5cc6-4e26-a52b-045237e56e6e

GET PaymentServices

Use this method to retrieve the payment services applied to a branding theme.

The following elements are returned in the response

PaymentServiceID The Xero generated identifier for the payment service
PaymentServiceName The name of the payment service. Must be unique in a Xero Organisation
PaymentServiceUrl The custom payment URL. This URL should contain placeholders that will be replaced with relevant invoice data. These placeholders are [INVOICENUMBER], [CURRENCY], [AMOUNTDUE] & [SHORTCODE]
PayNowText The text displayed on the Pay Now button in Xero Online Invoicing. If this is not set it will default to ‘Pay by credit card’
PaymentServiceType This will always be CUSTOM for payment services created via the API.

Example response retrieving the payment services on a branding theme

GET https://api.xero.com/api.xro/2.0/BrandingThemes/{BrandingThemeID}/PaymentServices

POST PaymentServices

Use this method to apply a payment service to a branding theme

The following elements are required to apply a payment service to a branding theme
PaymentServiceID The identifier for the payment service being applied to the branding theme

Example request to apply a payment service to a branding theme

POST https://api.xero.com/api.xro/2.0/BrandingThemes/{BrandingThemeID}/PaymentServices