Get outbound transfer details

GET

/Query/transferDetailsOut/:entry/:transferId

GET

/api/Query/transferDetailsOut/:entry/:transferId

1 import requests
2 
3 url = "https://api-sandbox.payabli.com/api/Query/transferDetailsOut/47ace2b25/4521"
4 
5 querystring = {"fromRecord":"0","limitRecord":"20"}
6 
7 response = requests.get(url, params=querystring)
8 
9 print(response.json())

Try it

1 {
2   "Summary": {
3     "achReturns": 0,
4     "adjustments": 0,
5     "billingFees": 25,
6     "chargebacks": 0,
7     "grossTransferAmount": 4875,
8     "releaseAmount": 0,
9     "thirdPartyPaid": 0,
10     "totalNetAmountTransfer": 4850,
11     "splitAmount": 0,
12     "serviceFees": 0,
13     "netBatchAmount": 0,
14     "transferAmount": 0,
15     "refunds": 0,
16     "heldAmount": 0,
17     "totalRecords": 156,
18     "totalAmount": 0,
19     "totalNetAmount": 0,
20     "totalPages": 8,
21     "pageSize": 20,
22     "pageidentifier": null
23   },
24   "Records": [
25     {
26       "transferDetailId": 9847,
27       "transferId": 4521,
28       "transactionId": "01KXYZ789ABC123DEF456GHI",
29       "idOut": 88234,
30       "IdOut": 0,
31       "method": null,
32       "type": "Debit",
33       "category": "grouped",
34       "grossAmount": 1250,
35       "returnedAmount": 0,
36       "refundAmount": 0,
37       "holdAmount": 0,
38       "releasedAmount": 0,
39       "billingFeesAmount": 5,
40       "adjustmentsAmount": 0,
41       "netTransferAmount": 1245,
42       "billingFeesDetails": null,
43       "CreatedAt": "2025-01-15T10:22:18",
44       "Comments": "Epoxy floor coating materials",
45       "Vendor": {
46         "VendorNumber": "V-CC-2847",
47         "Name1": "Concrete Supply Distributors",
48         "Name2": null,
49         "EIN": "XXXXX4567",
50         "Phone": "(512) 555-0147",
51         "Email": "accounts@concretesupply.example.com",
52         "RemitEmail": "payments@concretesupply.example.com",
53         "Address1": "4200 Industrial Parkway",
54         "Address2": "Unit B",
55         "City": "Austin",
56         "State": "TX",
57         "Zip": "78745",
58         "Country": "US",
59         "Mcc": "5039",
60         "LocationCode": null,
61         "Contacts": [
62           {
63             "ContactEmail": "rchen@concretesupply.example.com",
64             "ContactName": "Robert Chen",
65             "ContactPhone": "(512) 555-0148",
66             "ContactTitle": "Accounts Receivable"
67           }
68         ],
69         "BillingData": null,
70         "PaymentMethod": "ach",
71         "VendorStatus": 1,
72         "VendorId": 24891,
73         "EnrollmentStatus": null,
74         "Summary": null,
75         "PaypointLegalname": "Solid Rock Concrete Coatings LLC",
76         "PaypointId": null,
77         "PaypointDbaname": "Solid Rock Coatings",
78         "PaypointEntryname": "47cade237",
79         "ParentOrgName": "Premier Property Services",
80         "ParentOrgId": 77,
81         "CreatedDate": "2024-08-12T09:15:00",
82         "LastUpdated": "2025-01-10T14:30:22",
83         "remitAddress1": "4200 Industrial Parkway",
84         "remitAddress2": "Unit B",
85         "remitCity": "Austin",
86         "remitState": "TX",
87         "remitZip": "78745",
88         "remitCountry": "US",
89         "payeeName1": null,
90         "payeeName2": null,
91         "customField1": "",
92         "customField2": "",
93         "customerVendorAccount": "SRCC-001847",
94         "InternalReferenceId": 3392,
95         "additionalData": null,
96         "externalPaypointID": "SR-892",
97         "StoredMethods": null
98       },
99       "PaypointDbaname": "Solid Rock Coatings",
100       "PaypointLegalname": "Solid Rock Concrete Coatings LLC",
101       "PaypointId": 892,
102       "Status": 2,
103       "PaymentId": "01KXYZ789ABC123DEF456GHI",
104       "TransId": null,
105       "TransStatus": null,
106       "TransStatusDetail": null,
107       "TransStatusName": null,
108       "TransStatusCategory": null,
109       "LastUpdated": "2025-01-15T10:23:05",
110       "TotalAmount": 1250,
111       "NetAmount": 1245,
112       "FeeAmount": 5,
113       "Source": "api",
114       "ParentOrgName": "Premier Property Services",
115       "ParentOrgId": 77,
116       "BatchNumber": "b7c3e891-4f2a-4d8e-9a1b-c5d6e7f8a9b0",
117       "PaymentStatus": "Processing",
118       "PaymentMethod": "ach",
119       "CardToken": null,
120       "CheckNumber": "",
121       "CheckData": null,
122       "PaymentData": {
123         "MaskedAccount": "7XXXXXX4523",
124         "AccountType": "checking",
125         "AccountExp": "",
126         "AccountZip": "",
127         "HolderName": null,
128         "StoredId": "f8e7d6c5-b4a3-9281-7654-321098fedcba",
129         "Initiator": null,
130         "StoredMethodUsageType": null,
131         "Sequence": null,
132         "orderDescription": "Epoxy floor coating materials",
133         "cloudSignatureData": null,
134         "cloudSignatureFormat": null,
135         "paymentDetails": null,
136         "payorData": null,
137         "accountId": "bankOut1",
138         "bankAccount": null,
139         "gatewayConnector": null,
140         "binData": null
141       },
142       "Bills": [
143         {
144           "billId": 78234,
145           "LotNumber": "LOT-2025-0115",
146           "AccountingField1": null,
147           "AccountingField2": null,
148           "Terms": null,
149           "AdditionalData": null,
150           "attachments": null,
151           "invoiceNumber": "INV-2025-00892",
152           "netAmount": "1250.00",
153           "invoiceDate": "2025-01-10T00:00:00",
154           "dueDate": "2025-02-09",
155           "comments": "50 gal epoxy primer, 25 gal topcoat - Project Riverside Plaza",
156           "identifier": null,
157           "discount": null,
158           "totalAmount": null
159         }
160       ],
161       "Events": [
162         {
163           "TransEvent": "Risk Validated: PASSED",
164           "EventData": "",
165           "EventTime": "2025-01-15T10:22:20"
166         },
167         {
168           "TransEvent": "Captured",
169           "EventData": "0ABC123XYZ789:00000012",
170           "EventTime": "2025-01-15T10:22:25"
171         }
172       ],
173       "externalPaypointID": "SR-892",
174       "EntryName": "47cade237",
175       "Gateway": "bank",
176       "BatchId": 12847,
177       "HasVcardTransactions": null,
178       "IsSameDayACH": false,
179       "ScheduleId": 0,
180       "SettlementStatus": "Pending",
181       "SettlementStatusName": "",
182       "SettlementDate": null,
183       "RiskFlagged": false,
184       "RiskFlaggedOn": "2025-01-15T10:22:18",
185       "RiskStatus": "PASSED",
186       "RiskReason": "",
187       "RiskAction": "",
188       "RiskActionCode": 0,
189       "PayoutProgram": "ODP",
190       "AchTraceNumber": null
191     }
192   ]
193 }

