Retrieve payout request batches
Experimental

Request

Retrieves a list of payout request batches.
Security
SecretApiKey or JWT
Query
limitinteger, [ 0 .. 1000 ]

Limit the number of collection items to be returned. Use 0 to return an empty collection and still receive the count of matching items in Pagination-Total.

offsetinteger, [ 0 .. 1000 ]
Specifies the starting point within the collection of items to be returned.
qstring
Use this field to perform a partial search of text fields.
filterstring

Criteria for filtering collection items. This field requires a special format. Use , to specify multiple allowed values. Use ; to specify multiple fields.

For more information, see Search filters.

sortArray of strings

Sorts and orders the collection of items. To sort in descending order, prefix with -. Multiple fields can be sorted by separating each with ,.

curl -i -X GET \
  'https://www.rebilly.com/_mock/catalog/all/payout-request-batches?limit=0&offset=0&q=string&filter=string&sort=string' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'

Responses

List of payout request batches retrieved.
Headers
Pagination-Totalinteger

Total number of items that match the request. The value is independent of limit, including when limit is 0.

Example:332
Pagination-Limitinteger
Maximum number of items per page.
Example:100
Pagination-Offsetinteger

Specifies the starting point within the collection of resource results. For example, a request with limit=20 retrieves and displays the first 20 results on a page. A following request with limit=20 and offset=20, retrieves the next page of 20 results.

Example:2
Bodyapplication/json
Array [
idstring, <= 50 charactersread-only
ID of the batch.
Example:"prb_0YVDMDE2BMC6KBB5MX76RF6T80"
userIdstring, <= 50 charactersread-only
ID of the user who created the batch.
Example:"usr_0YVCEENYJ3D7Q9EN6BN16HA0G4"
userobjectread-only
Creator of the batch.
totalCountinteger, >= 0read-only
Total number of payout requests in the batch.
Example:10
customerCountinteger, >= 0read-only
Number of unique customers in the batch.
Example:3
totalAmountByCurrencyArray of objectsread-only
Total payout amount grouped by currency in the batch.
namestring or null, <= 255 characters

Name that is used to identify the batch. This value is null if the batch has no name.

Example:"Weekly CAD payouts"
descriptionstring or null, <= 255 characters
Optional description of the batch.
Example:"Batch processed on 2024-01-15"
allocationOrderArray of strings or null, [ 2 .. 25 ] items, unique

Order for auto-allocation of payout requests in this batch. When set, this field overrides the organization-level allocation order during batch auto-allocation. Must contain selected-payment-instrument exactly once. Valid values: payment-card (payment cards), alternative-payment-methods (catch-all for alternative payment methods), selected-payment-instrument (customer-requested instrument), or any payment method API name (for example, paypal, Interac-eTransfer).

Example:
[
  "paypal",
  "Interac-eTransfer",
  "payment-card",
  "alternative-payment-methods",
  "selected-payment-instrument"
]
createdTimestring, (date-time)(CreatedTime)read-only
Date and time when the batch was created.
updatedTimestring, (date-time)(UpdatedTime)read-only
Date and time when the batch was last updated.
_linksArray of objectsread-only
Related links.
]
Response
[
  {
    "id": "prb_0YVDMDE2BMC6KBB5MX76RF6T80",
    "userId": "usr_0YVCEENYJ3D7Q9EN6BN16HA0G4",
    "user": { … },
    "totalCount": 10,
    "customerCount": 3,
    "totalAmountByCurrency": [ … ],
    "name": "Weekly CAD payouts",
    "description": "Batch processed on 2024-01-15",
    "allocationOrder": [ … ],
    "createdTime": "2019-08-24T14:15:22Z",
    "updatedTime": "2019-08-24T14:15:22Z",
    "_links": [ … ]
  }
]