Report a processed refund

post

https://api.protectplus.io/returns/{return_id}/refund

Notify Get Plus that your OMS has processed the refund for a
return. Get Plus records the refund outcome (amount, deductions, your
refund id), moves the return to PROCESSED, and confirms to the
customer. The refund itself is executed only in your OMS — Get Plus
never moves money.

The update is atomic: once a refund is recorded the return cannot be
processed again. Re-sending the same external_refund_id is idempotent
and returns 200; a different external_refund_id for an
already-processed return returns 409.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

return_id

string

required

The Get Plus return id — return_id from the POST /returns response, data.returns[].id from GET /returns, or data.return.id from GET /returns/{return_id}. NOT the top-level id from POST /returns (that is the return request, not the return).

Body Params

refund_amount

number

required

Amount refunded to the customer, in the order currency.

external_refund_id

string

required

Your OMS's refund transaction id. Also the idempotency key for this callback.

currency

string

3-letter ISO code. Defaults to USD when omitted.

deductions

number

Total deductions withheld (restocking, damage, etc.). Defaults to 0.

executed_at

date-time

When the refund was executed in your OMS. Defaults to the time the callback is received.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200Refund recorded and return marked processed — or the same external_refund_id was already recorded (idempotent replay).

400Rejected by the returns service — missing required fields or the return is not on a custom-platform order.

401Unauthorized

403Return belongs to another store

404Unknown return_id — callbacks never create returns. The id must be an existing return (see GET /returns).

409A refund with a different external_refund_id is already recorded for this return.

422Request body failed validation

429Rate limit exceeded