Export list of payouts for an entrypoint
Export a list of payouts and their statuses for an entrypoint. Use filters to limit results.
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
Authorizations
Most endpoints require an organization
token. Some endpoints require an application
token, and those endpoints are noted.
Path Parameters
Format for the export, either XLSX or CSV.
csv
, xlsx
"csv"
The paypoint's entrypoint identifier. Learn more
"8cfec329267"
Query Parameters
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.
x <= 30000
1000
The number of records to skip before starting to collect the result set.
251
Optional parameter for mapping source column names to custom export column names. The format is sourceColumn:exportColumn,sourceColumn2:exportColumn2
. Supported columns are:
- PaymentId
- Amount
- Status
- PaymentStatus
- BatchNumber
- VendorNumber
- LocationCode
- Name1
- PaypointDbaName
- PaypointLegalName
- OrgParentName
- externalPaypointID
- PaymentMethod
- TransactionTime
- Bills
"BatchDate:Batch_Date,PaypointName:Legal_name"
Collection of field names, conditions, and values used to filter the query.
See Filters and Conditions Reference for help.
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)
- paymentId (ct, nct, eq, ne)
- paymentgroup (ct, nct, eq, ne)
- totalAmount (gt, ge, lt, le, eq, ne)
- paypointLegal (ne, eq, ct, nct)
- paypointDba (ne, eq, ct, nct)
- orgName (ne, eq, ct, nct)
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
Example: totalAmount(gt)=20 return all records with totalAmount greater than 20.00
Response
The returned file includes the data exported. For the payouts export, the file includes these headers:
- PaymentId
- Amount
- Status
- PaymentStatus
- BatchNumber
- VendorNumber
- LocationCode
- VendorName1
- PaypointDbaName
- PaypointLegalName
- ParentOrgName
- externalPaypointID
- PaymentMethod
- TransactionDate
- Bills
Was this page helpful?