> This is Payabli documentation. For a complete page index, fetch https://docs.payabli.com/llms.txt — append .md to any page URL for lightweight markdown. For section-level indexes, query parameters, and other AI-optimized access methods, see https://docs.payabli.com/ai-agents.md

# List paypoints

GET https://api-sandbox.payabli.com/api/v2/paypoints

Lists paypoints with optional filtering and pagination.

Reference: https://docs.payabli.com/developers/api-reference/paypoints/list-paypoints

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Servers

- `https://api-sandbox.payabli.com/api` (Sandbox, default)
- `https://api.payabli.com/api` (Production)

## Request

### Query parameters

- `businessReference` (string, optional) — Filter by the business the paypoint belongs to.
- `status` (string, optional) — Filter by paypoint status.
- `search` (string, optional) — Free-text search across paypoints.
- `limit` (integer, optional) — Number of results per page.
- `page` (integer, optional) — Page number to return.

## Response

### 200

A page of paypoints.

- `success` (boolean, required) — Whether the request succeeded.
- `message` (string, required, nullable) — A human-readable result message.
- `traceId` (string, required, nullable) — The trace identifier for the request, useful for support.
- `data` (ListPaypointsResponse, required, nullable) — The page of paypoints.

## Errors

### 401 Unauthorized Error

Unauthorized request.

- `isSuccess` (boolean, required) — Always `false` for error responses.
- `responseText` (string, required) — Error text describing what went wrong.
- `responseCode` (integer, optional) — Code for the response. Learn more in [API Response Codes](/developers/api-reference/api-responses).
- `responseData` (PayabliErrorBodyResponseData, optional) — Object with detailed error context.

### 500 Internal Server Error

Internal server error.

- `isSuccess` (boolean, required) — Always `false` for error responses.
- `responseText` (string, required) — Error text describing what went wrong.
- `responseCode` (integer, optional) — Code for the response. Learn more in [API Response Codes](/developers/api-reference/api-responses).
- `responseData` (PayabliErrorBodyResponseData, optional) — Object with detailed error context.

## Types

### ListPaypointsResponse

A page of paypoints.

- `items` (list of PaypointSummaryResponse, required, nullable) — The paypoints on this page.
- `total` (integer, required) — The total number of paypoints across all pages.
- `page` (integer, required) — The current page number.
- `pageSize` (integer, required) — The number of paypoints per page.

### PayabliErrorBodyResponseData

Object with detailed error context.

- `explanation` (string, optional) — Human-readable explanation of what happened.
- `todoAction` (string, optional) — Suggested resolution.

### PaypointSummaryResponse

A paypoint as it appears in a list response.

- `paypointReference` (string, required) — The paypoint reference.
- `parentPaypointReference` (string, required) — The reference of the parent paypoint this paypoint nests under. For a merchant boarded directly under an organization, this is the organization, which is itself a paypoint.
- `paypointStatus` (string, required) — The paypoint's current status.
- `entryName` (string, required) — The paypoint's entrypoint name, used as the `entry` value on endpoints that target the paypoint.
- `createdAt` (string, required) — When the paypoint was created.
- `updatedAt` (string, required) — When the paypoint was last updated.
- `_links` (PaypointLinks, required) — Hypermedia links for the paypoint resource.
- `businessReference` (string, optional, nullable) — The reference of the business the paypoint belongs to.
- `paypointType` (string, optional, nullable) — The paypoint type, for example `merchant`.
- `doingBusinessAs` (string, optional, nullable) — The name the paypoint does business as (DBA).
- `description` (string, optional, nullable) — A free-text description of the paypoint.
- `website` (string, optional, nullable) — The paypoint's website URL.
- `timezone` (string, optional, nullable) — The paypoint's time zone.
- `customerServicePhone` (string, optional, nullable) — The customer service phone number.
- `customerServiceEmail` (string, optional, nullable) — The customer service email address.

### PaypointLinks

Hypermedia links for a paypoint resource.

- `self` (string, optional) — Relative path to the paypoint resource.
- `business` (string, optional) — Relative path to the business the paypoint belongs to.

## Examples

### ListPaypoints

**Response**

