Skip to main content
Retrieves detailed information about a specific collection by its ID.

​
Path Parameters

​
id
string
required
Collection ID

​
Example Request

GET /public/collections/pay_9fmz6170pzaih14pmyl0a49o1l

​
Response

​
status
string
Response status (“success”)
​
message
string
Success message
​
data
object
Full collection object (same structure as Create Collection response)

​
Example Response

{
  "status": "success",
  "message": "Collection 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
  }
}

​
Error Responses

​
status
string
“error”
​
message
string
Error message
404 Not Found: Collection not found
401 Unauthorized: Invalid API key
403 Forbidden: Collection belongs to different account