Skip to main content
PATCH
/
sales
Mark a sale as refunded
curl --request PATCH \
  --url https://www.referly.so/api/v1/sales \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "saleId": 123
}'
{
  "success": true,
  "alreadyRefunded": true,
  "reason": "<string>"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Sale refund details

saleId
integer
required

The sale ID to mark as refunded

Response

Sale refund status processed successfully

success
boolean

Whether the refund request was handled successfully

alreadyRefunded
boolean

Whether the sale had already been marked as refunded before this request

reason
string

Result reason, such as refunded or already_refunded