Skip to main content
Retrieves a paginated list of all integrated collections for your account.

​
Query Parameters

​
page
number
default:"1"
Page number
​
limit
number
default:"10"
Items per page (max: 100)

​
Example Request

GET /public/collections?page=1&limit=20

​
Response

​
status
string
Response status (“success”)
​
message
string
Success message
​
data
array
Array of collection objects
​
meta
object
Pagination metadata
​
meta.count
number
Total number of collections
​
meta.next
number
Next page number (null if no next page)
​
meta.prev
number
Previous page number (null if no previous page)

​
Example Response

{
  "status": "success",
  "message": "Collections retrieved successfully",
  "data": [
    {
      "id": "pay_9fmz6170pzaih14pmyl0a49o1l",
      "type": "integrated",
      "contact": {
        "id": "contact_gj7iyx04gs7hticrite6m6qdhc",
        "firstName": "Amina",
        "lastName": "Lawal",
        "phone": "+2348012345678",
        "email": "[email protected]"
      },
      "reference": "PSK_txn_8a7f34",
      "amount": {
        "value": 45000,
        "currency": "NGN"
      },
      "status": "pending",
      "expiresIn": 1440,
      "payable": {
        "enabled": true,
        "methods": ["payment_link", "virtual_account"],
        "options": []
      },
      "followUp": {
        "enabled": true,
        "startAfter": 20,
        "cadence": "every_10m",
        "channels": ["whatsapp", "sms"],
        "tone": "gentle"
      },
      "metadata": [
        {
          "name": "Standard Membership",
          "amount": {
            "value": 15000,
            "currency": "NGN"
          },
          "description": "January plan renewal",
          "quantity": 1
        }
      ],
      "events": [],
      "createdAt": "2025-11-12T17:46:07.000Z",
      "updatedAt": "2025-11-12T17:46:07.000Z",
      "completedAt": null
    }
  ],
  "meta": {
    "count": 50,
    "next": 2,
    "prev": null
  }
}