/
Preview payout request ba...

Preview payout request batch results
Experimental

Request

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.

Security
SecretApiKey or JWT
Query
filterstring

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.

Example:filter=status:pending;websiteId:ws_0YVDMDE2BMC6KBB5MX76RF6T80
curl -i -X GET \
  'https://www.rebilly.com/_mock/catalog/all/payout-request-batches/preview?filter=status%3Apending%3BwebsiteId%3Aws_0YVDMDE2BMC6KBB5MX76RF6T80' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'

Responses

Preview retrieved.

Bodyapplication/json
matchingCountinteger, >= 0

Total number of matching payout requests, regardless of the preview limit.

Example:42
customerCountinteger, >= 0

Number of unique customers in the matching payout requests.

Example:3
totalAmountByCurrencyArray of objects

Total amount grouped by currency for matching payout requests.

Response
{
  "matchingCount": 42,
  "customerCount": 3,
  "totalAmountByCurrency": [
    { … }
  ]
}