Sign in

v1

latestOpenAPI 3.0.02026-07-262832203.2 KB
Order

Issue a refund against an order

post/v1/orders/{OrderId}/refunds

Path parameters

OrderIdstring uuid required
Example:cc7236aa-d11b-436c-a29c-d26cecadc847

Order ID to issue a refund against.

Request body

RefundIdstring uuid

Reach-generated unique id of a refund

Amountnumber float

Amount of the refund. Must be at most the total value of the original order, minus any other refunds.

State'INPROGRESS' | 'SUCCEEDED' | 'FAILED'

Refund state. See: https://docs.withreach.com/docs/states-and-events#refund-states

RefundReferencestring

A merchant-supplied reference ID. This must be unique within the order for the given refund

Response

Operation Successful

RefundIdstring uuid

Reach-generated unique id of a refund

Amountnumber float

Amount of the refund. Must be at most the total value of the original order, minus any other refunds.

State'INPROGRESS' | 'SUCCEEDED' | 'FAILED'

Refund state. See: https://docs.withreach.com/docs/states-and-events#refund-states

RefundReferencestring

A merchant-supplied reference ID. This must be unique within the order for the given refund