API referencePay In endpointsCustomer

Export customers by org

Exports a list of customers for an organization. Use filters to limit results.

Path parameters

formatenumRequired
Format for the export, either XLSX or CSV.
Allowed values:
orgIdintegerRequired
The numeric identifier for organization, assigned by Payabli.

Headers

requestTokenstringRequired

Query parameters

columnsExportstringOptionalformat: "^([a-zA-Z_][a-zA-Z0-9_]*:[a-zA-Z_][a-zA-Z0-9_]*,)*([a-zA-Z_][a-zA-Z0-9_]*:[a-zA-Z_][a-zA-Z0-9_]*)$"
fromRecordintegerOptionalDefaults to 0
The number of records to skip before starting to collect the result set.
limitRecordintegerOptional<=30000Defaults to 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.
parametersmap from strings to optional stringsOptional

Collection of field names, conditions, and values used to filter the query.

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

See Filters and Conditions Reference for help.

List of field names accepted:

  • createdDate (gt, ge, lt, le, eq, ne)
  • customernumber (ne, eq, ct, nct)
  • firstname (ne, eq, ct, nct)
  • lastname (ne, eq, ct, nct)
  • name (ct, nct)
  • address (ne, eq, ct, nct)
  • city (ne, eq, ct, nct)
  • country (ne, eq, ct, nct)
  • zip (ne, eq, ct, nct)
  • state (ne, eq, ct, nct)
  • shippingaddress (ne, eq, ct, nct)
  • shippingcity (ne, eq, ct, nct)
  • shippingcountry (ne, eq, ct, nct)
  • shippingzip (ne, eq, ct, nct)
  • shippingstate (ne, eq, ct, nct)
  • phone (ne, eq, ct, nct)
  • email (ne, eq, ct, nct)
  • company (ne, eq, ct, nct)
  • username (ne, eq, ct, nct)
  • balance (gt, ge, lt, le, eq, ne)
  • status (in, nin, eq, ne)
  • additional-xxx (ne, eq, ct, nct) where xxx is the additional field name
  • orgId (eq) mandatory when entry=org
  • paypointId (ne, eq)
  • paypointLegal (ne, eq, ct, nct)
  • paypointDba (ne, eq, ct, nct)
  • orgName (ne, eq, 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 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: balance(gt)=20 return all records with balance greater than 20.00

Response

Success

Errors