Collections history

GET/payment-api/collections/history

Paginated list of collections made through the API, newest first, with optional filters.

Parameters

statusquerystringoptional
Only rows with this status.
successsubmittedpendingfailedinvaliddeclined
transaction_idquerystringoptional
Exact match on the reference you supplied when creating the transaction.
fromquerydateoptional
Start of day, inclusive. Format YYYY-MM-DD.
toquerydateoptional
End of day, inclusive. Must not be before from.
pagequeryintegeroptional
Page number, starting at 1.
page_sizequeryintegeroptional
Rows per page, 1 to 100. Default 15.

Field	Type	Required	Description
`status`query	string	optional	Only rows with this status. `successsubmittedpendingfailedinvaliddeclined`
`transaction_id`query	string	optional	Exact match on the reference you supplied when creating the transaction.
`from`query	date	optional	Start of day, inclusive. Format YYYY-MM-DD.
`to`query	date	optional	End of day, inclusive. Must not be before from.
`page`query	integer	optional	Page number, starting at 1.
`page_size`query	integer	optional	Rows per page, 1 to 100. Default 15.

Errors

403Your account is blocked.

Request

curl -X GET "https://api.bulkclix.com/api/v1/payment-api/collections/history?status=success&from=2026-09-01&to=2026-09-30&page_size=25" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Accept: application/json"

Response · 200

application/json

{
  "data": [
    {
      "transaction_id": "ORDER-2026-000123",
      "ext_transaction_id": "839201746512",
      "type": "collection",
      "amount": 50,
      "charges": 0.5,
      "net_amount": 50,
      "fee_bearer": "customer",
      "currency": "GHS",
      "channel": "MTN",
      "account_number": "233241234567",
      "account_name": "AMA MENSAH",
      "status": "success",
      "created_at": "2026-09-22T10:04:11+00:00"
    }
  ],
  "links": {
    "first": "…",
    "last": "…",
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "per_page": 25,
    "to": 1,
    "total": 1
  }
}