API referencePay Out endpointsPayout reporting

List payout batches for paypoint

Retrieve a list of MoneyOut batches for a paypoint. Use filters to limit results.

Path parameters

entrystringRequired

The paypoint’s entrypoint identifier. Learn more

Headers

requestTokenstringRequired

Query parameters

fromRecordintegerOptionalDefaults to 0
The number of records to skip before starting to collect the result set.
limitRecordintegerOptionalDefaults to 20

Max number of records to return for the query. Use 0 or negative value to return all records.

parametersmap from strings to optional stringsOptional
Collection of field names, conditions, and values used to filter the query. See [Filters and Conditions Reference](/developer-guides/reporting-filters-and-conditions-reference) for more information. **List of field names accepted**: - batchDate (gt, ge, lt, le, eq, ne) - batchNumber (ne, eq) - batchAmount (gt, ge, lt, le, eq, ne) - parentOrgId (ne, eq, nin, in) - status (in, nin, eq, ne) - orgId (eq) - paypointLegal (ne, eq, ct, nct) - paypointDba (ne, eq, ct, nct) - orgName (ne, eq, ct, nct) - paypointId (ne, eq) - externalPaypointID (ct, nct, eq, ne)
sortBystringOptional

The field name to use for sorting results. Use desc(field_name) to sort descending by field_name, and use asc(field_name) to sort ascending by field_name.

Response

Success
Recordslist of objects or null
Summaryobject or null

Errors