POST/v1/tenants/{tenantId}/ecom_stores/{eComStoreId}/orders/{salesOrderId}/refunds/{refundId}/confirm

Confirm refund

Marks the credit document financially settled after the refund has been processed.

application/jsonobjectnon-null

Request body for confirming a refund on a return invoice

refundedAmountstringnullableoptional: Amount refunded, if applicable
Format: BigDecimal
Example"299.00"
statusstringnon-nullrequired: Refund status
Allowed values"CONFIRMED""FAILED"
Example"CONFIRMED"

200Response

No response body documented.

400Bad Request - Refund is not a return order invoice or is not open

Bad Request - Refund is not a return order invoice or is not open

application/jsonobjectnon-null

errorstringnon-nullrequired: Stable error code
Example"INVALID_REQUEST"
messagestringnon-nullrequired: Human-readable error message
Example"Invalid customer ID format"
resolutionstringnon-nullrequired: Suggested next action
Example"Correct the customer ID and retry the request"

401Unauthorized - Invalid or missing authentication

Unauthorized - Invalid or missing authentication

application/jsonobjectnon-null

errorstringnon-nullrequired: Stable error code
Example"INVALID_REQUEST"
messagestringnon-nullrequired: Human-readable error message
Example"Invalid customer ID format"
resolutionstringnon-nullrequired: Suggested next action
Example"Correct the customer ID and retry the request"

403

application/jsonobjectnon-null

errorstringnon-nullrequired: Stable error code
Example"INVALID_REQUEST"
messagestringnon-nullrequired: Human-readable error message
Example"Invalid customer ID format"
resolutionstringnon-nullrequired: Suggested next action
Example"Correct the customer ID and retry the request"

404Not Found - Refund not found or does not belong to this ecom store's order

Not Found - Refund not found or does not belong to this ecom store's order

application/jsonobjectnon-null

errorstringnon-nullrequired: Stable error code
Example"INVALID_REQUEST"
messagestringnon-nullrequired: Human-readable error message
Example"Invalid customer ID format"
resolutionstringnon-nullrequired: Suggested next action
Example"Correct the customer ID and retry the request"

500

application/jsonobjectnon-null

errorstringnon-nullrequired: Stable error code
Example"INVALID_REQUEST"
messagestringnon-nullrequired: Human-readable error message
Example"Invalid customer ID format"
resolutionstringnon-nullrequired: Suggested next action
Example"Correct the customer ID and retry the request"