Get list of money out transactions for paypoint
Retrieves a list of money out transactions (payouts) 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.
Request
- Base URL: https://api-sandbox.payabli.com/api
- URL: https://api-sandbox.payabli.com/api/Query/payouts/{entry}
- Auth: HTTP bearer
Path parameters
The entity's entrypoint identifier. Learn more.
The entity's entrypoint identifier. Learn more
Query parameters
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.
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. <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>
Accepted field names:
- 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)
- orderId (ne, eq)
- 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)
- AchTraceNumber (eq, ne)
- payoutProgram(eq, ne) the options are managed or odp. For example, payoutProgram(eq)=managed returns all records with a payoutProgram equal to managed.
Accepted comparison operators - 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 "|"
Accepted parameters:
- 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 a netAmount greater than 20.00
Example: sortBy=desc(netamount) returns all records sorted by netAmount descending
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.