GET
/
Query
/
transactions
/
org
/
{orgId}
curl --request GET \
  --url https://api-sandbox.payabli.com/api/Query/transactions/org/{orgId} \
  --header 'requestToken: <api-key>'
{
  "Summary": {
    "totalRecords": 2,
    "totalAmount": 77.22,
    "totalNetAmount": 77.22,
    "totalPages": 2,
    "pageSize": 20,
    "pageIdentifier": "null"
  },
  "Records": [
    {
      "ParentOrgName": "PropertyManager Pro",
      "PaypointDbaname": "Sunshine Gutters",
      "PaypointLegalname": "Sunshine Services, LLC",
      "PaypointEntryname": "d193cf9a46",
      "PaymentTransId": "226-fe55ec0348e34702bd91b4be198ce7ec",
      "ConnectorName": "gp",
      "ExternalProcessorInformation": "[MER_xxxxxxxxxxxxxx]/[NNNNNNNNN]",
      "GatewayTransId": "TRN_xwCAjQorWAYX1nAhAoHZVfN8iYHbI0",
      "OrderId": "O-5140",
      "Method": "ach",
      "BatchNumber": "batch_226_ach_12-30-2023",
      "BatchAmount": 30.22,
      "PayorId": 1551,
      "PaymentData": {
        "MaskedAccount": "4XXXXXXXX1111",
        "AccountType": "visa",
        "AccountExp": "11/29",
        "AccountZip": "90210",
        "HolderName": "Chad Mercia",
        "orderDescription": "Depost for materials for 123 Walnut St",
        "StoredId": "1ec55af9-7b5a-4ff0-81ed-c12d2f95e135-4440",
        "Initiator": "payor",
        "StoredMethodUsageType": "subscription",
        "Sequence": "subsequent",
        "accountId": "<string>",
        "SignatureData": null,
        "binData": {
          "binMatchedLength": 6,
          "binCardBrand": "Visa",
          "binCardType": "Credit",
          "binCardCategory": "PLATINUM",
          "binCardIssuer": "Bank of Example",
          "binCardIssuerCountry": "United States",
          "binCardIssuerCountryCodeA2": "US",
          "binCardIssuerCountryNumber": 840
        },
        "paymentDetails": {
          "totalAmount": 100,
          "serviceFee": 0,
          "currency": "USD",
          "checkNumber": "107",
          "checkImage": {},
          "categories": [
            {
              "label": "Deposit",
              "description": "Deposit for materials",
              "amount": 1000,
              "qty": 1
            }
          ],
          "splitFunding": [
            {
              "recipientEntryPoint": "41035afaa7",
              "accountId": "187-782",
              "description": "Split for annual dues",
              "amount": 456.23
            }
          ]
        }
      },
      "TransStatus": 1,
      "PaypointId": 226,
      "TotalAmount": 30.22,
      "NetAmount": 3762.87,
      "FeeAmount": 1,
      "SettlementStatus": 2,
      "Operation": "Sale",
      "ResponseData": {
        "response": "<string>",
        "responsetext": "CAPTURED",
        "authcode": null,
        "transactionid": "TRN_XXXXXGOa87juzW",
        "avsresponse": "<string>",
        "avsresponse_text": "<string>",
        "cvvresponse": "<string>",
        "cvvresponse_text": "<string>",
        "orderid": "O-5140",
        "type": "<string>",
        "response_code": "XXX",
        "response_code_text": "Transaction was approved.",
        "emv_auth_response_data": "<string>"
      },
      "Source": "api",
      "ScheduleReference": 0,
      "OrgId": 123,
      "RefundId": 0,
      "ReturnedId": 0,
      "TransAdditionalData": "<any>",
      "InvoiceData": {
        "invoiceNumber": "INV-2345",
        "invoiceDate": "2024-07-01",
        "invoiceDueDate": "2024-07-01",
        "invoiceType": 0,
        "invoiceEndDate": "2024-07-01",
        "invoiceStatus": 1,
        "frequency": "monthly",
        "paymentTerms": "PIA",
        "termsConditions": "Must be paid before work scheduled.",
        "notes": "Example notes.",
        "tax": 2.05,
        "discount": 10,
        "invoiceAmount": 105,
        "freightAmount": 10,
        "dutyAmount": 0,
        "purchaseOrder": "PO-345",
        "firstName": "Chad",
        "lastName": "Mercia",
        "company": "ACME, INC",
        "shippingAddress1": "123 Walnut St",
        "shippingAddress2": "STE 900",
        "shippingCity": "Johnson City",
        "shippingState": "TN",
        "shippingZip": "37619",
        "shippingCountry": "US",
        "shippingEmail": "example@email.com",
        "shippingPhone": "5555555555",
        "shippingFromZip": "30040",
        "summaryCommodityCode": "501718",
        "items": [
          {
            "itemProductCode": "M-DEPOSIT",
            "itemProductName": "Materials deposit",
            "itemDescription": "Deposit for materials.",
            "itemCommodityCode": "010",
            "itemUnitOfMeasure": "SqFt",
            "itemCost": 5,
            "itemQty": 1,
            "itemMode": 0,
            "itemCategories": [
              "<string>"
            ],
            "itemTotalAmount": 123,
            "itemTaxAmount": 7,
            "itemTaxRate": 0.075
          }
        ],
        "attachments": {},
        "AdditionalData": {
          "key1": "value1",
          "key2": "value2",
          "key3": "value3"
        }
      },
      "EntrypageId": 0,
      "TransactionTime": "2025-10-19T00:00:00",
      "Customer": {
        "CustomerId": 4440,
        "FirstName": "John",
        "LastName": "Doe",
        "CompanyName": "Sunshine LLC",
        "CustomerNumber": "3456-7645A",
        "BillingAddress1": "1111 West 1st Street",
        "BillingAddress2": "Suite 200",
        "BillingCity": "Miami",
        "BillingState": "FL",
        "BillingZip": "45567",
        "BillingCountry": "US",
        "BillingPhone": "5555555555",
        "BillingEmail": "example@email.com",
        "ShippingAddress1": "123 Walnut St",
        "ShippingAddress2": "STE 900",
        "ShippingCity": "Johnson City",
        "ShippingState": "TN",
        "ShippingZip": "37619",
        "ShippingCountry": "US",
        "AdditionalData": {
          "key1": "value1",
          "key2": "value2",
          "key3": "value3"
        },
        "CreatedAt": "2022-07-01 15:00:01",
        "customerId": 4440,
        "customerStatus": 1,
        "Identifiers": [
          "\\\"firstname\\\"",
          "\\\"lastname\\\"",
          "\\\"email\\\"",
          "\\\"customId\\\""
        ]
      },
      "CfeeTransactions": [
        {
          "cFeeTransid": "<string>",
          "transStatus": 123,
          "feeAmount": 123,
          "settlementStatus": 123,
          "operation": "<string>",
          "responseData": {},
          "refundId": 123,
          "transactionTime": "\"2025-01-16T01:06:40.97\""
        }
      ],
      "splitFundingInstructions": [
        {
          "recipientEntryPoint": "41035afaa7",
          "accountId": "187-782",
          "description": "Split for annual dues",
          "amount": 456.23
        }
      ],
      "TransactionEvents": [
        {
          "TransEvent": "Approved",
          "EventData": {},
          "EventTime": "2023-11-07T05:31:56Z"
        }
      ],
      "PendingFeeAmount": 2,
      "DeviceId": "6c361c7d-674c-44cc-b790-382b75d1xxx",
      "AchSecCode": "<string>",
      "AchHolderType": "personal"
    }
  ]
}

