Export list of settled transactions for organization
Export a list of settled transactions for an organization. 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
The numeric identifier for organization, assigned by Payabli.
Query Parameters
Optional parameter for mapping source column names to custom export column names. The format is sourceColumn:exportColumn,sourceColumn2:exportColumn2
. Supported columns are:
- Id
- PaymentTransId
- OrderId
- Type
- Method
- TransMethod
- CompanyName
- FirstName
- LastName
- CustomerNumber
- BillingAddress1
- BillingAddress2
- BillingCity
- BillingCountry
- BillingEmail
- BillingPhone
- BillingState
- BillingZip
- SettledAmount
- NetAmount
- GatewayTransId
- ScheduleReference
- BatchNumber
- BatchAmount
- Operation
- Source
- TransactionTime
- MaskedAccount
- AccountType
- SettlementDate
- DepositDate
- PaypointDbaname
- PaypointLegalname
- ParentOrgName
- externalPaypointID
- invoiceNumber
- orderDescription
- accountId
- isHold
- PaymentTransStatus
Collection of field names, conditions, and values used to filter the query
See Filters and Conditions Reference for help.
List of field names accepted:
- settlementDate (gt, ge, lt, le, eq, ne)
- transId (ne, eq, ct, nct)
- gatewayTransId (ne, eq, ct, nct)
- method (in, nin, eq, ne)
- settledAmount (gt, ge, lt, le, eq, ne)
- operation (in, nin, eq, ne)
- source (in, nin, eq, ne)
- batchNumber (ct, nct, eq, ne)
- payaccountLastfour (nct, ct)
- payaccountType (ne, eq, in, nin)
- 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)
- orgId (eq) mandatory when entry=org
- paypointId (ne, eq)
- paypointLegal (ne, eq, ct, nct)
- paypointDba (ne, eq, ct, nct)
- orgName (ne, eq, ct, nct)
- additional-xxx (ne, eq, ct, nct) where xxx is the additional field name
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: settledAmount(gt)=20 returns all records with settledAmount greater than 20.00
Response
The returned file includes the data exported. For this export, the file includes these headers, along with any of your defined custom fields:
- Id
- TransId
- OrderId
- Type
- Method
- TransMethod
- Company
- FirstName
- LastName
- CustomerNumber
- Address1
- Address2
- City
- Country
- Phone
- State
- Zip
- SettledAmount
- NetAmount
- gatewayTransId
- ScheduleReference
- BatchNumber
- BatchAmount
- Operation
- Source
- TransactionTime
- MaskedAccount
- AccountType
- SettlementDate
- PaypointDbaName
- PaypointLegalName
- ParentOrgName
- externalPaypointID
- InvoiceNumber
- Notes
- accountId
- isHold
Was this page helpful?