Export payout batches by org

Deprecated

GET

/Export/batchesOut/:format/org/:orgId

This endpoint is deprecated. To export this data, use List payout batches for org with the exportFormat query parameter instead.

Export a list of money out batches for an organization. Use filters to limit results.

<Warning> This endpoint is deprecated. To export this data, use [List payout batches for org](/developers/api-reference/query/get-list-of-moneyout-batches-for-an-org) with the `exportFormat` query parameter instead. </Warning> Export a list of money out batches for an organization. Use filters to limit results.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

requestTokenstring

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

Path parameters

formatenumRequired

Format for the export, either XLSX or CSV.

Allowed values:

orgIdintegerRequired

The numeric identifier for organization, assigned by Payabli.

Query parameters

columnsExportstringOptional

fromRecordintegerOptionalDefaults to 0

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

limitRecordintegerOptionalDefaults 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 nullable 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.

Accepted field names:

batchDate (gt, ge, lt, le, eq, ne)
batchNumber (ne, eq)
batchAmount (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, nin, in)
paypointId (ne, eq)
externalPaypointID (ct, nct, eq, ne) Accepted parameters:
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 a 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](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help. **Accepted field names:** - `batchDate` (gt, ge, lt, le, eq, ne) - `batchNumber` (ne, eq) - `batchAmount` (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, nin, in) - `paypointId` (ne, eq) - `externalPaypointID` (ct, nct, eq, ne) Accepted parameters: - 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 a `batchAmount` greater than 20.00"

Response

Success

Errors

400

Bad Request Error

401

Unauthorized Error

500

Internal Server Error

503

Service Unavailable Error