Xero: Retrieves the payment services for a specific branding theme

← Accounting operations · Get started

Operation xero.getbrandingthemepaymentservices

Provider route: GET /api.xro/2.0/BrandingThemes/{BrandingThemeID}/PaymentServices. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/xero with npm, or alter-sdk-xero with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { XeroIntegration } from "@alter-ai/xero";

async function execute(input: Parameters<XeroIntegration["accounting"]["getBrandingThemePaymentServices"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new XeroIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.accounting.getBrandingThemePaymentServices(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_xero import XeroIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = XeroIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.accounting.get_branding_theme_payment_services(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.BrandingThemeID	string	Required within parent	Format: uuid
headers	object	Required within parent	Additional keys: not allowed
headers.xero-tenant-id	string	Required within parent

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	Model	Root	Expand Creates a payment service — response body

Referenced models: Creates a payment service — response body

Schemas

Creates a payment service — response body

Field	Type	Presence	Description and constraints
$	object	Root
PaymentServices	array	Optional
PaymentServices[]	Model	Each item	Expand Creates a payment service — response body — Payment Services item

Referenced models: Creates a payment service — response body — Payment Services item

Creates a payment service — response body — Payment Services item

Field	Type	Presence	Description and constraints
$	JSON	Root
PayNowText	string	Optional	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
PaymentServiceID	string	Optional	Xero identifier Format: uuid
PaymentServiceName	string	Optional	Name of payment service
PaymentServiceType	string	Optional	This will always be CUSTOM for payment services created via the API.
PaymentServiceUrl	string	Optional	The custom payment URL
ValidationErrors	array	Optional	Displays array of validation error messages from the API
ValidationErrors[]	Model	Each item	Expand Retrieves journals — response body — Warnings item

Referenced models: Retrieves journals — response body — Warnings item

Retrieves journals — response body — Warnings item

Field	Type	Presence	Description and constraints
$	object	Root
Message	string	Optional	Validation error message

Policy, approvals and errors

SDK function policy ID: xero.getbrandingthemepaymentservices. Catalog operation: getBrandingThemePaymentServices. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Official provider source