API references
Search documentation... ⌘K
Open merchant dashboard
Merchant API
All our references

Retrieve Dispute Performance

Returns dispute performance data for the authenticated merchant based on the specified date range.

The endpoint supports various input formats: - Specific date: YYYY-MM-DD (e.g., "2024-01-15") - Date range: YYYY-MM-DD..YYYY-MM-DD (e.g., "2024-01-01..2024-01-31")

The response includes aggregated metrics such as total amount and count of disputes.

Timezone Handling

The service uses the merchant's configured timezone for all date boundaries and grouping.

Endpoint signature
This endpoint requires an API key. Read our authentication guide for more information.
POST https://api.reservepay.com/merchants/retrieve-dispute-performance HTTP/1.1
Content-Type: application/json
Accept: application/json
Authorization: Bearer <token>
{
period: string,
include_won: boolean?,
include_lost: boolean?,
include_in_progress: boolean?,
}
Returns: object
New to Reservepay? Read our guide on how to call endpoints to get started.
Request arguments
period string

Required. The date or date range for which to retrieve dispute performance data.

Supported formats: - Specific date: YYYY-MM-DD (e.g., "2024-01-15") - Date range: YYYY-MM-DD..YYYY-MM-DD (e.g., "2024-01-01..2024-01-31")

include_won boolean

Optional. Whether to include won disputes in the performance data. Default is true.

include_lost boolean

Optional. Whether to include lost disputes in the performance data. Default is true.

include_in_progress boolean

Optional. Whether to include in-progress (non-finalized) disputes in the performance data. Default is true.

Response attributes
Attribute Description
start_date
string

Always present. The start date of the performance period in ISO 8601 format (YYYY-MM-DD).

This represents the beginning of the date range for which performance data is calculated. For single day requests, this will be the same as end_date.
end_date
string

Always present. The end date of the performance period in ISO 8601 format (YYYY-MM-DD).

This represents the end of the date range for which performance data is calculated. For single day requests, this will be the same as start_date.
amount
number

Always present. The total amount of all captured transactions in the period, expressed in the smallest currency unit. E.g. 100 THB is represented as 10000. And 100 JPY is represented as 100.
count
number

Always present. The total number of captured transactions in the period.
average
number

Nullable. The average captured transaction amount in the smallest currency unit.
change
number

Nullable. The percentage change in total amount compared to the previous equivalent period.

Values: - Positive: Indicates an increase in compared to the previous period - Negative: Indicates a decrease in compared to the previous period - Null: When there are no transactions in the previous period (division by zero)

Example: A value of 15.5 means increased by 15.5% compared to the previous period.
granularity
string

Always present. The time granularity used for transaction breakdown in the response.

Granularity is determined by the date range: - hourly: Single day requests (0 days) - daily: 1-83 days range - weekly: 84-167 days range - monthly: 168+ days range

This affects how the transactions array is grouped and formatted.

Possible values:
  • hourly
  • daily
  • weekly
  • monthly
transactions
array

Always present. Array of transaction breakdowns grouped by the specified granularity.

Each transaction object contains: - total_amount: Total amount for the period in smallest currency unit - total_count: Number of transactions for the period - period_start: Start of the period (format varies by granularity)

Period start formats: - hourly: "HH:00:00" (e.g., "14:00:00") - daily: "YYYY-MM-DD" ISO 8601 format (e.g., "2024-01-15") - weekly: "YYYY-MM-DD" (week start date) - monthly: "YYYY-MM-DD" (month start date)

Note: Array may be empty if no transactions exist for the specified date range.
Errors specific to this endpoint
INVALID_DATE_FORMAT

Invalid date format. Please use YYYY-MM-DD or YYYY-MM-DD..YYYY-MM-DD.

INVALID_DATE_RANGE

End date cannot be before start date.

Errors common to all endpoints
UNHANDLED_ERROR

This error occurs when the server encounters an unexpected internal error that it cannot handle gracefully. This typically happens due to bugs, infrastructure issues, or edge cases that weren't anticipated during development.

INVALID_ARGUMENTS

This error occurs when the request contains invalid or missing parameters. Common cases include missing required fields, or values that don't match the expected format or type.

BAD_VERSION

This error occurs when making requests to an API version that does not exist. This commonly happens when using an outdated SDK or when the API version specified in the request URL is incorrect.

Open in Markdown
CODE SAMPLES
curl
curl "https://api.reservepay.com/merchants/retrieve-dispute-performance" \
  -X POST
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer $(RESERVEPAY_API_KEY)" \
  -d '{
        "period": "2024-01-01..2024-01-31",
        "include_lost": false
      }'
Learn how to run these code samples in your terminal by reading our guide.