Date Range Filtering

Introduction

Date range filtering allows clients to retrieve entities within a specified time frame. Our API supports date filtering according to the time the data was created in Justt system.

Date Range Parameters

• startDate (optional): The start date for the date range filter.

  • Type: String (ISO 8601 date and time in UTC)
  • Example: 2023-01-01T00:00:00Z

• endDate (optional): The end date for the date range filter.

  • Type: String (ISO 8601 date and time in UTC)
  • Example: 2023-01-31T23:59:59Z

Example

Endpoint: /chargebacks

Example Request with Date Range Filtering

GET /chargebacks?startDate=2023-01-01T00:00:00Z&endDate=2023-01-31T23:59:59Z&limit=20&skip=40

Example Response

{
  "data": [
    {
      "id": "cb001",
      "amount": 150.99,
      "status": "disputed",
      "timestamp": "2023-01-15T12:30:00Z"
    },
    // ... (19 more chargebacks within the specified date range)
  ],
  "hasMore": true
}

Response Explanation

• data: An array containing chargeback entities within the specified date range.
• hasMore: A boolean flag indicating whether there are more chargebacks available for retrieval.

Best Practices

• Provide both startDate and endDate parameters for accurate date range filtering.
• Use the ISO 8601 date and time format in UTC to ensure consistency and avoid ambiguity.