List payout batches for org
Retrieve a list of MoneyOut batches for an org. Use filters to limit results.
Path parameters
The numeric identifier for organization, assigned by Payabli.
Headers
Query parameters
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.
You must remove parameters=
from the request before you send it, otherwise Payabli will ignore the filters.
Because of a technical limitation, you can’t make a request that includes filters from the API console on this page. The response won’t be filtered. Instead, copy the request, remove parameters=
and run the request in a different client.
For example:
should become:
—url https://api-sandbox.payabli.com/api/Query/transactions/org/236?totalAmount(gt)=1000&limitRecord=20
See 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)
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