POST /BatchPayments/{BatchPaymentID}
Servers
- https://api.xero.com/api.xro/2.0
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
BatchPaymentID |
String | Yes |
Unique identifier for BatchPayment |
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 |
|---|---|---|---|
Status |
String | Yes |
The status of the batch payment. Default value: "DELETED" |
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.