Creates refund

Creates a new refund.

Path Parameters
orderId int32 — REQUIRED The order id.

Request Body — REQUIRED Information about the refund.
OrderRowId int32 The order row that this refund row represents. Commonly used with returns. Optional.
Reference string An custom reference for the refund. Optional.
Description string A description of the refund. Optional.
Author string The name of author of the refund. Optional.
RefundAmount double The refund amount. Required.
ToBalance boolean If true, will refund the amount to the customer's balance.
Settled boolean If true, the refund will be marked as settled immediatley and won't trigger a refund event. This can be useful if the refund needs to be created retroactively, or when the money transacation has already occured.
RefundType int32 Possible values: [0, 1, 2, 3] What kind of source transaction the refund is derived from. 0 = Default. A regular refund of the order or order row. 1 = InstanceCost. Return cost type, used in drawing cost for instance. 2 = Shipping. Refund shipping type, used to refund shipping. 3 = InvoiceFee. Refund invoice fee. 0 = Default. A regular refund of the order or order row. 1 = InstanceCost. Return cost type, used in drawing cost for instance. 2 = Shipping. Refund shipping type, used to refund shipping. 3 = InvoiceFee. Refund invoice fee.
SkipRefundEvents boolean If true, will skip sending refund events.
RefundsRequireApproval boolean If set to true, refunds will require approval before being sent. Only applies if Settled is false.

Responses
200 The id of the created refund. Schema — OPTIONAL Resource uuid — OPTIONAL The resource on which the action was taken. 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 Resource uuid — OPTIONAL The resource on which the action was taken. 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 Resource uuid — OPTIONAL The resource on which the action was taken. Message string — OPTIONAL A status message for the action taken. Details string[] — OPTIONAL Any validation messages for the data on the current action.