Get All Collection

Retrieves collection transaction records for a specified user within a given date range. Supports pagination and sorting.

Request

GET {{base_url}}/api/v1/transaction/collection-query

Authentication & Headers

Header	Required	Description	Example
`x-merchant-ref`	Yes	Unique reference identifying the merchant.	`{{vault:x-merchant-ref}}`

Query Parameters

Parameter	Type	Required	Description	Example
`date_from`	string	Yes	Start date for the collection query.	`2026-03-01`
`date_to`	string	Yes	End date for the collection query.	`2026-03-31`
`page`	integer	Yes	Page number to retrieve.	`1`
`no_records`	integer	Yes	Number of records to return per page.	`10`
`sort`	string	Yes	Sort order. Accepts `asc` or `desc`.	`asc`
`user_ref`	string	Yes	Reference of the user associated with the collection.	`USR_784521`

Example Request

{{base_url}}/api/v1/transaction/collection-query?date_from=2026-03-01&date_to=2026-03-31&page=1&no_records=10&sort=asc&user_ref=USR_784521

Headers

Header	Value
`x-merchant-ref`	`{{vault:x-merchant-ref}}`

Example Response

{
  "status": "success",
  "message": "Retrieved successfully",
  "data": [
    {
      "amount": 2750,
      "collection_data": {
        "account_name": "Michael Adeyemi",
        "account_number": "0123456789",
        "bank_code": "058",
        "bank_name": "Example Bank"
      },
      "currency": "NGN",
      "date": "2026-03-15 14:40",
      "payment_ref": "PAY_784521",
      "payment_status": "SUCCESSFUL",
      "txn_merchant_ref": "COL_001245"
    }
  ]
}

Response

Field	Type	Description
`status`	string	Indicates whether the request was successful.
`message`	string	Response message.
`data`	array	List of collection transaction records.
`data[].amount`	number	Amount collected.
`data[].collection_data`	object	Bank account details associated with the collection.
`data[].collection_data.account_name`	string	Name on the collection account.
`data[].collection_data.account_number`	string	Collection account number.
`data[].collection_data.bank_code`	string	Bank code of the collection account.
`data[].collection_data.bank_name`	string	Name of the collection bank.
`data[].currency`	string	Currency of the collection.
`data[].date`	string	Date and time of the collection transaction.
`data[].payment_ref`	string	Unique payment reference.
`data[].payment_status`	string	Current status of the collection payment.
`data[].txn_merchant_ref`	string	Merchant reference for the collection transaction.

Updated 20 days ago

Did this page help you?