Export list of batches for organization
Export a list of batches 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
The numeric identifier for organization, assigned by Payabli.
Format for the export, either XLSX or CSV.
csv
, xlsx
Query Parameters
Optional parameter for mapping source column names to custom export column names. The format is sourceColumn:exportColumn,sourceColumn2:exportColumn2
. Supported columns are:
- IdBatch
- BatchDate
- ExpectedDepositDate
- DepositDate
- Method
- BatchNumber
- BatchStatus
- PaypointId
- BatchAmount
- BatchFeesAmount
- BatchAuthAmount
- BatchHoldAmount
- BatchReleasedAmount
- BatchReturnedAmount
- BatchRefundAmount
- BatchSplitAmount
- BatchRecords
- PaypointName
- PaypointDba
- ParentOrgName
- externalPaypointID
- EntryName
- TransferId
- TransferDate
- Processor
- TransferStatus
- GrossAmount
- ChargeBackAmount
- ReturnedAmount
- RefundAmount
- BillingFeesAmount
- ThirdPartyPaidAmount
- AdjustmentsAmount
- NetFundedAmount
- ConnectorName
Collection of field names, conditions, and values used to filter the query
See Filters and Conditions Reference for help.
List of field names accepted:
- batchDate (gt, ge, lt, le, eq, ne)
- batchNumber (ne, eq)
- connectorName (ne, eq, ct, nct)
- method (in, nin, eq, ne)
- batchAmount (gt, ge, lt, le, eq, ne)
- feeBatchAmount (gt, ge, lt, le, eq, ne)
- netBatchAmount (gt, ge, lt, le, eq, ne)
- releaseAmount (gt, ge, lt, le, eq, ne)
- heldAmount (gt, ge, lt, le, eq, ne)
- status (in, nin, eq, ne)
- paypointLegal (ne, eq, ct, nct)
- paypointDba (ne, eq, ct, nct)
- orgName (ne, eq, ct, nct)
- paypointId (ne, eq)
- externalPaypointID (ct, nct, eq, ne)
- expectedDepositDate (gt, ge, lt, le, eq, ne)
- batchRecords (gt, ge, lt, le, eq, ne)
- transferId (ne, eq)
- transferDate(gt, ge, lt, le, eq, ne)
- grossAmount (gt, ge, lt, le, eq, ne)
- chargeBackAmount (gt, ge, lt, le, eq, ne)
- returnedAmount (gt, ge, lt, le, eq, ne)
- billingFeeAmount (gt, ge, lt, le, eq, ne)
- thirdPartyPaidAmount (gt, ge, lt, le, eq, ne)
- netFundedAmount (gt, ge, lt, le, eq, ne)
- adjustmentAmount (gt, ge, lt, le, eq, ne)
- processor (ne, eq, ct, nct)
- transferStatus (ne, eq, in, nin)
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: batchAmount(gt)=20 return all records with batchAmount greater than 20.00"
Response
The returned file includes the data exported. For the batch export, the file includes these headers:
- Id
- BatchDate
- Method
- BatchNumber
- BatchStatus
- PaypointId
- BatchAmount
- BatchFeesAmount
- BatchAuthAmount
- BatchHoldAmount
- BatchReleasedAmount
- BatchReturnedAmount
- BatchRefundAmount
- BatchSplitAmount
- BatchRecords
- PaypointName
- PaypointDba
- ParentOrgName
- externalPaypointID
- EntryName
- TransferId
- TransferDate
- Processor
- TransferStatus
- GrossAmount
- ChargeBackAmount
- ReturnedAmount
- RefundAmount
- BillingFeesAmount
- ThirdPartyPaidAmount
- AdjustmentsAmount
- NetFundedAmount
- ConnectorName
Was this page helpful?