Analytics
API ReferenceAnalyticsRefunds
Refund Metrics
Returns aggregated refund metrics over a time window. The full request shape, scopes, and response envelope are documented in Analytics overview.
POST /analytics/v1/{scope}/metrics/refunds
| Path parameter | Type | Description |
|---|---|---|
scope | string | One of merchant or org. |
Available metrics
| Metric | Type | Description |
|---|---|---|
refund_count | integer | Number of refunds initiated in the window. |
refund_success_count | integer | Number of refunds that completed (status succeeded). |
refund_success_rate | number (0–1) | refund_success_count / refund_count. |
refund_processed_amount | integer | Sum of completed refund amounts, in the lowest currency unit. |
Available groupByNames
| Name | Description |
|---|---|
currency | Three-letter ISO currency. |
connector | Connector that processed the refund. |
refund_status | Final refund status. |
refund_type | Instant or Scheduled. |
profile_id | Business profile id. |
Available filters
| Filter | Example |
|---|---|
currency | ["USD", "EUR"] |
connector | ["stripe", "adyen"] |
refund_status | ["succeeded", "failed"] |
profile_id | ["pro_xxx"] |
Request Example
curl -X POST 'https://api.v2.paychtec.com/analytics/v1/merchant/metrics/refunds' \ -H "Content-Type: application/json" \ -H "api-key: snd_YOUR_API_KEY" \ -d '[ { "timeRange": { "startTime": "2024-01-15T00:00:00Z", "endTime": "2024-01-22T23:59:59Z" }, "metrics": [ "refund_count", "refund_success_rate", "refund_processed_amount" ], "source": "BATCH", "delta": false, "groupByNames": [ "currency" ] }]'Response
{
"queryData": [
{
"currency": "USD",
"refund_count": 84,
"refund_success_rate": 0.988,
"refund_processed_amount": 142500
},
{
"currency": "EUR",
"refund_count": 31,
"refund_success_rate": 1.0,
"refund_processed_amount": 58200
}
],
"metaData": [
{ "total_refund_processed_amount": 200700 }
]
}