GET
/
Export
/
batchDetails
/
{format}
/
{entry}

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

Authorizations

​
requestToken
string
header
required

Most endpoints require an organization token. Some endpoints require an application token, and those endpoints are noted.

Path Parameters

​
entry
string
required

The paypoint's entrypoint identifier. Learn more

​
format
enum<string>
required

Format for the export, either XLSX or CSV.

Available options:
csv,
xlsx

Query Parameters

​
columnsExport
string

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
  • Notes
  • accountId
  • isHold
  • PaymentTransStatus
​
parameters
object

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)
  • depositDate (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
  • isHold (eq, ne)
  • paypointId (ne, eq)
  • paypointLegal (ne, eq, ct, nct)
  • paypointDba (ne, eq, ct, nct)
  • orgName (ne, eq, ct, nct)
  • batchId (ct, nct, eq, neq)
  • additional-xxx (ne, eq, ct, nct) where xxx is the additional field name

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: amount(gt)=20 return all records with amount greater than 20.00

Response

200 - application/json

The returned file includes the data exported.

Was this page helpful?

Export list of pay out batches for organizationExport batch details for an org