API referencePay Out endpointsPayout reporting

List payouts by paypoint

Retrieves a list of money out transactions (payouts) 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

List of field names accepted:

  • status (in, nin, eq, ne)
  • transactionDate (gt, ge, lt, le, eq, ne)
  • billNumber (ct, nct)
  • vendorNumber (ct, nct, eq, ne)
  • vendorName (ct, nct, eq, ne)
  • paymentMethod (ct, nct, eq, ne, in, nin)
  • paymentId (ct, nct, eq, ne)
  • parentOrgId (ne, eq, nin, in)
  • batchNumber (ct, nct, eq, ne)
  • totalAmount (gt, ge, lt, le, eq, ne)
  • paypointLegal (ne, eq, ct, nct)
  • paypointDba (ne, eq, ct, nct)
  • accountId (ne, eq, ct, nct)
  • orgName (ne, eq, ct, nct)
  • externalPaypointID (ct, nct, eq, ne)
  • paypointId (eq, ne)
  • vendorId (eq, ne)
  • vendorEIN (ct, nct, eq, ne)
  • vendorPhone (ct, nct, eq, ne)
  • vendorEmail (ct, nct, eq, ne)
  • vendorAddress (ct, nct, eq, ne)
  • vendorCity (ct, nct, eq, ne)
  • vendorState (ct, nct, eq, ne)
  • vendorCountry (ct, nct, eq, ne)
  • vendorZip (ct, nct, eq, ne)
  • vendorMCC (ct, nct, eq, ne)
  • vendorLocationCode (ct, nct, eq, ne)
  • vendorCustomField1 (ct, nct, eq, ne)
  • vendorCustomField2 (ct, nct, eq, ne)
  • comments (ct, nct)
  • payaccountCurrency (ne, eq, in, nin)
  • remitAddress (ct, nct)
  • source (ct, nct, eq, ne)
  • updatedOn (gt, ge, lt, le, eq, ne)
  • feeAmount (gt, ge, lt, le, eq, ne)
  • lotNumber (ct, nct)
  • customerVendorAccount (ct, nct, eq, ne)
  • batchId (eq, ne)

List of comparison accepted - enclosed between parentheses:

  • eq or empty => equal
  • gt => greater than
  • ge => greater or equal
  • lt => less than
  • le => less or equal
  • ne => not equal
  • ct => contains
  • nct => not contains
  • in => inside array separated by ”|”
  • nin => not inside array separated by ”|”

List of parameters accepted:

  • limitRecord : max number of records for query (default=“20”, “0” or negative value for all)
  • fromRecord : initial record in query
  • sortBy : indicate field name and direction to sort the results

Example: netAmount(gt)=20 returns all records with netAmount greater than 20.00

Example: sortBy=desc(netamount) returns all records sorted by netAmount descending

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