List settled transactions for org

1 import requests 2 3 url = "https://api-sandbox.payabli.com/api/Query/settlements/org/123" 4 5 querystring = {"fromRecord":"251","limitRecord":"0","sortBy":"desc(field_name)"} 6 7 headers = {"requestToken": "<apiKey>"} 8 9 response = requests.get(url, headers=headers, params=querystring) 10 11 print(response.json())

1 { 2 "Records": [ 3 { 4 "BatchAmount": 32, 5 "BatchNumber": "batch-100-20-2024", 6 "Category": "auth", 7 "CreatedAt": "2024-11-19T15:58:01Z", 8 "Customer": { 9 "AdditionalData": "AdditionalData", 10 "BillingAddress1": "100 Golden Ridge Drive", 11 "BillingAddress2": "STE 100", 12 "BillingCity": "Mendota", 13 "BillingCountry": "US", 14 "BillingEmail": "lydia@example.com", 15 "BillingPhone": "+12345678", 16 "BillingState": "VA", 17 "BillingZip": "20147", 18 "CreatedAt": "2022-07-01T15:00:01Z", 19 "customerId": 2707, 20 "CustomerNumber": "901102", 21 "customerStatus": 1, 22 "FirstName": "Lydia", 23 "LastName": "Marshall" 24 }, 25 "ExpectedDepositDate": "2024-11-22T00:00:00Z", 26 "GatewayTransId": "TRN_XXXXX", 27 "Id": 25048, 28 "isHold": 0, 29 "MaskedAccount": "1XXXXXX5678", 30 "Method": "ach", 31 "NetAmount": 2, 32 "Operation": "Sale", 33 "OrderId": "", 34 "ParentOrgName": "Pilgrim Planner", 35 "PaymentData": { 36 "AccountType": "Checking", 37 "HolderName": "Lydia Marshall", 38 "MaskedAccount": "1XXXXXX5678", 39 "paymentDetails": { 40 "totalAmount": 2, 41 "categories": [ 42 { 43 "amount": 1000, 44 "label": "Deposit" 45 } 46 ], 47 "currency": "USD", 48 "serviceFee": 0, 49 "splitFunding": [ 50 {} 51 ] 52 } 53 }, 54 "PaymentTransId": "245-9e4072eef77e45979ea0e49f680000X", 55 "PaymentTransStatus": 1, 56 "PaypointDbaname": "Gruzya Adventure Outfitters, LLC", 57 "PaypointEntryname": "7f1a3816XX", 58 "PaypointLegalname": "Gruzya Adventure Outfitters, LLC", 59 "ResponseData": { 60 "authcode": "", 61 "avsresponse_text": "", 62 "cvvresponse_text": "", 63 "response_code": "100", 64 "response_code_text": "Operation successful.", 65 "responsetext": "CAPTURED", 66 "transactionid": "TRN_XXXXX" 67 }, 68 "ScheduleReference": 0, 69 "SettledAmount": 0.5, 70 "SettlementDate": "2024-11-20T00:00:00Z", 71 "Source": "api", 72 "Status": 1, 73 "TransactionEvents": [ 74 { 75 "EventTime": "2024-11-19T15:57:40Z", 76 "TransEvent": "Created" 77 }, 78 { 79 "EventData": { 80 "account_id": "TRA_XXXXX", 81 "account_name": "123456", 82 "action": { 83 "app_id": "XXXXX", 84 "app_name": "PayAbli", 85 "id": "ACT_XXXXX", 86 "result_code": "SUCCESS", 87 "time_created": "2024-11-19T20:58:01.583Z", 88 "type": "AUTHORIZE" 89 }, 90 "amount": "200", 91 "batch_id": "", 92 "capture_mode": "AUTO", 93 "channel": "CNP", 94 "country": "US", 95 "currency": "USD", 96 "fees": { 97 "amount": "0", 98 "rate": "0.00", 99 "total_amount": "0" 100 }, 101 "id": "TRN_XXXXX", 102 "merchant_amount": "200", 103 "merchant_id": "MER_XXXXX", 104 "merchant_name": "Henriette97", 105 "order": { 106 "reference": "" 107 }, 108 "payment_method": { 109 "bank_transfer": { 110 "account_type": "CHECKING", 111 "bank": { 112 "name": "" 113 }, 114 "masked_account_number_last4": "XXXX5678" 115 }, 116 "entry_mode": "ECOM", 117 "message": "Success", 118 "narrative": "Lydia Marshall", 119 "result": "00" 120 }, 121 "reference": "245-XXXXX", 122 "status": "CAPTURED", 123 "time_created": "2024-11-19T20:58:01.583Z", 124 "type": "SALE" 125 }, 126 "EventTime": "2024-11-19T20:58:01Z", 127 "TransEvent": "Approved" 128 }, 129 { 130 "EventTime": "2024-11-20T03:05:10Z", 131 "TransEvent": "ClosedBatch" 132 } 133 ], 134 "TransactionTime": "2024-11-19T15:58:01Z", 135 "TransMethod": "ach", 136 "Type": "credit" 137 } 138 ], 139 "Summary": { 140 "heldAmount": 3.7, 141 "pageSize": 0, 142 "refunds": -3521.85, 143 "serviceFees": 852.48, 144 "totalAmount": 61645.74, 145 "totalNetAmount": 61645.74, 146 "totalPages": 21872, 147 "totalRecords": 21872, 148 "transferAmount": 0 149 } 150 }

