> 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/customer/get-list-of-customers-for-an-organization/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://beta-docs.payabli.com/_mcp/server. # List customers by organization GET https://api-sandbox.payabli.com/api/Query/customers/org/{orgId} Retrieves a list of customers for an org. Use filters to limit results. Reference: https://beta-docs.payabli.com/api-reference/customer/get-list-of-customers-for-an-organization ## 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 - `orgId` (integer, required) — The numeric identifier for organization, assigned by Payabli. ### 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 details. **List of Accepted Field Names:** * `createdDate` (gt, ge, lt, le, eq, ne) * `customernumber` (ne, eq, ct, nct) * `firstname` (ne, eq, ct, nct) * `lastname` (ne, eq, ct, nct) * `name` (ct, nct) * `address` (ne, eq, ct, nct) * `city` (ne, eq, ct, nct) * `country` (ne, eq, ct, nct) * `zip` (ne, eq, ct, nct) * `state` (ne, eq, ct, nct) * `shippingaddress` (ne, eq, ct, nct) * `shippingcity` (ne, eq, ct, nct) * `shippingcountry` (ne, eq, ct, nct) * `shippingzip` (ne, eq, ct, nct) * `shippingstate` (ne, eq, ct, nct) * `phone` (ne, eq, ct, nct) * `email` (ne, eq, ct, nct) * `company` (ne, eq, ct, nct) * `username` (ne, eq, ct, nct) * `balance` (gt, ge, lt, le, eq, ne) * `status` (in, nin, eq, ne) * `additional-xxx` (ne, eq, ct, nct) where xxx is the additional field name * `orgId` (eq) *mandatory when entry=org* * `paypointId` (ne, eq) * `paypointLegal` (ne, eq, ct, nct) * `paypointDba` (ne, eq, ct, nct) * `orgName` (ne, eq, ct, nct) **List of Accepted Comparisons:** * `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 "|" **Accepted Parameters:** * `limitRecord`: Max number of records for query (default="20", "0" or negative value for all) * `fromRecord`: Initial record in query **Example Usage:** `balance(gt)=20` will return all records with a balance 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 CustomerQueryRecords, optional) - `Summary` (QuerySummary, optional) ## Errors ### 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 ### CustomerQueryRecords - `AdditionalFields` (map from string to string, optional) — List of additional custom fields in format key:value. - `Address` (string, optional) — Customer address. - `Address1` (string, optional) — Additional line for customer address. - `Balance` (double, optional) — Customer balance. - `City` (string, optional) — Customer city. - `Company` (string, optional) — Company name. - `Country` (string, optional) — Customer country. - `Created` (datetime, optional) — Date and time created. - `customerConsent` (CustomerQueryRecordsCustomerConsent, optional) - `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) - `customerSummary` (CustomerSummaryRecord, optional) - `customerUsername` (string, optional) — Username for customer. - `Email` (string, optional) — Customer email address. - `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. - `Firstname` (string, optional) — Customer first name. - `IdentifierFields` (list of string, optional) — List of fields acting as customer identifiers, to be used instead of CustomerNumber. - `Lastname` (string, optional) — Customer last name. - `LastUpdated` (datetime, optional) — Date and time of last update. - `MFA` (boolean, optional) — When `true`, multi-factor authentication (MFA) is enabled. - `MFAMode` (integer, optional) - `pageidentifier` (string, optional) — Auxiliary validation used internally by payment pages and components. - `ParentOrgName` (string, optional) — The name of the parent organization. - `PaypointDbaname` (string, optional) — Paypoint DBA name. - `PaypointEntryname` (string, optional) — The entrypoint identifier. - `PaypointLegalname` (string, optional) — Paypoint legal name. - `Phone` (string, optional) — Customer phone number. - `ShippingAddress` (string, optional) — The shipping address. - `ShippingAddress1` (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". - `snData` (string, optional) — Additional data provided by the social network related to the customer. - `snIdentifier` (string, optional) — Identifier or token for customer in linked social network. - `snProvider` (string, optional) — Social network linked to customer. Possible values: - facebook - google - twiter - microsoft - `State` (string, optional) — Customer state. - `StoredMethods` (list of MethodQueryRecords, optional) — List of payment methods associated to the customer. - `Subscriptions` (list of SubscriptionQueryRecords, optional) — List of subscriptions associated to the customer. - `TimeZone` (integer, optional) — Timezone, in UTC offset. For example, -5 is Eastern time. - `Zip` (string, optional) — Customer zip code. ### QuerySummary - `pageIdentifier` (string, optional) — Auxiliary validation used internally by payment pages and components. - `pageSize` (integer, optional) — Number of records on each response page. - `totalAmount` (double, optional) — Total amount for the records. - `totalNetAmount` (double, optional) — Total net amount for the records. - `totalPages` (integer, optional) — Total number of records in response. - `totalRecords` (integer, optional) — Total number of records in response. ### CustomerQueryRecordsCustomerConsent - `eCommunication` (CustomerQueryRecordsCustomerConsentECommunication, optional) — Describes the customer's email communications consent status. - `sms` (CustomerQueryRecordsCustomerConsentSms, optional) — Describes the customer's SMS communications consent status. ### CustomerSummaryRecord - `numberofTransactions` (integer, optional) — Number total of transactions or payments - `recentTransactions` (list of TransactionQueryRecords, optional) — List of more recent 5 transactions belonging to the customer - `totalAmountTransactions` (double, optional) — Total amount in transactions - `totalNetAmountTransactions` (double, optional) — Total net amount in transactions ### MethodQueryRecords - `bin` (string, optional) — The bank identification number (BIN). Null when method is ACH. - `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. - `descriptor` (string, optional) — When the method is a card, this field displays card brand. When the method is ACH, this field displays the account type for ACH (checking or savings). - `expDate` (string, optional) — Expiration date associated to the method (only for card) in format MMYY. - `holderName` (string, optional) — Account holder name for the method. - `idPmethod` (string, optional) — Method internal ID - `lastUpdated` (datetime, optional) — Date of last update - `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) — Type of payment vehicle: **ach** or **card** ### SubscriptionQueryRecords - `CreatedAt` (datetime, optional) — Timestamp of when the subscription ws created, in UTC. - `Customer` (QueryTransactionPayorData, optional) - `EndDate` (datetime, optional) — The subscription's end date. - `EntrypageId` (long, optional) — If applicable, the internal reference ID to the payment page capturing the payment. - `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. - `FeeAmount` (double, optional) — Fee applied to the subscription. - `Frequency` (string, optional) — The subscription's frequency. - `IdSub` (long, optional) — The subscription's ID. - `InvoiceData` (BillData, optional) - `LastRun` (datetime, optional) — The last time the subscription was processed. - `LastUpdated` (datetime, optional) — The last date and time the subscription was updated. - `LeftCycles` (integer, optional) — The number of cycles the subscription has left. - `Method` (string, optional) — The subscription's payment method. - `NetAmount` (double, optional) — The subscription amount, minus any fees. - `NextDate` (datetime, optional) — The next date the subscription will be processed. - `ParentOrgName` (string, optional) — The name of the parent organization. - `PaymentData` (QueryPaymentData, optional) - `PaypointDbaname` (string, optional) — The paypoint's DBA name. - `PaypointEntryname` (string, optional) — The paypoint's entryname. - `PaypointId` (long, optional) — The paypoint's ID. Note that this is different than the entryname. - `PaypointLegalname` (string, optional) — The paypoint's legal name. - `PlanId` (integer, optional) — Payment plan ID. - `Source` (string, optional) — Custom identifier to indicate the transaction or request source. - `StartDate` (datetime, optional) — The subscription start date. - `SubEvents` (list of GeneralEvents, optional) — Events associated with the subscription. - `SubStatus` (integer, optional) — The subscription's status. - 0: Paused - 1: Active - `TotalAmount` (double, optional) — The subscription amount, including any fees. - `TotalCycles` (integer, optional) — The total number of cycles the subscription is set to run. - `UntilCancelled` (boolean, optional) — When `true`, the subscription has no explicit end date and will run until canceled. ### CustomerQueryRecordsCustomerConsentECommunication Describes the customer's email communications consent status. - `status` (integer, optional) — Customers's consent status. Allowed status: - 0: Customer hasn't opted in to communications - -1: Customer opt in pending - 1: Customer has opted in to communications - `updatedAt` (datetime, optional) — Timestamp of when record was last updated, in UTC. ### CustomerQueryRecordsCustomerConsentSms Describes the customer's SMS communications consent status. - `status` (integer, optional) — Customers's consent status. Allowed status: - 0: Customer hasn't opted in to communications - -1: Customer opt in pending - 1: Customer has opted in to communications - `updatedAt` (datetime, optional) — Timestamp of when record was last updated, in UTC. ### TransactionQueryRecords - `AchHolderType` (enum, optional, default: personal) — The bank's accountholder type: personal or business. - Allowed values: `personal`, `business` - `AchSecCode` (string, optional) — Standard Entry Class (SEC) code is a a three letter code that describes how an ACH payment was authorized. Supported values are: - PPD (Prearranged Payment and Deposit) - Used for credits or debits where an accountholder authorizes a company to initiate either a single or recurring transaction to their personal bank account. Common examples include direct deposit of payroll, mortgage payments, or utility bills. This is the default value for subscription payments. - WEB (Internet-Initiated/Mobile Entry) - Used for debit entries when authorization is obtained from an accountholder via the internet or a wireless network. Common examples are online bill payments, ecommerce purchases, and mobile app payments where the consumer enters their banking information online. - TEL (Telephone-Initiated Entry) - Used for one-time debit entries where authorization is obtained from a consumer via telephone. Common examples are phone-based purchases or bill payments where the consumer provides their banking information over the phone. - CCD (Corporate Credit or Debit) - Used for fund transfers between business accounts. This code is specifically for business-to-business transactions. Common examples include vendor payments and other business-to-business payments. - `BatchAmount` (double, optional) — Batch amount. - `BatchNumber` (string, optional) — Batch number. - `CfeeTransactions` (list of QueryCFeeTransaction, optional) — Service Fee or sub-charge transaction associated to the main transaction. - `ConnectorName` (string, optional) — Connector used for transaction. - `Customer` (QueryTransactionPayorData, optional) - `DeviceId` (string, optional) — Identifier of registered cloud device used in the transaction. - `EntrypageId` (long, optional) — If applicable, the internal reference ID to the payment page capturing the payment. - `ExternalProcessorInformation` (string, optional) — Processor information, used for troubleshooting and reporting. This field contains a value when the API key used to make the request has management permissions. - `FeeAmount` (double, optional) — Service fee or sub-charge applied. - `GatewayTransId` (string, optional) — Internal identifier used for processing. - `InvoiceData` (BillData, optional) - `Method` (string, optional) — Payment method used: card, ach, or wallet. - `NetAmount` (double, optional) — Net amount paid. - `Operation` (string, optional) — The transaction's operation. - `OrderId` (string, optional) — Custom identifier for the transaction. - `OrgId` (long, optional) — ID of immediate parent organization. - `ParentOrgName` (string, optional) — The name of the parent organization. - `PaymentData` (QueryPaymentData, optional) - `PaymentTransId` (string, optional) — Unique Transaction ID. - `PayorId` (long, optional) — Unique ID for customer linked to the transaction. - `PaypointDbaname` (string, optional) — Paypoint's DBA name. - `PaypointEntryname` (string, optional) — Paypoint's entryname. - `PaypointId` (long, optional) — InternalId for paypoint. - `PaypointLegalname` (string, optional) — Paypoint's legal name. - `PendingFeeAmount` (double, optional) — The difference between the configured pass-through fee and the fee amount sent in the request. When transfering funds, Payabli uses this field to deduct the fee difference and transfer the correct amount to the merchant. When a paypoint is set up to absorb fees, and the pass-through fee sent with the request is less than the configured amount, the difference must be covered by the merchant. See [Fee Configuration](/guides/passthrough-fees#fee-configuration) to learn more about pass-through fee settings. - `RefundId` (long, optional) — Identifier of refund transaction linked to this payment. - `ResponseData` (QueryResponseData, optional) — The transaction's response data. - `ReturnedId` (long, optional) — Identifier of return/chargeback transaction linked to this payment. - `ScheduleReference` (long, optional) — Reference to the subscription that originated the transaction. - `SettlementStatus` (integer, optional) — Settlement status for transaction. See [the docs](/references/money-in-statuses#payment-funding-status) for a full reference. - `Source` (string, optional) — Custom identifier to indicate the transaction or request source. - `splitFundingInstructions` (list of SplitFundingContent, optional) — Split funding instructions for the transaction. The total amount of the splits must match the total amount of the transaction. - `TotalAmount` (double, optional) — Transaction total amount (including service fee or sub-charge) - `TransactionEvents` (list of QueryTransactionEvents, optional) — Events associated with this transaction. - `TransactionTime` (datetime, optional) — Transaction date and time, in UTC. - `TransAdditionalData` (any, optional) - `TransStatus` (integer, optional) — Status of transaction. See [the docs](/references/money-in-statuses#money-in-transaction-status) for a full reference. ### 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. ### 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. ### GeneralEvents - `description` (string, optional) — Event description. - `eventTime` (datetime, optional) — Event timestamp, in UTC. - `extraData` (map from string to any, optional) — Extra data. - `refData` (string, optional) — Reference data. - `source` (string, optional) — The event source. ### QueryCFeeTransaction - `cFeeTransid` (string, optional) - `feeAmount` (double, optional) - `operation` (string, optional) - `refundId` (long, optional) - `responseData` (map from string to any, optional) - `settlementStatus` (integer, optional) - `transactionTime` (datetime, optional) — Timestamp when transaction was submitted, in UTC. - `transStatus` (integer, optional) ### 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. ### 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. ### 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. ### 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 ## Examples **Response** ```json { "Records": [ { "Address": "1234 Bayou Road", "Address1": "Suite 2", "Balance": 0, "City": "Lafayette", "Company": "Boudreaux's Shop", "Country": "US", "Created": "2023-12-20T13:07:48Z", "customerId": 2876, "customerNumber": "425436530000", "customerStatus": 0, "customerSummary": { "numberofTransactions": 30, "totalAmountTransactions": 1500, "totalNetAmountTransactions": 1500 }, "Email": "thibodeaux.hebert@bayoumail.com", "externalPaypointID": "pay-10", "Firstname": "Thibodeaux", "IdentifierFields": [ "email" ], "Lastname": "Hebert", "LastUpdated": "2023-12-20T13:07:48Z", "MFA": false, "MFAMode": 0, "ParentOrgName": "SupplyPro", "PaypointDbaname": "Global Factory LLC", "PaypointEntryname": "4872acb376a", "PaypointLegalname": "Global Factory LLC", "Phone": "(504) 823-4566", "ShippingAddress": "1234 Bayou Road", "ShippingAddress1": "Suite 2", "ShippingCity": "Lafayette", "ShippingCountry": "US", "ShippingState": "LA", "ShippingZip": "70501", "State": "LA", "TimeZone": 0, "Zip": "70501" } ], "Summary": { "pageIdentifier": "XXXXXXXXXXXXXX", "pageSize": 20, "totalAmount": 0, "totalNetAmount": 0, "totalPages": 26, "totalRecords": 510 } } ``` **SDK Code** ```python example1 import requests url = "https://api-sandbox.payabli.com/api/Query/customers/org/123" querystring = {"fromRecord":"251","limitRecord":"0","sortBy":"desc(field_name)"} headers = {"requestToken": ""} response = requests.get(url, headers=headers, params=querystring) print(response.json()) ``` ```javascript example1 const url = 'https://api-sandbox.payabli.com/api/Query/customers/org/123?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 example1 package main import ( "fmt" "net/http" "io" ) func main() { url := "https://api-sandbox.payabli.com/api/Query/customers/org/123?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 example1 require 'uri' require 'net/http' url = URI("https://api-sandbox.payabli.com/api/Query/customers/org/123?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 example1 import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://api-sandbox.payabli.com/api/Query/customers/org/123?fromRecord=251&limitRecord=0&sortBy=desc%28field_name%29") .header("requestToken", "") .asString(); ``` ```php example1 request('GET', 'https://api-sandbox.payabli.com/api/Query/customers/org/123?fromRecord=251&limitRecord=0&sortBy=desc%28field_name%29', [ 'headers' => [ 'requestToken' => '', ], ]); echo $response->getBody(); ``` ```csharp example1 using RestSharp; var client = new RestClient("https://api-sandbox.payabli.com/api/Query/customers/org/123?fromRecord=251&limitRecord=0&sortBy=desc%28field_name%29"); var request = new RestRequest(Method.GET); request.AddHeader("requestToken", ""); IRestResponse response = client.Execute(request); ``` ```swift example1 import Foundation let headers = ["requestToken": ""] let request = NSMutableURLRequest(url: NSURL(string: "https://api-sandbox.payabli.com/api/Query/customers/org/123?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™