Payabli Docs

{
  "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
  }
}

Lists paypoints with optional filtering and pagination.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

businessReferencestringOptional

Filter by the business the paypoint belongs to.

statusstringOptional

Filter by paypoint status.

searchstringOptional

Free-text search across paypoints.

limitintegerOptional

Number of results per page.

pageintegerOptional

Page number to return.

Response

A page of paypoints.

successboolean

Whether the request succeeded.

messagestring or null

A human-readable result message.

traceIdstring or null

The trace identifier for the request, useful for support.

dataobject or null

The page of paypoints.

Errors

401

Unauthorized Error

500

Internal Server Error