GET /payout-request-batches/preview

Retrieves aggregate information for the payout requests that match a specified filter.

If more than 1000 payout requests match the filter, only the oldest 1000 are included in the preview.

Servers

Query parameters

Name Type Required Description
filter String No

Filter string that is used to select payout requests. This field uses the same format as collection filter parameters.

Use semicolons to separate multiple filter conditions. Available filter fields: id, status, websiteId, customerId, currency, amount, createdTime, updatedTime.

If a batchId filter is provided, it is ignored. Payout requests that are already included in a batch are always excluded from the results.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. 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.
  3. Click Test request to test run your request to the API and see the API's response.