EukaPay API uses cursor-based pagination accepting a limit and either starting_after or ending_before parameters to determine records returned. The starting_after and ending_before parameters are mutually exclusive, i.e only one of starting_after or ending_before may be used.

Parameters

limit - number, optional, default is 100
A limit on the number of records to be returned

starting_after - optional
Specifying this parameter returns records preceding the specified object. For example, if the specified value points to a record at position 10, it returns records no 9,8,7 etc. Accepts code as value.

ending_before - optional
Specifying this parameter returns records after the specified object code. For example, if the specified value points to a record at position 10, it returns records ...14,13,12,11. Accepts code as value

Response Body Format

data - array
An array containing the actual response elements, paginated by any request parameters.

has_more - boolean
Whether or not there are more elements available after this set

Sample JSON Response

{
  "data": [
    {
      "code": "inv_19OnEUVKx36p0EIV4LDDU0239C",
      "price": "441.50",
      "type": 1,
      "number": "INV-211224-6",
      "message": "The messages",
      "issueDate": "2021-12-17",
      "dueDate": "2021-12-25",
      "redirectUri": "",
      "deletedAt": null,
      "createdAt": "2021-12-24T11:17:54.883Z",
      "updatedAt": "2021-12-28T11:28:08.000Z",,
      "client": {
         "code": "cus_q06lpsoz2v7cwd5mn2tlxkr2jv",
          "email": "[email protected]",
          "firstName": "Alejandra",
          "lastName": "Kerluke",
          "businessName": "Annalise",
          "taxNumber": "u8nrum8t46meoucygd8htrc2jc8yru",
          "country": "Christmas Island",
          "streetNumber": "",
          "streetName": "Donna Street",
          "address1": "372 Stephanie Crossing",
          "address2": "Apt. 459",
          "unit": "",
          "city": "Flossieport",
          "state": "Louisiana",
          "zip": "98853-0382",
          "deleted": 0,
          "createdAt": "2021-12-21T03:07:47.653Z",
          "updatedAt": "2021-12-21T03:07:47.653Z"
      },
      "currency": {
        "id": "1",
        "name": "Canadian Dollar",
        "unit": "CAD",
        "sign": "CA$",
        "sequence": "1",
        "disable": false
      },
      "invoiceItems": [
        {
            "method": "QTY",
            "name": "Peperoni Salad",
            "price": "30.22",
            "discount": "6.68",
            "tax": "12.99",
            "quantity": 3,
            "createdAt": "2021-12-24T11:17:54.898Z",
            "updatedAt": "2021-12-24T11:17:54.898Z"
        },
        {
            "method": "QTY",
            "name": "Moselli Salad",
            "price": "40.22",
            "discount": "6.68",
            "tax": "12.99",
            "quantity": 2,
            "createdAt": "2021-12-24T11:17:54.912Z",
            "updatedAt": "2021-12-24T11:17:54.912Z"
        }
      ],
      "payment": null,
      "sentClients": []
    },
    {...},
    {...}
  ],
  "has_more": true
}