Get payments for business

This endpoint makes an HTTP GET request to retrieve a list of payments with pagination. The request includes query parameters for the page number and limit of results per page.

GET:/v1/payment/

Params

Name	Type	Description
page	integer	The page number for paginated results
reference	string	The payment reference that was generated when initializing payment
limit	integer	The limit of payments per page
from	integer	The timestamp of the starting date
to	integer	The timestamp of the ending date

Headers

Name	Type	Description
public-key	string	Your Vesicash public key

Response

The response will have a status code of 200 and a content type of application/json. The body of the response will contain an array of payment data, including details such as payment ID, amount, environment, type, method, status, currency, reference, narration, provider transaction ID, customer details, business ID, creation timestamp, and update timestamp. Additionally, the response will include pagination information with details about the current page, total page count, and total pages count.

{
    "status": "success",
    "code": 200,
    "message": "success",
    "data": [
        {
            "id": "20a72fd0-a3a3-4c5d-9fea-e3a7e02b26a5",
            "amount": 1,
            "environment": "test",
            "type": "payment",
            "method": "mobilemoney",
            "status": "pending",
            "currency": "ZMW",
            "reference": "PY_c77f7bff21514bdf9dfe9f1b2",
            "narration": "",
            "provider_transaction_id": "",
            "customer_details": "00000000-0000-0000-0000-000000000000",
            "business_id": "8f212284-3a4d-4c2d-ad27-d0e8703c89cf",
            "created_at": "2024-08-21T12:38:56.704592Z",
            "updated_at": "2024-08-21T12:38:56.704592Z"
        },
        {
            "id": "b05d7e8a-deea-44fd-bc0a-ca6e467c368b",
            "amount": 1,
            "environment": "test",
            "type": "payment",
            "method": "mobilemoney",
            "status": "pending",
            "currency": "ZMW",
            "reference": "PY_6bfb1ddf065d40ebb26e57d7b",
            "narration": "",
            "provider_transaction_id": "",
            "customer_details": "00000000-0000-0000-0000-000000000000",
            "business_id": "8f212284-3a4d-4c2d-ad27-d0e8703c89cf",
            "created_at": "2024-08-21T10:54:11.119607Z",
            "updated_at": "2024-08-21T10:54:11.119607Z"
        }
         ],
    "pagination": [
        {
            "current_page": 1,
            "page_count": 3,
            "total_pages_count": 2
        }
    ]
}