List Statements

List statements API allows partners to get all the available merchant statements for a particular merchant

GET https://<PayEngine-host>/api/merchant/:merchantId/statements

Path Parameters

Name	Type	Description
merchantId*	string	PayEngine merchant ID

Query Parameters

Name	Type	Description
limit	number	A limit on the number of objects to be returned. The limit can range between 1 and 100, and the default is 12.
page	number	Specify the page number that needs to be retrieved

200: OK

Field Definitions

This API will return an array of the following object.

Field Name	Type	Description	Required?
data[i].id	string	Merchant statement id	Required
data[i].date	string	Month and year for the statement	Required

Pagination meta data is provided in the response to support lazy loading and pagination.

"meta": {
    "total": 12,
    "current_page": 1,
    "total_pages": 6
}

Sample Request

curl --location --request GET '<API_HOST>/api/merchant/1cc7b594-b80f-4227-a0fa-299c4c6ce8ab/statements?page=1' \
--header 'Authorization: Basic <API_KEY>'

Sample Response

{
    "meta": {
        "total": 3,
        "current_page": 1,
        "total_pages": 1
    },
    "data": [
        {
            "id": "7a307bdb-6169-4901-b036-226e842caea6",
            "date": "May 2024"
        },
        {
            "id": "5d22760d-ccdb-4287-b4ef-4994f968b04f",
            "date": "April 2024"
        },
        {
            "id": "a7f6bfb0-1c5a-40df-ae5b-667c9ccf2779",
            "date": "March 2024"
        }
    ]
}