Retrieve details for a specific outbound transfer. Use filters to limit results.

Path parameters

entrystringRequired

The entity’s entrypoint identifier. Learn more

transferIdintegerRequired

The numeric identifier for the transfer, 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. 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:

grossAmount (gt, ge, lt, le, eq, ne)
returnedAmount (gt, ge, lt, le, eq, ne)
billingFeeAmount (gt, ge, lt, le, eq, ne)
netFundedAmount (gt, ge, lt, le, eq, ne)
adjustmentAmount (gt, ge, lt, le, eq, ne)
transactionId (eq, ne, in, nin)
category (eq, ne, ct, nct)
type (eq, ne, in, nin)
method (eq, ne, in, nin)
walletType (eq, ne, in, nin)
splitFundingAmount (gt, ge, lt, le, 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. <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: - `grossAmount` (gt, ge, lt, le, eq, ne) - `returnedAmount` (gt, ge, lt, le, eq, ne) - `billingFeeAmount` (gt, ge, lt, le, eq, ne) - `netFundedAmount` (gt, ge, lt, le, eq, ne) - `adjustmentAmount` (gt, ge, lt, le, eq, ne) - `transactionId` (eq, ne, in, nin) - `category` (eq, ne, ct, nct) - `type` (eq, ne, in, nin) - `method` (eq, ne, in, nin) - `walletType` (eq, ne, in, nin) - `splitFundingAmount` (gt, ge, lt, le, 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

Summaryobject

Summary information about the transfer details.

Recordslist of objects

List of outbound transfer detail records.

Path parameters

Query parameters

Response

Errors