Xero · Schema

PaymentService

AccountingBank FeedsFinanceFinancial ServicesInvoicingPayrollSmall Business

Properties

Name Type Description
PaymentServiceID string 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 array Displays array of validation error messages from the API
View JSON Schema on GitHub

JSON Schema

xero-paymentservice-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PaymentService",
  "title": "PaymentService",
  "externalDocs": {
    "url": "http://developer.xero.com/documentation/api/branding-themes/"
  },
  "properties": {
    "PaymentServiceID": {
      "description": "Xero identifier",
      "type": "string",
      "format": "uuid"
    },
    "PaymentServiceName": {
      "description": "Name of payment service",
      "type": "string"
    },
    "PaymentServiceUrl": {
      "description": "The custom payment URL",
      "type": "string"
    },
    "PayNowText": {
      "description": "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",
      "type": "string"
    },
    "PaymentServiceType": {
      "description": "This will always be CUSTOM for payment services created via the API.",
      "type": "string"
    },
    "ValidationErrors": {
      "description": "Displays array of validation error messages from the API",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ValidationError"
      }
    }
  }
}