PUT /PaymentServices
Servers
- https://api.xero.com/api.xro/2.0
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
xero-tenant-id |
String | Yes |
Xero identifier for Tenant |
Idempotency-Key |
String | No |
This allows you to safely retry requests without the risk of duplicate processing. 128 character max. |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
PaymentServices[] |
Array | No | |
PaymentServices[].PayNowText |
String | No |
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 |
PaymentServices[].PaymentServiceID |
String | No |
Xero identifier |
PaymentServices[].ValidationErrors[] |
Array | No |
Displays array of validation error messages from the API |
PaymentServices[].ValidationErrors[].Message |
String | No |
Validation error message |
PaymentServices[].PaymentServiceType |
String | No |
This will always be CUSTOM for payment services created via the API. |
PaymentServices[].PaymentServiceName |
String | No |
Name of payment service |
PaymentServices[].PaymentServiceUrl |
String | No |
The custom payment URL |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.