GET
/
Export
/
transfers
/
{entry}
curl --request GET \
  --url https://api-sandbox.payabli.com/api/Export/transfers/{entry} \
  --header 'requestToken: <api-key>'
{}

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

Example:

"8cfec329267"

Query Parameters

​
limitRecord
integer
default:25000

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.

Required range: x <= 30000
Example:

1000

​
fromRecord
integer
default:0

The number of records to skip before starting to collect the result set.

Example:

251

​
sortBy
string

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.

Example:

"desc(field_name)"

​
columnsExport
string

Optional parameter for mapping source column names to custom export column names. The format is sourceColumn:exportColumn,sourceColumn2:exportColumn2. Supported columns are:

  • transferId
  • batchNumber
  • batchId
  • transferDate
  • processor
  • transferStatus
  • grossAmount
  • chargeBackAmount
  • returnedAmount
  • billingFeesAmount
  • thirdPartyPaidAmount
  • adjustmentsAmount
  • netTransferAmount
Example:

"BatchDate:Batch_Date,PaypointName:Legal_name"

​
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:

  • 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)

  • batchNumber (ne, eq, ct, nct)

  • batchId (ne, eq, in, nin)

Response

200 - application/json
Success

The returned file includes the data exported. For this export, the file includes these headers, plus any custom fields configured for the entrypoint:

  • TransferId
  • BatchNumber
  • BatchId
  • TransferDate
  • Processor
  • TransferStatus
  • GrossAmount
  • ChargeBackAmount
  • ReturnedAmount
  • BillingFeesAmount
  • ThirdPartyPaidAmount
  • AdjustmentsAmount
  • NetFundedAmount

Was this page helpful?

Export list of transfer detailsExport list of chargebacks and returned transactions for entrypoint