NuruPayDocs
Collections

List collections

GET
/v1/collections

Newest first. Page with starting_after set to the last id of the previous page while has_more is true.

Authorization

apiKey
AuthorizationBearer <token>

Authorization: Bearer np_test_sk_…. The key's prefix selects test or live mode.

In: header

Query Parameters

limit?integer
Range1 <= value <= 100
Default20
starting_after?string

A collection ID; returns collections created before it.

Match^col_[0-9A-HJKMNP-TV-Z]{26}$

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/collections"
{  "object": "list",  "data": [    {      "id": "string",      "object": "collection",      "status": "created",      "amount": 0,      "fee": 0,      "currency": "TZS",      "channel": "MPESA_TZ",      "phone": "string",      "reference": "string",      "description": "string",      "metadata": {},      "failure_code": "insufficient_funds",      "failure_message": "string",      "mode": "live",      "created_at": "2019-08-24T14:15:22Z",      "completed_at": "2019-08-24T14:15:22Z"    }  ],  "has_more": true}