---
title: "Creates a new custom payment service for a specific branding theme"
method: POST
path: "/BrandingThemes/{BrandingThemeID}/PaymentServices"
tags: ["Accounting"]
---

# Creates a new custom payment service for a specific branding theme

`POST /BrandingThemes/{BrandingThemeID}/PaymentServices`

## Path parameters

- `BrandingThemeID` string, uuid, required

## Headers

- `Idempotency-Key` string

## Request body

- PaymentServices
  - `PaymentServices` PaymentService[]
    - `PaymentServiceID` string, uuid — Xero identifier
    - `PaymentServiceName` string — Name of payment service
    - `PaymentServiceUrl` string — The custom payment URL
    - `PayNowText` string — 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` string — This will always be CUSTOM for payment services created via the API.
    - `ValidationErrors` ValidationError[] — Displays array of validation error messages from the API
      - `Message` string — Validation error message

## Response `200`

Success - return response of type PaymentServices array with newly created PaymentService

- PaymentServices
  - `PaymentServices` PaymentService[]
    - `PaymentServiceID` string, uuid — Xero identifier
    - `PaymentServiceName` string — Name of payment service
    - `PaymentServiceUrl` string — The custom payment URL
    - `PayNowText` string — 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` string — This will always be CUSTOM for payment services created via the API.
    - `ValidationErrors` ValidationError[] — Displays array of validation error messages from the API
      - `Message` string — Validation error message

## Other responses

- `400` — A failed request due to validation error

---

[API](https://skmtc.net/xeroapi/apis/xero-accounting-api.md) · [All operations](https://skmtc.net/xeroapi/apis/xero-accounting-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/xeroapi/xero-accounting-api/revisions/dc231cafd8de/schema)