List batches for org

curl -G https://api-sandbox.payabli.com/api/Query/batches/org/123 \
     -H "requestToken: <apiKey>" \
     -d fromRecord=251 \
     -d limitRecord=0 \
     -d sortBy=desc(field_name)

{
  "Records": [
    {
      "BatchAmount": 0,
      "BatchAuthAmount": 0,
      "BatchDate": "2025-04-19T19:01:05Z",
      "BatchFeesAmount": 0,
      "BatchHoldAmount": 0,
      "BatchNumber": "BT-2023041919-187",
      "BatchRecords": 2,
      "BatchRefundAmount": 0,
      "BatchReleasedAmount": 0,
      "BatchReturnedAmount": 0,
      "BatchSplitAmount": 0,
      "BatchStatus": 2,
      "ConnectorName": "",
      "EntryName": "d193cf9a46",
      "ExpectedDepositDate": "2025-04-20T00:00:00Z",
      "externalPaypointID": "",
      "IdBatch": 1049,
      "Method": "card",
      "ParentOrgName": "PayabliDemoAccount(PB)",
      "PaypointDba": "The Board Haus",
      "PaypointId": 187,
      "PaypointName": "Board Haus LLC.",
      "TransferDate": "2025-09-02T00:00:00Z"
    },
    {
      "BatchAmount": 219.02,
      "BatchAuthAmount": 0,
      "BatchDate": "2025-04-18T17:01:03Z",
      "BatchFeesAmount": 0,
      "BatchHoldAmount": 0,
      "BatchNumber": "BT-2023041817-187",
      "BatchRecords": 1,
      "BatchRefundAmount": 0,
      "BatchReleasedAmount": 0,
      "BatchReturnedAmount": 0,
      "BatchSplitAmount": 0,
      "BatchStatus": 2,
      "ConnectorName": "",
      "EntryName": "47acde389b",
      "ExpectedDepositDate": "2025-04-19T00:00:00Z",
      "externalPaypointID": "",
      "IdBatch": 1043,
      "Method": "card",
      "ParentOrgName": "PayabliDemoAccount(PB)",
      "PaypointDba": "The Board Haus",
      "PaypointId": 187,
      "PaypointName": "Board Haus LLC.",
      "TransferDate": "2025-09-02T00:00:00Z"
    },
    {
      "BatchAmount": 1080.44,
      "BatchAuthAmount": 0,
      "BatchDate": "2025-04-14T21:01:03Z",
      "BatchFeesAmount": 0,
      "BatchHoldAmount": 0,
      "BatchNumber": "BT-2023041421-187",
      "BatchRecords": 4,
      "BatchRefundAmount": 0,
      "BatchReleasedAmount": 0,
      "BatchReturnedAmount": 0,
      "BatchSplitAmount": 0,
      "BatchStatus": 2,
      "ConnectorName": "",
      "EntryName": "d193cf9a46",
      "ExpectedDepositDate": "2025-04-15T00:00:00Z",
      "externalPaypointID": "",
      "IdBatch": 1012,
      "Method": "card",
      "ParentOrgName": "PayabliDemoAccount(PB)",
      "PaypointDba": "The Board Haus",
      "PaypointId": 187,
      "PaypointName": "Board Haus LLC.",
      "TransferDate": "2025-09-02T00:00:00Z"
    }
  ],
  "Summary": {
    "pageSize": 20,
    "totalAmount": 54049.71,
    "totalNetAmount": 0,
    "totalPages": 3,
    "totalRecords": 3
  }
}

Retrieve a list of batches for an org. Use filters to limit results.

Authentication

requestTokenstring

API Key authentication via header

Path parameters

orgIdintegerRequired

The numeric identifier for organization, assigned by Payabli.

Query parameters

fromRecordintegerOptionalDefaults to 0

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

limitRecordintegerOptionalDefaults to 20

Max number of records to return for the query. Use 0 or negative value to return all 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 more information.

List of field names accepted:

batchDate (gt, ge, lt, le, eq, ne)
batchNumber (ne, eq)
method (in, nin, eq, ne)
connectorName (ne, eq, ct, nct)
batchAmount (gt, ge, lt, le, eq, ne)
feeBatchAmount (gt, ge, lt, le, eq, ne)
netBatchAmount (gt, ge, lt, le, eq, ne)
releaseAmount (gt, ge, lt, le, eq, ne)
heldAmount (gt, ge, lt, le, eq, ne)
status (in, nin, eq, ne)
paypointLegal (ne, eq, ct, nct)
paypointDba (ne, eq, ct, nct)
orgName (ne, eq, ct, nct)
paypointId (ne, eq)
externalPaypointID (ct, nct, eq, ne)
expectedDepositDate (gt, ge, lt, le, eq, ne)
depositDate (gt, ge, lt, le, eq, ne)
batchRecords (gt, ge, lt, le, eq, ne)
transferId (ne, eq)
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)

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: batchAmount(gt)=20 returns all records with batchAmount greater than 20.00

Collection of field names, conditions, and values used to filter the query. <Info> **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 </Info> See [Filters and Conditions Reference](/developer-guides/reporting-filters-and-conditions-reference) for more information. **List of field names accepted:** - `batchDate` (gt, ge, lt, le, eq, ne) - `batchNumber` (ne, eq) - `method` (in, nin, eq, ne) - `connectorName` (ne, eq, ct, nct) - `batchAmount` (gt, ge, lt, le, eq, ne) - `feeBatchAmount` (gt, ge, lt, le, eq, ne) - `netBatchAmount` (gt, ge, lt, le, eq, ne) - `releaseAmount` (gt, ge, lt, le, eq, ne) - `heldAmount` (gt, ge, lt, le, eq, ne) - `status` (in, nin, eq, ne) - `paypointLegal` (ne, eq, ct, nct) - `paypointDba` (ne, eq, ct, nct) - `orgName` (ne, eq, ct, nct) - `paypointId` (ne, eq) - `externalPaypointID` (ct, nct, eq, ne) - `expectedDepositDate` (gt, ge, lt, le, eq, ne) - `depositDate` (gt, ge, lt, le, eq, ne) - `batchRecords` (gt, ge, lt, le, eq, ne) - `transferId` (ne, eq) - `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) **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: `batchAmount(gt)=20` returns all records with batchAmount greater than 20.00

sortBystringOptional

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.

Response

Success

Recordslist of objects

Summaryobject

Errors

400

Bad Request Error

400

Bad Request Error

401

Unauthorized Error

401

Unauthorized Error

500

Internal Server Error

503

Service Unavailable Error