Fiest Developers

Find refund events

Lists individual refunds by their refund business date, oldest first, with incremental amounts, stable opaque refund IDs, original order links when resolvable, frozen…

GET/v1/restaurants/{restaurantId}/refunds

Lists individual refunds by their refund business date, oldest first, with incremental amounts, stable opaque refund IDs, original order links when resolvable, frozen returned-line quantity deltas and signed canonical accounting impacts. A June sale refunded in July appears in July. Includes separately classified pending-payment and extra-capture returns; these do not imply a new sale or VAT credit. Legacy cumulative evidence cannot prove missing partial refund dates. Follow every nextCursor unchanged with the same restaurant, date and order filters. Flags are page-local. Re-read overlapping windows and deduplicate refundId to catch late evidence; pagination is not a permanent change feed. Unknown impacts remain null. Original sale references from getOrderDetails do not prove provider refund execution.

Quick request

curl -X GET "https://example.com/v1/restaurants/11111111-1111-4111-8111-111111111111/refunds?organization_id=33333333-3333-4333-8333-333333333333&start_date=2019-08-24&end_date=2019-08-24" \  -H "Authorization: Bearer $FIEST_ACCESS_TOKEN"
{  "data": {    "restaurantId": "11111111-1111-4111-8111-111111111111",    "period": {      "startDate": "2026-07-01",      "endDate": "2026-07-31",      "timeZone": "Europe/Helsinki",      "dayStartHour": 0    },    "policy": "refund-event-date/v1",    "events": [],    "nextCursor": null,    "truncated": false,    "legacyTiming": false,    "incompleteEvidence": false  }}

Authorization

fiestOAuth fiest.restaurant.read, fiest.orders.read, fiest.accounting.read
AuthorizationBearer <token>

OAuth 2.1 authorization code with PKCE. Partner clients and redirect URIs must be approved by Fiest before use.

In: header

Scope: fiest.restaurant.read, fiest.orders.read, fiest.accounting.read

Path Parameters

restaurantId*string

A restaurant identifier returned by the authorized restaurant list.

Formatuuid

Query Parameters

organization_id?string

An organizationId returned by GET /v1/organizations. Required for restaurant-scoped calls when a Management portfolio authorization covers more than one organization; omitted for a single-restaurant authorization and optional for a one-organization grant.

Formatuuid
start_date*string

Inclusive refund business date. The window must not exceed 31 days.

Formatdate
end_date*string

Inclusive refund business date.

Formatdate
order_id?string

Exact opaque original order ID; optional. Omit to include returns with no completed original order.

Length1 <= length <= 255
cursor?string

Use the preceding response nextCursor unchanged with the same filters.

Length1 <= length <= 1024
limit?integer
Range1 <= value <= 20
Default10

Response Body

application/json

application/json

application/json

application/json

application/json

application/json