GET
/
Export
/
transferDetails
/
{format}
/
{entry}
/
{transferId}
curl --request GET \
  --url https://api-sandbox.payabli.com/api/Export/transferDetails/{format}/{entry}/{transferId} \
  --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

​
format
enum<string>
required

Format for the export, either XLSX or CSV.

Available options:
csv,
xlsx
Example:

"csv"

​
entry
string
required

The paypoint's entrypoint identifier. Learn more

Example:

"8cfec329267"

​
transferId
integer
required

Transfer identifier.

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
  • transferDetailId
  • transactionId
  • BatchNumber
  • type
  • Operation
  • category
  • method
  • grossAmount
  • chargeBackAmount
  • returnedAmount
  • billingFeesAmount
  • thirdPartyPaidAmount
  • adjustmentsAmount
  • netTransferAmount
  • holdAmount
  • releasedAmount
  • splitFundingAmount
  • FirstName
  • LastName
  • CustomerNumber
  • BillingAddress1
  • BillingAddress2
  • CompanyName
  • BillingCity
  • BillingCountry
  • BillingEmail
  • BillingPhone
  • BillingState
  • BillingZip
  • TransactionTime
  • MaskedAccount
  • AccountType
  • accountId
  • PaypointLegalname
  • PaypointDbaname
  • ParentOrgName
  • externalPaypointID
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:

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

  • transactionId (eq, ne, in, nin)

  • category (eq, ne, ct, nct)

  • type (eq, ne, in, nin)

  • method (eq, ne, 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
  • TransferDetailId
  • TransactionId
  • BatchNumber
  • Type
  • Operation
  • Category
  • Method
  • GrossAmount
  • ChargeBackAmount
  • ReturnedAmount
  • BillingFeesAmount
  • ThirdPartyPaidAmount
  • AdjustmentsAmount
  • NetTransferAmount
  • HoldAmount
  • ReleasedAmount
  • SplitFundingAmount
  • FirstName
  • LastName
  • CustomerNumber
  • Address1
  • Address2
  • Company
  • City
  • Country
  • Email
  • Phone
  • State
  • Zip
  • TransactionTime
  • MaskedAccount
  • AccountType
  • AccountId
  • PaypointLegalName
  • PaypointDbaName
  • ParentOrgName
  • externalPaypointID
  • clientId

Was this page helpful?