API referencePay In endpointsTransaction reporting

List batches for paypoint

Retrieve a list of 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.

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:

—url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20

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)
  • method (in, nin, eq, ne)
  • connectorName (ne, eq, ct, nct)
  • 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)
  • depositDate (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)

List of parameters accepted:

  • 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 batchAmount greater than 20.00

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 objectsOptional
SummaryobjectOptional

Errors