```json
{
  "success": true,
  "message": "Paypoints retrieved successfully",
  "traceId": "0HNNN6HH5NDBG:00000018",
  "data": {
    "items": [
      {
        "paypointReference": "019ff064-c690-7679-a73e-688418aadc7c",
        "parentPaypointReference": "a8806f02-23b3-4f6d-bba3-42e1b94326ea",
        "paypointStatus": "pending",
        "entryName": "8cfec329267",
        "createdAt": "2026-08-11T10:36:04.115771",
        "updatedAt": "2026-08-11T10:36:04.115788",
        "_links": {
          "self": "/v2/paypoints/019ff064-c690-7679-a73e-688418aadc7c",
          "business": "/v2/businesses/019fed1a-3d6e-75d3-a81e-cba3874b0a55"
        },
        "businessReference": "019fed1a-3d6e-75d3-a81e-cba3874b0a55",
        "paypointType": "merchant",
        "doingBusinessAs": "Rose Gardens",
        "description": "Boutique flower shop",
        "website": "https://example.com",
        "timezone": "America/New_York",
        "customerServicePhone": "3055551212",
        "customerServiceEmail": "support@example.com"
      }
    ],
    "total": 1,
    "page": 1,
    "pageSize": 1
  }
}
```

**SDK Code**

```python ListPaypoints
import requests

url = "https://api-sandbox.payabli.com/api/v2/paypoints"

querystring = {"limit":"1","page":"1"}

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers, params=querystring)

print(response.json())
```

```javascript ListPaypoints
const url = 'https://api-sandbox.payabli.com/api/v2/paypoints?limit=1&page=1';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go ListPaypoints
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api-sandbox.payabli.com/api/v2/paypoints?limit=1&page=1"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby ListPaypoints
require 'uri'
require 'net/http'

url = URI("https://api-sandbox.payabli.com/api/v2/paypoints?limit=1&page=1")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

```java ListPaypoints
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api-sandbox.payabli.com/api/v2/paypoints?limit=1&page=1")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php ListPaypoints
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api-sandbox.payabli.com/api/v2/paypoints?limit=1&page=1', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

```csharp ListPaypoints
using RestSharp;

var client = new RestClient("https://api-sandbox.payabli.com/api/v2/paypoints?limit=1&page=1");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift ListPaypoints
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api-sandbox.payabli.com/api/v2/paypoints?limit=1&page=1")! 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()
```

### ListBusinessPaypoints

**Response**

```json
{
  "success": true,
  "message": "Paypoints retrieved successfully",
  "traceId": "0HNONVR8FHLEO:0000005A",
  "data": {
    "items": [
      {
        "paypointReference": "019ff064-c690-7679-a73e-688418aadc7c",
        "parentPaypointReference": "a8806f02-23b3-4f6d-bba3-42e1b94326ea",
        "paypointStatus": "pending",
        "entryName": "8cfec329267",
        "createdAt": "2026-08-11T10:36:04.115771",
        "updatedAt": "2026-08-11T10:36:04.115788",
        "_links": {
          "self": "/v2/paypoints/019ff064-c690-7679-a73e-688418aadc7c",
          "business": "/v2/businesses/019fed1a-3d6e-75d3-a81e-cba3874b0a55"
        },
        "businessReference": "019fed1a-3d6e-75d3-a81e-cba3874b0a55",
        "paypointType": "merchant",
        "doingBusinessAs": "Rose Gardens"
      }
    ],
    "total": 1,
    "page": 1,
    "pageSize": 25
  }
}
```

**SDK Code**

```python ListBusinessPaypoints
import requests

url = "https://api-sandbox.payabli.com/api/v2/paypoints"

querystring = {"businessReference":"019fed1a-3d6e-75d3-a81e-cba3874b0a55"}

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers, params=querystring)

print(response.json())
```

```javascript ListBusinessPaypoints
const url = 'https://api-sandbox.payabli.com/api/v2/paypoints?businessReference=019fed1a-3d6e-75d3-a81e-cba3874b0a55';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go ListBusinessPaypoints
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api-sandbox.payabli.com/api/v2/paypoints?businessReference=019fed1a-3d6e-75d3-a81e-cba3874b0a55"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby ListBusinessPaypoints
require 'uri'
require 'net/http'

url = URI("https://api-sandbox.payabli.com/api/v2/paypoints?businessReference=019fed1a-3d6e-75d3-a81e-cba3874b0a55")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

```java ListBusinessPaypoints
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api-sandbox.payabli.com/api/v2/paypoints?businessReference=019fed1a-3d6e-75d3-a81e-cba3874b0a55")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php ListBusinessPaypoints
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api-sandbox.payabli.com/api/v2/paypoints?businessReference=019fed1a-3d6e-75d3-a81e-cba3874b0a55', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

```csharp ListBusinessPaypoints
using RestSharp;

var client = new RestClient("https://api-sandbox.payabli.com/api/v2/paypoints?businessReference=019fed1a-3d6e-75d3-a81e-cba3874b0a55");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift ListBusinessPaypoints
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api-sandbox.payabli.com/api/v2/paypoints?businessReference=019fed1a-3d6e-75d3-a81e-cba3874b0a55")! 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()
```