POST /payout-request-batches
Creates a batch of payout requests for batch processing.
The batch links multiple payout requests together so they can be auto-allocated and processed together.
Each payout request can be assigned to only one batch.
If any of the specified payout requests are already included in another batch, a 409 Conflict error is returned.
Both approaches are limited to a maximum of 1000 payout requests per batch.
Two mutually exclusive approaches are supported:
- Explicit IDs: Provide an array of payout request IDs in the
payoutRequestIdsfield. - Filter-based: Provide a
filterstring to select payout requests that match the specified criteria at execution time. Payout requests that are already included in a batch are automatically excluded from the filter results. If more than 1000 payout requests match the filter, only the oldest 1000 are included in the batch, sorted by creation time. To view the number of matching items before creating the batch, use the Preview payout request batch filter results operation.
Servers
- https://api-sandbox.rebilly.com/organizations/{organizationId}
- https://api.rebilly.com/organizations/{organizationId}
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
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.