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

​
fromRecord
integer
default:0

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

Example:

251

​
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

​
columnsExport
string

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

  • IdPaypoint
  • OrgId
  • ExternalOrgID
  • DbaName
  • LegalName
  • BAddress1
  • BAddress2
  • BCity
  • BState
  • BZip
  • BPhone
  • BStartdate
  • Ein
  • HighTicketAmount
  • AverageTicketAmount
  • AverageMonthlyVolume
  • SalesCode
  • TemplateId
  • BoardingId
  • externalPaypointID
  • ExternalProcessorInformation
  • EntryName
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:

  • createdAt (gt, ge, lt, le, eq, ne)
  • startDate (gt, ge, lt, le, eq, ne)
  • dbaname (ct, nct)
  • legalname (ct, nct)
  • ein (ct, nct)
  • address (ct, nct)
  • city (ct, nct)
  • state (ct, nct)
  • phone (ct, nct)
  • mcc (ct, nct)
  • owntype (ct, nct)
  • ownerName (ct, nct)
  • contactName (ct, nct)
  • orgParentname (ct, nct)

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
  • nin => not inside array

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: dbaname(ct)=hoa return all records with dbname containing "hoa"

Response

200 - application/json
Success

Was this page helpful?