Retrieve a list of settled transactions for an organization.

Authentication

requestTokenstring

API Key authentication via header

Path Parameters

orgIdintegerRequired

The numeric identifier for organization, 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.

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 more information.

List of field names accepted:

settlementDate (gt, ge, lt, le, eq, ne)
depositDate (gt, ge, lt, le, eq, ne)
transId (ne, eq, ct, nct)
gatewayTransId (ne, eq, ct, nct)
method (in, nin, eq, ne)
settledAmount (gt, ge, lt, le, eq, ne)
operation (in, nin, eq, ne)
source (in, nin, eq, ne)
batchNumber (ct, nct, eq, ne)
payaccountLastfour (nct, ct)
payaccountType (ne, eq, in, nin)
customerFirstname (ct, nct, eq, ne)
customerLastname (ct, nct, eq, ne)
customerName (ct, nct)
customerId (eq, ne)
customerNumber (ct, nct, eq, ne)
customerCompanyname (ct, nct, eq, ne)
customerAddress (ct, nct, eq, ne)
customerCity (ct, nct, eq, ne)
customerZip (ct, nct, eq, ne)
customerState (ct, nct, eq, ne)
customerCountry (ct, nct, eq, ne)
customerPhone (ct, nct, eq, ne)
customerEmail (ct, nct, eq, ne)
customerShippingAddress (ct, nct, eq, ne)
customerShippingCity (ct, nct, eq, ne)
customerShippingZip (ct, nct, eq, ne)
customerShippingState (ct, nct, eq, ne)
customerShippingCountry (ct, nct, eq, ne)
orgId (eq) mandatory when entry=org
isHold (eq, ne)
paypointId (ne, eq)
paypointLegal (ne, eq, ct, nct)
paypointDba (ne, eq, ct, nct)
orgName (ne, eq, ct, nct)
batchId (ct, nct, eq, neq)
additional-xxx (ne, eq, ct, nct) where xxx is the additional field name

List of comparison accepted:

eq or empty => equal
gt => greater than
ge => greater or equal
lt => less than
le => less or equal
ne => not equal
ct => contains
nct => not contains
in => inside array separated by ”|”
nin => not inside array separated by ”|”

List of parameters accepted:

limitRecord: max number of records for query (default=“20”, “0” or negative value for all)
fromRecord: initial record in query

Example: settledAmount(gt)=20 return all records with settledAmount 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](/developer-guides/reporting-filters-and-conditions-reference) for more information. **List of field names accepted:** - `settlementDate` (gt, ge, lt, le, eq, ne) - `depositDate` (gt, ge, lt, le, eq, ne) - `transId` (ne, eq, ct, nct) - `gatewayTransId` (ne, eq, ct, nct) - `method` (in, nin, eq, ne) - `settledAmount` (gt, ge, lt, le, eq, ne) - `operation` (in, nin, eq, ne) - `source` (in, nin, eq, ne) - `batchNumber` (ct, nct, eq, ne) - `payaccountLastfour` (nct, ct) - `payaccountType` (ne, eq, in, nin) - `customerFirstname` (ct, nct, eq, ne) - `customerLastname` (ct, nct, eq, ne) - `customerName` (ct, nct) - `customerId` (eq, ne) - `customerNumber` (ct, nct, eq, ne) - `customerCompanyname` (ct, nct, eq, ne) - `customerAddress` (ct, nct, eq, ne) - `customerCity` (ct, nct, eq, ne) - `customerZip` (ct, nct, eq, ne) - `customerState` (ct, nct, eq, ne) - `customerCountry` (ct, nct, eq, ne) - `customerPhone` (ct, nct, eq, ne) - `customerEmail` (ct, nct, eq, ne) - `customerShippingAddress` (ct, nct, eq, ne) - `customerShippingCity` (ct, nct, eq, ne) - `customerShippingZip` (ct, nct, eq, ne) - `customerShippingState` (ct, nct, eq, ne) - `customerShippingCountry` (ct, nct, eq, ne) - `orgId` (eq) *mandatory when entry=org* - `isHold` (eq, ne) - `paypointId` (ne, eq) - `paypointLegal` (ne, eq, ct, nct) - `paypointDba` (ne, eq, ct, nct) - `orgName` (ne, eq, ct, nct) - `batchId` (ct, nct, eq, neq) - `additional-xxx` (ne, eq, ct, nct) where xxx is the additional field name **List of comparison accepted:** - `eq` or empty => equal - `gt` => greater than - `ge` => greater or equal - `lt` => less than - `le` => less or equal - `ne` => not equal - `ct` => contains - `nct` => not contains - `in` => inside array separated by "|" - `nin` => not inside array separated by "|" **List of parameters accepted:** - `limitRecord`: max number of records for query (default="20", "0" or negative value for all) - `fromRecord`: initial record in query Example: `settledAmount(gt)=20` return all records with settledAmount greater than 20.00

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 or null

Summaryobject or null

Authentication

Path Parameters

Query Parameters

Response

Errors