Skip to main content

List refunds

GET 

/refunds

The refunds recorded at the outlet in X-Outlet-ID, newest first, including those made in the cashier app. Pages are keyset-based.

  • Send order_id to list only the refunds of one order (an order can have more than one).
  • A cursor is only valid with the same limit, the same order_id and the same endpoint.
  • Needs a plan with the refund order list.

Errors​

StatusCodeWhen
400INVALID_CURSORThe cursor came with another limit, another order_id or another endpoint.
400VALIDATION_FAILEDorder_id is not a UUID.
403PLAN_FEATURE_REQUIREDThe plan has no refund order list. data.reason is not_in_plan or disabled (the merchant can turn it on in Settings > Features), and data.feature is the feature key. A missing Public API add-on answers the same code without data.

Request​

Responses​

Refunds