GET
/
Query
/
batchesOut
/
{entry}
curl --request GET \
  --url https://api-sandbox.payabli.com/api/Query/batchesOut/{entry} \
  --header 'requestToken: <api-key>'
{
  "Summary": {
    "totalRecords": 46,
    "totalAmount": 0.01,
    "totalNetAmount": 0,
    "totalPages": 1,
    "pageSize": 20,
    "pageidentifier": "null"
  },
  "Records": [
    {
      "IdBatch": 239,
      "BatchDate": "2024-01-01T00:00:00",
      "BatchNumber": "10-20240101-PAYABLITST",
      "BatchStatus": 1,
      "BatchStatusText": "Waiting Funds",
      "PaypointId": 123,
      "BatchAmount": 4,
      "BatchRecords": 1,
      "externalPaypointID": "Paypoint-100",
      "PaypointName": "Athlete Factory LLC",
      "PaypointDba": "Athlete Factory LLC",
      "ParentOrgName": "FitnessManager",
      "EntryName": "d193cf9a46",
      "BatchProcessingAmount": 0,
      "BatchProcessingRecords": 0,
      "BatchProcessedAmount": 0,
      "BatchProcessedRecords": 0,
      "BatchPaidAmount": 0,
      "BatchPaidRecords": 0,
      "BatchCancelledAmount": 0,
      "BatchCancelledRecords": 0,
      "AchStatusText": null,
      "AchStatus": 0,
      "AchRecords": 0,
      "AchAmount": 0,
      "CardStatusText": null,
      "CardStatus": 0,
      "CardRecords": 0,
      "CardAmount": 0,
      "VcardStatusText": null,
      "VcardStatus": 0,
      "VcardRecords": 0,
      "VcardAmount": 0,
      "CheckStatusText": null,
      "CheckStatus": 0,
      "CheckRecords": 0,
      "CheckAmount": 0,
      "WireStatusText": null,
      "WireStatus": 0,
      "WireRecords": 0,
      "WireAmount": 0
    }
  ]
}

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

​
entry
string
required

The paypoint's entrypoint identifier. Learn more

Example:

"8cfec329267"

Query Parameters

​
parameters
object

Collection of field names, conditions, and values used to filter the query. See Filters and Conditions Reference for more information.

List of field names accepted:

  • batchDate (gt, ge, lt, le, eq, ne)
  • batchNumber (ne, eq)
  • batchAmount (gt, ge, lt, le, eq, ne)
  • parentOrgId (ne, eq, nin, in)
  • status (in, nin, eq, ne)
  • orgId (eq)
  • paypointLegal (ne, eq, ct, nct)
  • paypointDba (ne, eq, ct, nct)
  • orgName (ne, eq, ct, nct)
  • paypointId (ne, eq)
  • externalPaypointID (ct, nct, eq, ne)
​
limitRecord
integer
default:20

Max number of records to return for the query. Use 0 or negative value to return all records.

Example:

0

​
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)"

Response

200
application/json
Success

Response body for queries about money out batches.

​
Summary
object
​
Records
object[]

Was this page helpful?