Query

Get list of transactions for a paypoint

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

By default, this endpoint returns only transactions from the last 60 days. To query transactions outside of this period, include transactionDate filters.

These request parameters filter for transactions between April 1, 2024 and April 9, 2024.

curl -X GET https://api-sandbox.payabli.com/api/Query/transactions/8cfec329267?limitRecord=20&fromRecord=0&transactionDate(ge)=2024-04-01T00:00:00&transactionDate(le)=2024-04-09T23:59:59 \
  -H 'requestToken: <API TOKEN>'
get/Query/transactions/{entry}

Request

  • Base URL: https://api-sandbox.payabli.com/api
  • URL: https://api-sandbox.payabli.com/api/Query/transactions/{entry}
  • Auth: HTTP bearer

Path parameters

entrystring required

The entity's entrypoint identifier. Learn more.

The entity's entrypoint identifier. Learn more

Query parameters

exportFormat'csv' | 'xlsx'

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.

fromRecordinteger

The number of records to skip before starting to collect the result set.

limitRecordinteger

Max number of records to return for the query. Use 0 or negative value to return all records.

parametersobject

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:

--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 </Info> See Filters and Conditions Reference for more information.

Accepted field names:

  • transactionDate (gt, ge, lt, le, eq, ne)
  • transId (ne, eq, ct, nct, in, nin)
  • gatewayTransId (ne, eq, ct, nct)
  • orderId (ne, eq)
  • scheduleId (ne, eq)
  • returnId (ne, eq)
  • refundId (ne, eq)
  • rejectId (ne, eq)
  • idTrans (ne, eq)
  • orgId (ne, eq)
  • paypointId (ne, eq)
  • paypointLegal (ne, eq, ct, nct)
  • paypointDba (ne, eq, ct, nct)
  • orgName (ne, eq, ct, nct)
  • externalPaypointId (ct, nct, eq, ne)
  • method (in, nin, eq, ne)
  • totalAmount (gt, ge, lt, le, eq, ne)
  • netAmount (gt, ge, lt, le, eq, ne)
  • feeAmount (gt, ge, lt, le, eq, ne)
  • operation (in, nin, eq, ne)
  • source (in, nin, eq, ne, ct, nct)
  • status (in, nin, eq, ne)
  • settlementStatus (in, nin, eq, ne)
  • batchNumber (nct, ct)
  • invoiceNumber (ct, nct)
  • ipAddress (eq, ne)
  • authCode (ct, nct)
  • orderDescription (ct, nct)
  • payaccountLastfour (nct, ct)
  • payaccountType (ne, eq, in, nin)
  • payaccountCurrency (ne, eq, in, nin)
  • binCardType (eq, ne, in, nin). Filters by card type for card transactions. Accepts CREDIT, DEBIT, or PREPAID. Case-insensitive.
  • customerFirstname (ct, nct, eq, ne)
  • customerLastname (ct, nct, eq, ne)
  • customerName (ct, nct)
  • customerId (eq, ne)
  • customerNumber (ct, nct, eq, ne)
  • customerCompanyname (ct, nct, eq, ne)
  • customerAddress (ct, nct, eq, ne)
  • customerCity (ct, nct, eq, ne)
  • customerZip (ct, nct, eq, ne)
  • customerState (ct, nct, eq, ne)
  • customerCountry (ct, nct, eq, ne)
  • customerPhone (ct, nct, eq, ne)
  • customerEmail (ct, nct, eq, ne)
  • customerShippingAddress (ct, nct, eq, ne)
  • customerShippingCity (ct, nct, eq, ne)
  • customerShippingZip (ct, nct, eq, ne)
  • customerShippingState (ct, nct, eq, ne)
  • customerShippingCountry (ct, nct, eq, ne)
  • deviceId (ct, nct, in, nin, eq, ne)
  • AchSecCode ( ct, nct, in, nin, eq, ne)
  • AchHolderType (ct, nct, in, nin, eq, and ne)
  • additional-xxx (ne, eq, ct, nct) where xxx is the additional field name related to customer data
  • 'invoiceAdditional-xxx' (ne, eq, ct, nct) where xxx is the additional field name related to invoice data

Accepted comparison operators:

  • 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
  • nin => not inside array
sortBystring

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.