API ReferenceapiaffiliatesPOST /v1/reversals

POST /v1/reversals

Service: affiliates · operationId: (none)

Reverse all commissions for a refunded order

Required scopes

(no scope declared — review service config)

Request body

{
  "type": "object",
  "properties": {
    "order_id": {
      "type": "string",
      "minLength": 1
    },
    "reason": {
      "type": "string",
      "minLength": 1
    }
  },
  "required": [
    "order_id",
    "reason"
  ]
}

Responses

200 Commissions reversed

{
  "type": "object",
  "properties": {
    "order_id": {
      "type": "string"
    },
    "reversed_commission_ids": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "total_reversed_cents": {
      "type": "string"
    }
  },
  "required": [
    "order_id",
    "reversed_commission_ids",
    "total_reversed_cents"
  ]
}

404 No commissions found

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string"
    },
    "message": {
      "type": "string"
    }
  },
  "required": [
    "error",
    "message"
  ]
}

409 Commissions already reversed

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string"
    },
    "message": {
      "type": "string"
    }
  },
  "required": [
    "error",
    "message"
  ]
}

Example

curl -X POST https://affiliates.platform.loop.health/v1/reversals \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'