By default, this endpoint returns only transactions from the last 60 days. To query transactions outside of this period, include transactionDate filters.

For example, this request parameters filter for transactions between April 01, 2024 and April 09, 2024.

curl --request GET \
  --url https://sandbox.payabli.com/api/Query/transactions/org/1?limitRecord=20&fromRecord=0&transactionDate(ge)=2024-04-01T00:00:00&transactionDate(le)=2024-04-09T23:59:59\
  --header 'requestToken: <api-key>'

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

Authorizations

​
requestToken
string
header
required

Most endpoints require an organization token. Some endpoints require an application token, and those endpoints are noted.

Path Parameters

​
orgId
integer
required

The numeric identifier for organization, assigned by Payabli.

Example:

123

Query Parameters

​
parameters
object

Collection of field names, conditions, and values used to filter the query.

See Filters and Conditions Reference for more information.

List of field names accepted:

  • transactionDate (gt, ge, lt, le, eq, ne)
  • transId (ne, eq, ct, nct, in, nin)
  • gatewayTransId (ne, eq, ct, nct)
  • orderId (ne, eq)
  • scheduleId (ne, eq)
  • returnId (ne, eq)
  • refundId (ne, eq)
  • idTrans (ne, eq)
  • orgId (ne, eq)
  • paypointId (ne, eq)
  • paypointLegal (ne, eq, ct, nct)
  • paypointDba (ne, eq, ct, nct)
  • orgName (ne, eq, ct, nct)
  • externalPaypointId (ct, nct, eq, ne)
  • method (in, nin, eq, ne)
  • totalAmount (gt, ge, lt, le, eq, ne)
  • netAmount (gt, ge, lt, le, eq, ne)
  • feeAmount (gt, ge, lt, le, eq, ne)
  • operation (in, nin, eq, ne)
  • source (in, nin, eq, ne, ct, nct)
  • status (in, nin, eq, ne)
  • settlementStatus (in, nin, eq, ne)
  • batchNumber (nct, ct)
  • invoiceNumber (ct, nct)
  • authCode (ct, nct)
  • orderDescription (ct, nct)
  • payaccountLastfour (nct, ct)
  • payaccountType (ne, eq, in, nin)
  • payaccountCurrency (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)
  • deviceId (ct, nct, in, nin, eq, ne)
  • AchSecCode ( ct, nct, in, nin, eq, ne)
  • `AchHolderType`` (ct, nct, in, nin, eq, and ne)
  • additional-xxx (ne, eq, ct, nct) where xxx is the additional field name

List of comparison operators 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
  • nin => not inside array
​
limitRecord
integer
default:20

Max number of records to return for the query. Use 0 or negative value to return all records.

Example:

0

​
fromRecord
integer
default:0

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

Example:

251

​
sortBy
string

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.

Example:

"desc(field_name)"

Response

200
application/json
Success

Response payload for queries related to transactions

​
Summary
object
​
Records
object[] | null

Was this page helpful?