List payout batches for paypoint

GET

/Query/batchesOut/:entry

GET

/api/Query/batchesOut/:entry

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

1 {
2   "Records": [
3     {
4       "AchAmount": 0,
5       "AchRecords": 0,
6       "AchStatus": 0,
7       "AchStatusText": "AchStatusText",
8       "BatchAmount": 4,
9       "BatchCancelledAmount": 0,
10       "BatchCancelledRecords": 0,
11       "BatchDate": "2024-01-01T00:00:00Z",
12       "BatchNumber": "10-20240101-PAYABLITST",
13       "BatchPaidAmount": 0,
14       "BatchPaidRecords": 0,
15       "BatchProcessedAmount": 0,
16       "BatchProcessedRecords": 0,
17       "BatchProcessingAmount": 0,
18       "BatchProcessingRecords": 0,
19       "BatchRecords": 1,
20       "BatchStatus": 1,
21       "BatchStatusText": "Waiting Funds",
22       "CardAmount": 0,
23       "CardRecords": 0,
24       "CardStatus": 0,
25       "CardStatusText": "CardStatusText",
26       "CheckAmount": 0,
27       "CheckRecords": 0,
28       "CheckStatus": 0,
29       "CheckStatusText": "CheckStatusText",
30       "EntryName": "d193cf9a46",
31       "externalPaypointID": "Paypoint-100",
32       "IdBatch": 1049,
33       "ParentOrgName": "FitnessManager",
34       "PaypointDba": "Athlete Factory LLC",
35       "PaypointId": 3040,
36       "PaypointName": "Athlete Factory LLC",
37       "VcardAmount": 0,
38       "VcardRecords": 0,
39       "VcardStatus": 0,
40       "VcardStatusText": "VcardStatusText",
41       "WireAmount": 0,
42       "WireRecords": 0,
43       "WireStatus": 0,
44       "WireStatusText": "WireStatusText"
45     }
46   ],
47   "Summary": {
48     "pageidentifier": "null",
49     "pageSize": 20,
50     "totalAmount": 0.01,
51     "totalNetAmount": 0,
52     "totalPages": 1,
53     "totalRecords": 46
54   }
55 }

Retrieve a list of MoneyOut batches for a paypoint. Use filters to limit results. Include the exportFormat query parameter to return the results as a file instead of a JSON response.

Authentication

requestTokenstring

Long-lived API token sent in the requestToken header. See API token authentication.

AuthorizationBearer

OAuth2 Bearer access token from the client-credentials flow. See OAuth authentication.

Path parameters

entrystringRequired

The entity’s entrypoint identifier. Learn more

Query parameters

exportFormatenumOptional

Export format for file downloads. When specified, returns data as a file instead of JSON.

Allowed values:

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 nullable stringsOptional

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)

Collection of field names, conditions, and values used to filter the query. See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#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)

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

401

Unauthorized Error

500

Internal Server Error

503

Service Unavailable Error