Get list of MoneyOut batches for a paypoint
Retrieve a list of MoneyOut batches for a paypoint. Use filters to limit results. Include the exportFormat query parameter to return the results as a file instead of a JSON response.
Request
- Base URL: https://api-sandbox.payabli.com/api
- URL: https://api-sandbox.payabli.com/api/Query/batchesOut/{entry}
- Auth: HTTP bearer
Path parameters
The entity's entrypoint identifier. Learn more.
The entity's entrypoint identifier. Learn more
Query parameters
Export format for file downloads. When specified, returns data as a file instead of JSON.
Export format for file downloads. When specified, returns data as a file instead of JSON.
The number of records to skip before starting to collect the result set.
Max number of records to return for the query. Use 0 or negative value to return all records.
Collection of field names, conditions, and values used to filter the query. See Filters and Conditions Reference for more information.
Accepted field names:
- 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)
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
Changes
No recorded changes to this operation across all 1 revision of this API.