Export list of batches for entrypoint
Export a list of batches for an entrypoint. Use filters to limit results.
Request
- Base URL: https://api-sandbox.payabli.com/api
- URL: https://api-sandbox.payabli.com/api/Export/batches/{format}/{entry}
- Auth: HTTP bearer
Path parameters
The paypoint's entrypoint identifier. Learn more
Format for the export, either XLSX or CSV.
Query parameters
The number of records to skip before starting to collect the result set.
The number of records to return for the query. The maximum is 30,000 records. When this parameter isn't sent, the API returns up to 25,000 records.
Collection of field names, conditions, and values used to filter the query
<Info> **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 </Info>
See Filters and Conditions Reference for help.
Accepted field names:
- batchDate (gt, ge, lt, le, eq, ne)
- batchNumber (ne, eq)
- connectorName (ne, eq, ct, nct)
- method (in, nin, eq, ne)
- batchAmount (gt, ge, lt, le, eq, ne)
- feeBatchAmount (gt, ge, lt, le, eq, ne)
- netBatchAmount (gt, ge, lt, le, eq, ne)
- releaseAmount (gt, ge, lt, le, eq, ne)
- heldAmount (gt, ge, lt, le, eq, ne)
- status (in, nin, eq, ne)
- paypointLegal (ne, eq, ct, nct)
- paypointDba (ne, eq, ct, nct)
- orgName (ne, eq, ct, nct)
- paypointId (ne, eq)
- externalPaypointID (ct, nct, eq, ne)
- expectedDepositDate (gt, ge, lt, le, eq, ne)
- batchRecords (gt, ge, lt, le, eq, ne)
- transferId (ne, eq)
- transferDate (gt, ge, lt, le, eq, ne)
- grossAmount (gt, ge, lt, le, eq, ne)
- chargeBackAmount (gt, ge, lt, le, eq, ne)
- returnedAmount (gt, ge, lt, le, eq, ne)
- billingFeeAmount (gt, ge, lt, le, eq, ne)
- thirdPartyPaidAmount (gt, ge, lt, le, eq, ne)
- netFundedAmount (gt, ge, lt, le, eq, ne)
- adjustmentAmount (gt, ge, lt, le, eq, ne)
- processor (ne, eq, ct, nct)
- transferStatus (ne, eq, in, nin)
Accepted parameters:
- limitRecord: max number of records for query (default="20", "0" or negative value for all)
- fromRecord: initial record in query
Example: batchAmount(gt)=20 returns all records with a batchAmount greater than 20.00
Response
Success
A file containing the response data, in the format specified in the request.
Changes
No recorded changes to this operation across all 1 revision of this API.