List transfers for org

GET

/Query/transfers/org/:orgId

GET

/api/Query/transfers/org/:orgId

$ curl -G https://api-sandbox.payabli.com/api/Query/transfers/org/123 \
>      -H "requestToken: <apiKey>" \
>      -d fromRecord=0 \
>      -d limitRecord=20

1 {
2   "Records": [
3     {
4       "transferId": 4521,
5       "paypointId": 3040,
6       "batchNumber": "split_705_gp_11-16-2024",
7       "batchCurrency": "USD",
8       "batchRecords": 1,
9       "transferIdentifier": "bbcbfed7-e535-45fe-8d62-000000",
10       "batchId": 1049,
11       "paypointEntryName": "47ae3de37",
12       "paypointLegalName": "Gruzya Outdoor Outfitters LLC",
13       "paypointDbaName": "Gruzya Outdoor Outfitters",
14       "paypointLogo": "https://example.com/logo.png",
15       "parentOrgName": "Pilgrim Planner",
16       "parentOrgId": 12345,
17       "parentOrgEntryName": "43aebc000",
18       "parentOrgLogo": "https://example.com/parent-logo.png",
19       "externalPaypointID": "ext-12345",
20       "bankAccount": {
21         "accountNumber": "****1234",
22         "routingNumber": "123456789",
23         "bankName": "Riverdale Community Bank"
24       },
25       "transferDate": "2024-11-17T08:20:07.288+00:00",
26       "processor": "gp",
27       "transferStatus": 2,
28       "grossAmount": 1029,
29       "chargeBackAmount": 25,
30       "returnedAmount": 0,
31       "holdAmount": 0,
32       "releasedAmount": 0,
33       "billingFeesAmount": 0,
34       "thirdPartyPaidAmount": 0,
35       "adjustmentsAmount": 0,
36       "netTransferAmount": 1004,
37       "splitAmount": 650.22,
38       "eventsData": [
39         {
40           "description": "Transfer Created",
41           "eventTime": "2024-11-16T08:15:33.4364067Z",
42           "extraData": null,
43           "refData": null,
44           "source": "worker"
45         }
46       ],
47       "messages": []
48     }
49   ],
50   "Summary": {
51     "totalPages": 1,
52     "totalRecords": 2,
53     "pageSize": 20
54   }
55 }

Retrieve a list of transfers for an org. 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

orgIdlongRequired

Organization ID. Unique identifier assigned to an org by Payabli.

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.

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

List of field names accepted:

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)
batchNumber (ne, eq, ct, nct)
batchId (ne, eq, in, nin)
transferId (in, nin, eq, ne)
bankAccountNumber (ct, nct, ne, eq)
bankRoutingNumber (ct, nct, ne, eq)
batchCurrency (in, nin, ne, eq)

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. <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> List of field names accepted: - `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) - `batchNumber` (ne, eq, ct, nct) - `batchId` (ne, eq, in, nin) - `transferId` (in, nin, eq, ne) - `bankAccountNumber` (ct, nct, ne, eq) - `bankRoutingNumber` (ct, nct, ne, eq) - `batchCurrency` (in, nin, ne, eq)

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