> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://beta-docs.payabli.com/api-reference/query/get-list-of-settled-transactions-for-an-entrypoint/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://beta-docs.payabli.com/_mcp/server. # List settled transactions for paypoint GET https://api-sandbox.payabli.com/api/Query/settlements/{entry} Retrieve a list of settled transactions for a paypoint. Use filters to limit results. Reference: https://beta-docs.payabli.com/api-reference/query/get-list-of-settled-transactions-for-an-entrypoint ## Authentication - `requestToken` header (required) — API Key authentication via header ## Servers - `https://api-sandbox.payabli.com/api` (Sandbox, default) - `https://api.payabli.com/api` (Production) ## Request ### Path parameters - `entry` (string, required) — The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry) ### Query parameters - `fromRecord` (integer, optional, default: 0) — The number of records to skip before starting to collect the result set. - `limitRecord` (integer, optional, default: 20) — Max number of records to return for the query. Use `0` or negative value to return all records. - `parameters` (map from string to string, optional) — 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](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](https://api-sandbox.payabli.com/api/Query/transactions/org/236?totalAmount\(gt\)=1000\&limitRecord=20) 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 - `sortBy` (string, optional) — 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 ### 200 Success - `Records` (list of QueryResponseSettlementsRecordsItem, optional) - `Summary` (QueryResponseSettlementsSummary, optional) ## Errors ### 400 Bad Request Error Bad request/ invalid data - `any` ### 401 Unauthorized Error Unauthorized request. - `any` ### 400 Bad Request Error Bad request/ invalid data - `any` ### 401 Unauthorized Error Unauthorized request. - `any` ### 500 Internal Server Error Internal API Error - `any` ### 503 Service Unavailable Error Database connection error - `isSuccess` (boolean, optional) — Boolean indicating whether the operation was successful. A `true` value indicates success. A `false` value indicates failure. - `responseData` (map from string to any, optional) — The object containing the response data. - `responseText` (string, optional) — Response text for operation: 'Success' or 'Declined'. ## Types ### QueryResponseSettlementsRecordsItem - `BatchAmount` (double, optional) — The batch amount. - `BatchNumber` (string, optional) — The batch number. - `Category` (string, optional) — A field used internally by Payabli to categorize the transaction details. Values are: - `auth`: Any payment - `refund`: ACH return or Refund - `adj`: Adjustments - `cb`: Chargeback - `split`: Split amount - `CreatedAt` (datetime, optional) — Timestamp of when record was created, in UTC. - `Customer` (QueryTransactionPayorData, optional) - `DepositDate` (datetime, optional) — The date the funds were deposited. - `ExpectedDepositDate` (datetime, optional) — The date the funds are expected to be deposited. - `externalPaypointID` (string, optional) — A custom identifier for the paypoint, if applicable. Like `entrypoint` is the Payabli identifier for the merchant, `externalPaypointId` is a custom field you can use to include the merchant's ID from your own systems. - `GatewayTransId` (string, optional) — Internal identifier used for processing. - `Id` (integer, optional) - `invoiceData` (BillData, optional) - `isHold` (integer, optional) — Describes whether the transaction is being held or not. 1 - Transaction is held 0 - Transaction is not being held - `MaskedAccount` (string, optional) — Masked card or bank account used in transaction. In the case of Apple Pay, this is a masked DPAN (device primary account number). - `Method` (string, optional) — The payment method. - `NetAmount` (double, optional) — Net amount paid. - `Operation` (string, optional) — The operation performed. - `OrderId` (string, optional) — Custom identifier for the transaction. - `ParentOrgName` (string, optional) — The name of the parent organization. - `PaymentData` (QueryPaymentData, optional) - `PaymentTransId` (string, optional) — The transaction ID for the payment. - `PaymentTransStatus` (integer, optional) — Status of transaction. See [the docs](/references/money-in-statuses#money-in-transaction-status) for a full reference. - `PaypointDbaname` (string, optional) — Paypoint DBA name. - `PaypointEntryname` (string, optional) — Paypoint entryname. - `PaypointLegalname` (string, optional) — Paypoint legal name. - `ResponseData` (QueryResponseData, optional) — The transaction's response data. - `ScheduleReference` (integer, optional) — Reference to the subscription originating the transaction. - `SettledAmount` (double, optional) — The transaction amount. - `SettlementDate` (datetime, optional) - `Source` (string, optional) — Custom identifier to indicate the transaction or request source. - `Status` (integer, optional) — Settlement status for transaction. See [the docs](/references/money-in-statuses#payment-funding-status) for a full reference. - `TransactionEvents` (list of QueryTransactionEvents, optional) — Events associated with this transaction. - `TransactionTime` (datetime, optional) — Timestamp when transaction was submitted, in UTC. - `TransMethod` (string, optional) — Payment method used: card or ach. - `Type` (string, optional) — The transaction type: credit or debit. ### QueryResponseSettlementsSummary - `heldAmount` (double, optional) — Funds being held for fraud or risk concerns. - `pageidentifier` (string, optional) — Auxiliary validation used internally by payment pages and components. - `pageSize` (integer, optional) — Number of records per page. - `refunds` (double, optional) — Total refunds deducted from the transfer. - `serviceFees` (double, optional) — Service fees are any pass-through fees charged to the customer at the time of payment. These are not transferred to the merchant when the batch is transferred and funded. - `totalAmount` (double, optional) — The total sum of the settlements in the response. - `totalNetAmount` (double, optional) — The total sum of the settlements in the response. - `totalPages` (integer, optional) — Number of pages in the response. - `totalRecords` (integer, optional) — Number of records in the response. - `transferAmount` (double, optional) — The transfer amount is the net batch amount plus or minus any returns, refunds, billing and fees items, chargebacks, adjustments, and third party payments. This is the amount from the batch that is transferred to the merchant bank account. ### QueryTransactionPayorData - `AdditionalData` (string, optional) — Custom dictionary of key:value pairs. You can use this field to store any data related to the object or for your system. Example usage: ```json { "additionalData": { "key1": "value1", "key2": "value2", "key3": "value3" } } ``` - `BillingAddress1` (string, optional) — Customer's billing address. - `BillingAddress2` (string, optional) — Additional line for Customer's billing address. - `BillingCity` (string, optional) — Customer's billing city. - `BillingCountry` (string, optional) — Customer's billing country. - `BillingEmail` (string, optional) — Customer's email address. - `BillingPhone` (string, optional) — Customer's phone number. - `BillingState` (string, optional) — Customer's billing state. Must be 2-letter state code for address in US. - `BillingZip` (string, optional) — Customer's billing ZIP code. - `CompanyName` (string, optional) — Customer's company name. - `CreatedAt` (datetime, optional) — Timestamp of when record was created, in UTC. - `customerId` (long, optional) — The Payabli-generated unique ID for the customer. - `CustomerId` (long, optional) — The Payabli-generated unique ID for the customer. - `CustomerNumber` (string, optional) — User-provided unique identifier for the customer. This is typically the customer ID from your own system. - `customerStatus` (integer, optional) — Customer Status. Possible values: - `-99` Deleted - `0` Inactive - `1` Active - `85` Locked (typically due to multiple failed login attempts) - `FirstName` (string, optional) — Customer/Payor first name. - `Identifiers` (list of any, optional) — Array of field names to be used as identifiers. - `LastName` (string, optional) — Customer/Payor last name. - `ShippingAddress1` (string, optional) — The shipping address. - `ShippingAddress2` (string, optional) — Additional line for shipping address. - `ShippingCity` (string, optional) — Shipping city. - `ShippingCountry` (string, optional) — Shipping address country. - `ShippingState` (string, optional) — Shipping state or province. - `ShippingZip` (string, optional) — Shipping ZIP code. For Pay In functions, this field supports 5-digit and 9-digit ZIP codes and alphanumeric Canadian postal codes. For example: "37615-1234" or "37615". ### BillData - `AdditionalData` (string, optional) — Custom dictionary of key:value pairs. You can use this field to store any data related to the object or for your system. Example usage: ```json { "additionalData": { "key1": "value1", "key2": "value2", "key3": "value3" } } ``` - `attachments` (list of FileContent, optional) — Array of `fileContent` objects with attached documents. Max upload size is 30 MB. - `company` (string, optional) — Company name of the recipient of the invoice. - `discount` (double, optional) — Discount applied to the invoice. - `dutyAmount` (double, optional) — Duty amount. - `firstName` (string, optional) — First name of the recipient of the invoice. - `freightAmount` (double, optional) — Freight/shipping amount. - `frequency` (enum, optional) — Frequency of scheduled invoice. - Allowed values: `one-time`, `weekly`, `every2weeks`, `every6months`, `monthly`, `every3months`, `annually` - `invoiceAmount` (double, optional) — Invoice total amount. - `invoiceDate` (date, optional) — Invoice date in any of the accepted formats: YYYY-MM-DD, MM/DD/YYYY. - `invoiceDueDate` (date, optional) — Invoice due date in one of the accepted formats: YYYY-MM-DD, MM/DD/YYYY. - `invoiceEndDate` (date, optional) — Indicate the date to finish a scheduled invoice cycle (`invoiceType`` = 1) in any of the accepted formats: YYYY-MM-DD, MM/DD/YYYY. - `invoiceNumber` (string, optional) — Invoice number. Identifies the invoice under a paypoint. - `invoiceStatus` (integer, optional) — Status for invoice. The accepted status values are: - 0 draft - 1 active - 2 partially paid - 4 paid/complete - 99 cancelled - `invoiceType` (integer, optional) — Type of invoice. Only `0` for one-time invoices is currently supported. - `items` (list of BillItem, optional) — Array of line items included in the invoice. - `lastName` (string, optional) — Last name of the recipient of the invoice. - `notes` (string, optional) — Notes included in the invoice. - `paymentTerms` (enum, optional) — Payment terms for invoice. If no terms are defined, then reponse data for this field defaults to `N30`. - Allowed values: `PIA`, `CIA`, `UR`, `NET10`, `NET20`, `NET30`, `NET45`, `NET60`, `NET90`, `EOM`, `MFI`, `5MFI`, `10MFI`, `15MFI`, `20MFI`, `2/10NET30`, `UF`, `10UF`, `20UF`, `25UF`, `50UF` - `purchaseOrder` (string, optional) — Purchase order number. - `shippingAddress1` (string, optional) — The shipping address. - `shippingAddress2` (string, optional) — Additional line for shipping address. - `shippingCity` (string, optional) — Shipping city. - `shippingCountry` (string, optional) — Shipping address country. - `shippingEmail` (string, optional) — Shipping recipient's contact email address. - `shippingFromZip` (string, optional) — Sender shipping ZIP code. - `shippingPhone` (string, optional) — Recipient phone number. - `shippingState` (string, optional) — Shipping state or province. - `shippingZip` (string, optional) — Shipping ZIP code. For Pay In functions, this field supports 5-digit and 9-digit ZIP codes and alphanumeric Canadian postal codes. For example: "37615-1234" or "37615". - `summaryCommodityCode` (string, optional) — Commodity code. - `tax` (double, optional) — Tax rate in percent applied to the invoice. - `termsConditions` (string, optional) — Custom terms and conditions included in the invoice. ### QueryPaymentData - `AccountExp` (string, optional) — Expiration date of card used in transaction. - `accountId` (string, optional) — Custom identifier for payment connector. - `AccountType` (string, optional) — Bank account type or card brand. - `AccountZip` (string, optional) — ZIP code for card used in transaction. - `binData` (BinData, optional) — Object containing information related to the card. This object is `null` unless the payment method is card. If the payment method is Apple Pay, the binData will be related to the DPAN (device primary account number), not the card connected to Apple Pay. - `HolderName` (string, optional) — Account holder name for the method. - `Initiator` (string, optional) — **Strongly recommended** The cardholder-initiated transaction (CIT) or merchant-initiated transaction (MIT) indicator for the transaction. If you don't specify a value, Payabli defaults to `merchant`. Available values: - `payor`: For cardholder-initiated transactions - `merchant`: For merchant-initiated transactions See [Understanding CIT and MIT Indicators](/guides/money-in-cit-mit) for more information. - `MaskedAccount` (string, optional) — Masked card or bank account used in transaction. In the case of Apple Pay, this is a masked DPAN (device primary account number). - `orderDescription` (string, optional) — Text description of the transaction. - `paymentDetails` (PaymentDetail, optional) — Details about the payment. - `Sequence` (string, optional) — The order of the transaction for cardholder-initiated transaction (CIT) and merchant-initiated transaction (MIT) purposes. This field is automatically detected and populated by Payabli. Available values: - `first`: The first use of the payment method. This is almost always a cardholder-initiated transaction. - `subsequent`: For merchant-initiated transactions after the first use of the payment method. See [Understanding CIT and MIT Indicators](/guides/money-in-cit-mit) for more information. - `SignatureData` (string, optional) - `StoredId` (string, optional) — Identifier of stored payment method used in transaction. - `StoredMethodUsageType` (string, optional) — **Strongly recommended** The usage type for the stored method, used for merchant-initiated transactions (MIT). If you don't specify a value, Payabli defaults to `unscheduled`. Available values: - `unscheduled`: This type is used for transactions that are one-time or otherwise not pre-scheduled. - `subscription`: This type is used for subscription payments. For example, monthly rental fees or ongoing service subscriptions. - `recurring`: This type is used for recurring payments that occur per a set plan. For example, splitting an HOA special assessment over 6 monthly payments. See [Understanding CIT and MIT Indicators](/guides/money-in-cit-mit) for more information. ### QueryResponseData The transaction's response data. - `authcode` (string, optional) — Authorization code for the transaction. - `avsresponse` (string, optional) — Text code describing the result for address validation (applies only for card transactions). - `avsresponse_text` (string, optional) — Text code describing the result for address validation (applies only for card transactions). - `cvvresponse` (string, optional) — Text code describing the result for CVV validation (applies only for card transactions). - `cvvresponse_text` (string, optional) — Text code describing the result for CVV validation (applies only for card transactions). - `emv_auth_response_data` (string, optional) — EMV authorization response data, applicable for card transactions. - `orderid` (string, optional) — Custom identifier for the transaction. - `response` (string, optional) — Response text for operation: 'Success' or 'Declined'. - `response_code` (string, optional) — Internal result code processing the transaction. Value 1 indicates successful operation, values 2 and 3 indicate errors. - `response_code_text` (string, optional) — Text describing the result. If resultCode = 1, will return 'Approved' or a general success message. If resultCode = 2 or 3, will contain the cause of the decline. - `responsetext` (string, optional) — Text describing the result. If resultCode = 1, will return 'Approved' or a general success message. If resultCode = 2 or 3, will contain the cause of the decline. - `transactionid` (string, optional) — The transaction identifier in Payabli. - `type` (string, optional) — Type of transaction or operation. ### QueryTransactionEvents - `EventData` (QueryTransactionEventsEventData, optional) — Any data associated to the event received from processor. Contents vary by event type. - `EventTime` (datetime, optional) — Date and time of event. - `TransEvent` (string, optional) — Event descriptor. See [TransEvent Reference](/references/transevents) for more details. ### FileContent Contains details about a file. See See [fileObject Object Model](/api-reference/schemas/filecontent) for a complete reference. Max upload size is 30 MB. - `fContent` (string, optional) — Content of file, Base64-encoded Ignored if furl is specified. Max upload size is 30 MB. - `filename` (string, optional) — The name of the attached file. - `ftype` (enum, optional) — The MIME type of the file (if content is provided) - Allowed values: `pdf`, `doc`, `docx`, `jpg`, `jpeg`, `png`, `gif`, `txt` - `furl` (string, optional) — Optional url provided to show or download the file remotely ### BillItem - `itemCost` (double, required) — Item or product price per unit. - `itemCategories` (list of string, optional) — Array of tags classifying item or product. - `itemCommodityCode` (string, optional) — Item or product commodity code. Max length of 250 characters. - `itemDescription` (string, optional) — Item or product description. Max length of 250 characters. - `itemMode` (integer, optional) — Internal class of item or product: value '0' is only for invoices , '1' for bills and, '2' common for both. - `itemProductCode` (string, optional) — Item or product code. Max length of 250 characters. - `itemProductName` (string, optional) — Item or product name. Max length of 250 characters. - `itemQty` (integer, optional) — Quantity of item or product. - `itemTaxAmount` (double, optional) — Tax amount applied to item or product. - `itemTaxRate` (double, optional) — Tax rate applied to item or product. - `itemTotalAmount` (double, optional) — Total amount in item or product. - `itemUnitOfMeasure` (string, optional) — Unit of measurement. Max length of 100 characters. ### BinData Object containing information related to the card. This object is `null` unless the payment method is card. If the payment method is Apple Pay, the binData will be related to the DPAN (device primary account number), not the card connected to Apple Pay. - `binCardBrand` (string, optional) — The card brand. For example, Visa, Mastercard, American Express, Discover. - `binCardCategory` (string, optional) — The category of the card, which indicates the card product. For example: Standard, Gold, Platinum, etc. The binCardCategory for prepaid cards is marked `PREPAID`. - `binCardIssuer` (string, optional) — The name of the financial institution that issued the card. - `binCardIssuerCountry` (string, optional) — The issuing financial institution's country name. - `binCardIssuerCountryCodeA2` (string, optional) — The issuing financial institution's two-character ISO country code. See [this resource](https://www.iso.org/obp/ui/#search) for a list of codes. - `binCardIssuerCountryNumber` (double, optional) — The issuing financial institution's ISO standard numeric country code. See [this resource](https://www.iso.org/obp/ui/#search) for a list of codes. - `binCardType` (string, optional) — The type of card: Credit or Debit. - `binMatchedLength` (double, optional) — The number of characters from the beginning of the card number that were matched against a Bank Identification Number (BIN) or the Card Range table. ### PaymentDetail Details about the payment. - `totalAmount` (double, required) — Total amount to be charged. If a service fee is sent, then this amount should include the service fee." - `categories` (list of PaymentCategories, optional) — Array of payment categories/line items describing the amount to be paid **Note**: These categories are for information only and are not validated against the total amount provided. - `checkImage` (map from string to any, optional) — Object containing image of paper check. - `checkNumber` (string, optional) — A check number to be used in the ach transaction. **Required** for payment method = 'check'. - `currency` (string, optional) — Currency code ISO-4217. If not code is provided the currency in the paypoint setting is taken. Default is **USD**. - `serviceFee` (double, optional) — Service fee to be deducted from the total amount. This amount must be a number, percentages aren't accepted. If you are using a percentage-based fee schedule, you must calculate the value manually. - `splitFunding` (list of SplitFundingContent, optional) — Split funding instructions for the transaction. See [Split a Transaction](/developer-guides/money-in-split-funding) for more. ### QueryTransactionEventsEventData Any data associated to the event received from processor. Contents vary by event type. ### PaymentCategories - `amount` (double, required) — Price/cost per unit of item or category. - `label` (string, required) — Name of item or category. - `description` (string, optional) — Description of item or category - `qty` (integer, optional, default: 1) — Quatity of item or category ### SplitFundingContent - `accountId` (string, optional) — The accountId for the account the split should be sent to. - `amount` (double, optional) — Amount from the transaction to sent to this recipient. - `description` (string, optional) — A description for the split. - `recipientEntryPoint` (string, optional) — The entrypoint the split should be sent to. ## Examples **Response** ```json { "Records": [ { "BatchAmount": 32, "BatchNumber": "batch-100-20-2024", "Category": "auth", "CreatedAt": "2024-11-19T15:58:01Z", "Customer": { "AdditionalData": "AdditionalData", "BillingAddress1": "100 Golden Ridge Drive", "BillingAddress2": "STE 100", "BillingCity": "Mendota", "BillingCountry": "US", "BillingEmail": "lydia@example.com", "BillingPhone": "+12345678", "BillingState": "VA", "BillingZip": "20147", "CreatedAt": "2022-07-01T15:00:01Z", "customerId": 2707, "CustomerNumber": "901102", "customerStatus": 1, "FirstName": "Lydia", "LastName": "Marshall" }, "ExpectedDepositDate": "2024-11-22T00:00:00Z", "GatewayTransId": "TRN_XXXXX", "Id": 25048, "isHold": 0, "MaskedAccount": "1XXXXXX5678", "Method": "ach", "NetAmount": 2, "Operation": "Sale", "OrderId": "", "ParentOrgName": "Pilgrim Planner", "PaymentData": { "AccountType": "Checking", "HolderName": "Lydia Marshall", "MaskedAccount": "1XXXXXX5678", "paymentDetails": { "totalAmount": 2, "categories": [ { "amount": 1000, "label": "Deposit" } ], "currency": "USD", "serviceFee": 0, "splitFunding": [ {} ] } }, "PaymentTransId": "245-9e4072eef77e45979ea0e49f680000X", "PaymentTransStatus": 1, "PaypointDbaname": "Gruzya Adventure Outfitters, LLC", "PaypointEntryname": "7f1a3816XX", "PaypointLegalname": "Gruzya Adventure Outfitters, LLC", "ResponseData": { "authcode": "", "avsresponse_text": "", "cvvresponse_text": "", "response_code": "100", "response_code_text": "Operation successful.", "responsetext": "CAPTURED", "transactionid": "TRN_XXXXX" }, "ScheduleReference": 0, "SettledAmount": 0.5, "SettlementDate": "2024-11-20T00:00:00Z", "Source": "api", "Status": 1, "TransactionEvents": [ { "EventTime": "2024-11-19T15:57:40Z", "TransEvent": "Created" }, { "EventData": { "account_id": "TRA_XXXXX", "account_name": "123456", "action": { "app_id": "XXXXX", "app_name": "PayAbli", "id": "ACT_XXXXX", "result_code": "SUCCESS", "time_created": "2024-11-19T20:58:01.583Z", "type": "AUTHORIZE" }, "amount": "200", "batch_id": "", "capture_mode": "AUTO", "channel": "CNP", "country": "US", "currency": "USD", "fees": { "amount": "0", "rate": "0.00", "total_amount": "0" }, "id": "TRN_XXXXX", "merchant_amount": "200", "merchant_id": "MER_XXXXX", "merchant_name": "Henriette97", "order": { "reference": "" }, "payment_method": { "bank_transfer": { "account_type": "CHECKING", "bank": { "name": "" }, "masked_account_number_last4": "XXXX5678" }, "entry_mode": "ECOM", "message": "Success", "narrative": "Lydia Marshall", "result": "00" }, "reference": "245-XXXXX", "status": "CAPTURED", "time_created": "2024-11-19T20:58:01.583Z", "type": "SALE" }, "EventTime": "2024-11-19T20:58:01Z", "TransEvent": "Approved" }, { "EventTime": "2024-11-20T03:05:10Z", "TransEvent": "ClosedBatch" } ], "TransactionTime": "2024-11-19T15:58:01Z", "TransMethod": "ach", "Type": "credit" } ], "Summary": { "heldAmount": 3.7, "pageSize": 0, "refunds": -3521.85, "serviceFees": 852.48, "totalAmount": 61645.74, "totalNetAmount": 61645.74, "totalPages": 21872, "totalRecords": 21872, "transferAmount": 0 } } ``` **SDK Code** ```python Example query response import requests url = "https://api-sandbox.payabli.com/api/Query/settlements/8cfec329267" querystring = {"fromRecord":"251","limitRecord":"0","sortBy":"desc(field_name)"} headers = {"requestToken": ""} response = requests.get(url, headers=headers, params=querystring) print(response.json()) ``` ```javascript Example query response const url = 'https://api-sandbox.payabli.com/api/Query/settlements/8cfec329267?fromRecord=251&limitRecord=0&sortBy=desc%28field_name%29'; const options = {method: 'GET', headers: {requestToken: ''}}; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go Example query response package main import ( "fmt" "net/http" "io" ) func main() { url := "https://api-sandbox.payabli.com/api/Query/settlements/8cfec329267?fromRecord=251&limitRecord=0&sortBy=desc%28field_name%29" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("requestToken", "") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby Example query response require 'uri' require 'net/http' url = URI("https://api-sandbox.payabli.com/api/Query/settlements/8cfec329267?fromRecord=251&limitRecord=0&sortBy=desc%28field_name%29") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["requestToken"] = '' response = http.request(request) puts response.read_body ``` ```java Example query response import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://api-sandbox.payabli.com/api/Query/settlements/8cfec329267?fromRecord=251&limitRecord=0&sortBy=desc%28field_name%29") .header("requestToken", "") .asString(); ``` ```php Example query response request('GET', 'https://api-sandbox.payabli.com/api/Query/settlements/8cfec329267?fromRecord=251&limitRecord=0&sortBy=desc%28field_name%29', [ 'headers' => [ 'requestToken' => '', ], ]); echo $response->getBody(); ``` ```csharp Example query response using RestSharp; var client = new RestClient("https://api-sandbox.payabli.com/api/Query/settlements/8cfec329267?fromRecord=251&limitRecord=0&sortBy=desc%28field_name%29"); var request = new RestRequest(Method.GET); request.AddHeader("requestToken", ""); IRestResponse response = client.Execute(request); ``` ```swift Example query response import Foundation let headers = ["requestToken": ""] let request = NSMutableURLRequest(url: NSURL(string: "https://api-sandbox.payabli.com/api/Query/settlements/8cfec329267?fromRecord=251&limitRecord=0&sortBy=desc%28field_name%29")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ``` > If you're a software company, you're a payments company™