Sign in

v2

latestOpenAPI 3.1.02026-07-264249163.7 KB
v1
Orders

Refund Request

Refund an amount by order, either partial or in full. An example use-case is when an order was captured but the customer returned item(s) that requires them to be refunded.

post/v1/orders/{order_reference_id}/refund

Path parameters

order_reference_idstring required

The Order Reference ID to update

Request body

refund_idstring

UUID for the Refund. Must be unique to a Merchant

refund_reasonstring

A reason for the refund

is_full_refundboolean

Overrides amount. If true, the order will be fully refunded. If omitted, will default to false.

Response

Successful Operation

refund_idstring

The refund ID provided in the request

refund_reasonstring

The refund reason provided in the request