> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://beta-docs.payabli.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://beta-docs.payabli.com/_mcp/server. # List notifications by paypoint GET https://api-sandbox.payabli.com/api/Query/notifications/{entry} Returns a list of notifications for an entrypoint. Use filters to limit results. Reference: https://beta-docs.payabli.com/api-reference/notification/get-list-of-notifications-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 help. List of field names accepted: * frequency (in, nin,ne, eq) * method (in, nin, eq, ne) * event (in, nin, eq, ne) * target (ct, nct, eq, ne) * status (eq, ne) List of comparison accepted - enclosed between parentheses: * 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 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: totalAmount(gt)=20 return all records with totalAmount 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 QueryResponseNotificationsRecordsItem, 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 ### QueryResponseNotificationsRecordsItem - `content` (NotificationContent, optional) — Notification content. - `createdAt` (datetime, optional) — Timestamp of when notification was created, in UTC. - `frequency` (enum, optional) — Frequency for notification. For notifications using the *email* ,*sms*, or *web* `method`, the allowed values are: - untilcancelled - one-time For notifications using the *report-email* or *report-web* `method`, the allowed values are: - one-time - daily - weekly - biweekly - monthly - quarterly - semiannually - annually - Allowed values: `one-time`, `daily`, `weekly`, `biweekly`, `monthly`, `quarterly`, `semiannually`, `annually`, `untilcancelled` - `lastUpdated` (datetime, optional) — Timestamp of when notification was last updated, in UTC. - `method` (enum, optional) — Method to use to send the notification to the target. - Allowed values: `email`, `sms`, `web`, `report-email`, `report-web` - `notificationId` (long, optional) — The notification's Payabli identifier. This is the ID used to manage the notifcation. - `ownerId` (string, optional) — ID for the paypoint or organization that owns the notification. - `ownerName` (string, optional) — Name of entity owner of notification. - `ownerType` (integer, optional) — Entity owner type. Accepted values: - `0`: Organization/partner - `2`: Paypoint - `source` (string, optional) — Custom descriptor of source of notification. - `status` (integer, optional) — Status of notification: - `0`: Inactive - `1`: Active - `target` (string, optional) — Specify the notification target. For **method**=*email* the expected value is a list of email addresses separated by semicolon. For **method**=*sms* the expected value is a list of phone numbers separated by semicolon. For **method**=*web*. the expected value is a valid and complete URL. Webhooks support only standard HTTP ports: 80, 443, 8080, or 4443. ### 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. ### NotificationContent - `eventType` (enum, optional) — The notification's event name. - Allowed values: `ApprovedPayment`, `AuthorizedPayment`, `DeclinedPayment`, `OriginatedPayment`, `SettledPayment`, `FundedPayment`, `VoidedPayment`, `RefundedPayment`, `HoldTransaction`, `ReleasedTransaction`, `HoldBatch`, `ReleasedBatch`, `TransferDisabledCreditFund`, `TransferDisabledDebitFund`, `TransferNotAvailableBalance`, `TransferReturn`, `TransferSuccess`, `TransferSuspended`, `TransferError`, `SendReceipt`, `RecoveredTransaction`, `CreatedApplication`, `SubmittedApplication`, `ActivatedMerchant`, `ReceivedChargeBack`, `ReceivedAchReturn`, `HoldingApplication`, `DeclinedApplication`, `BoardingApplication`, `FraudAlert`, `InvoiceSent`, `InvoicePaid`, `InvoiceCreated`, `BillPaid`, `BillApproved`, `BillDisApproved`, `BillCanceled`, `BillProcessing`, `PayOutFunded`, `PayOutProcessed`, `PayOutCanceled`, `PayOutPaid`, `importFileReceived`, `importFileProcessed`, `importFileError`, `exportFileSent`, `exportFileError`, `Report`, `FailedEmailNotification`, `FailedWebNotification`, `FailedSMSNotification`, `UserPasswordCloseExpire`, `UserPasswordExpired` - `fileFormat` (enum, optional) — Indicate the format of report file to be generated by the engine. Used for `method` = *report-email* and *report-web*. - Allowed values: `json`, `csv`, `xlsx` - `internalData` (list of KeyValueDuo, optional) — Array of pairs key:value to insert in request body to target in **method** = *web* or *report-web*. - `reportName` (enum, optional) — The kind report to generate. For [automated reports](/developer-guides/notifications-and-webhooks-overview#automated-reports) only. - Allowed values: `Transaction`, `Settlement`, `Boarding`, `Returned` - `timeZone` (integer, optional) — Timezone, in UTC offset. For example, -5 is Eastern time. - `transactionId` (string, optional, default: 0) — Used internally to reference the entity or object generating the event. - `webHeaderParameters` (list of KeyValueDuo, optional) — Array of pairs key:value to insert in header of request to target in **method** = *web* or *report-web*. ### KeyValueDuo - `key` (string, optional) — Key name. - `value` (string, optional) — Key value. ## Examples **Response** ```json { "Records": [ { "content": { "eventType": "ReceivedChargeBack", "timeZone": 0 }, "createdAt": "2022-06-07T05:00:00Z", "frequency": "untilcancelled", "lastUpdated": "2022-06-07T05:00:00Z", "method": "email", "notificationId": 88976, "ownerId": "123", "ownerName": "Pilgrim Planner", "ownerType": 2, "source": "api", "status": 1, "target": "example@example.com" }, { "content": { "eventType": "ReceivedAchReturn", "timeZone": 0 }, "createdAt": "2022-06-07T05:00:00Z", "frequency": "untilcancelled", "lastUpdated": "2022-06-07T05:00:00Z", "method": "email", "notificationId": 88975, "ownerId": "123", "ownerName": "Pilgrim Planner", "ownerType": 2, "source": "api", "status": 1, "target": "example@example.com" } ], "Summary": { "pageSize": 20, "totalAmount": 0, "totalNetAmount": 0, "totalPages": 1, "totalRecords": 2 } } ``` **SDK Code** ```python QueryResponseExample import requests url = "https://api-sandbox.payabli.com/api/Query/notifications/8cfec329267" querystring = {"fromRecord":"251","limitRecord":"0","sortBy":"desc(field_name)"} headers = {"requestToken": ""} response = requests.get(url, headers=headers, params=querystring) print(response.json()) ``` ```javascript QueryResponseExample const url = 'https://api-sandbox.payabli.com/api/Query/notifications/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 QueryResponseExample package main import ( "fmt" "net/http" "io" ) func main() { url := "https://api-sandbox.payabli.com/api/Query/notifications/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 QueryResponseExample require 'uri' require 'net/http' url = URI("https://api-sandbox.payabli.com/api/Query/notifications/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 QueryResponseExample import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://api-sandbox.payabli.com/api/Query/notifications/8cfec329267?fromRecord=251&limitRecord=0&sortBy=desc%28field_name%29") .header("requestToken", "") .asString(); ``` ```php QueryResponseExample request('GET', 'https://api-sandbox.payabli.com/api/Query/notifications/8cfec329267?fromRecord=251&limitRecord=0&sortBy=desc%28field_name%29', [ 'headers' => [ 'requestToken' => '', ], ]); echo $response->getBody(); ``` ```csharp QueryResponseExample using RestSharp; var client = new RestClient("https://api-sandbox.payabli.com/api/Query/notifications/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 QueryResponseExample import Foundation let headers = ["requestToken": ""] let request = NSMutableURLRequest(url: NSURL(string: "https://api-sandbox.payabli.com/api/Query/notifications/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() ```