GET
/
Export
/
chargebacks
/
{format}
/
org
/
{orgId}
curl --request GET \
  --url https://api-sandbox.payabli.com/api/Export/chargebacks/{format}/org/{orgId} \
  --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"

​
orgId
integer
required

The numeric identifier for organization, assigned by Payabli.

Example:

123

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

​
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
  • Method
  • CompanyName
  • FirstName
  • LastName
  • CustomerNumber
  • BillingAddress1
  • BillingAddress2
  • BillingCity
  • BillingCountry
  • BillingEmail
  • BillingPhone
  • BillingState
  • BillingZip
  • NetAmount
  • ReferenceNumber
  • Status
  • CaseNumber
  • ReasonCode
  • Reason
  • TransactionTime
  • MaskedAccount
  • AccountType
  • ChargebackDate
  • PaypointLegalname
  • PaypointDbaname
  • ParentOrgName
  • ScheduleReference
  • externalPaypointID
  • accountId
  • ReplyByDate
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:

  • chargebackDate (gt, ge, lt, le, eq, ne)
  • transId (ne, eq, ct, nct)
  • method (in, nin, eq, ne)
  • netAmount (gt, ge, lt, le, eq, ne)
  • reasonCode (in, nin, eq, ne)
  • reason (ct, nct, eq, ne)
  • caseNumber (ct, nct, eq, ne)
  • status (in, nin, eq, ne)
  • accountType (in, nin, 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: netAmount(gt)=20 return all records with netAmount greater than 20.00

Response

200 - application/json
Success

The returned file includes the data exported. For the chargebacks and returns export, the file includes these headers, plus any custom fields defined:

  • Id
  • TransId
  • OrderId
  • Method
  • Company
  • FirstName
  • LastName
  • CustomerNumber
  • Address1
  • Address2
  • City
  • Country
  • Email
  • Phone
  • State
  • Zip
  • NetAmount
  • ReferenceNumber
  • Status
  • CaseNumber
  • ReasonCode
  • Reason
  • TransactionTime
  • MaskedAccount
  • AccountType
  • ChargebackDate
  • PaypointLegalName
  • PaypointDbaName
  • ParentOrgName
  • ScheduleReference
  • externalPaypointID
  • accountId
  • clientId
  • invoiceFrequency
  • invoiceScheduled
  • invoiceStartDate

Was this page helpful?

Export list of chargebacks and returned transactions for entrypointExport list of customers for entrypoint