Skip to main content

Set refund as settled

Sets all refund rows in a refund as settled.

Path Parameters
orderId int32 — REQUIRED

The order id.

refundId uuid — REQUIRED

The refund id.

Request Body — REQUIRED

Contains optional fields for the settlement.

SettledByAdminUserId int32

The id of the admin user that settled the refund. Leave blank if unsure. Optional.

SettledOn date-time

The date the refund was settled. Defaults to now. Optional.

Responses
200

Ok.

Schema — OPTIONAL
Message string — OPTIONAL

A status message for the action taken.

Details string[] — OPTIONAL

Any validation messages for the data on the current action.

400

Bad request.

Schema — OPTIONAL
Message string — OPTIONAL

A status message for the action taken.

Details string[] — OPTIONAL

Any validation messages for the data on the current action.

404

Not found.

Schema — OPTIONAL
Message string — OPTIONAL

A status message for the action taken.

Details string[] — OPTIONAL

Any validation messages for the data on the current action.