Use this endpoint to reverse a previous funds allocation, for example when a transaction is refunded or cancelled. The reversal mirrors the original allocation structure with all amounts negated.

Making the request

Call POST /funds/allocations/{id}/reverse. Pass the fundsAllocationId from the allocation you want to reverse.

See the Reverse a funds allocation endpoint for the full schema.

The response

A successful reversal returns HTTP 201 with the original fundsAllocationId, a reversalId and the same structure as the original allocation response. All amounts are negated.

{
  "fundsAllocationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "currencyCode": "GBP",
  "credits": [
    {
      "projectId": "dfa40a8a-8c24-404d-bed9-6bc3ee60b2b6",
      "impactAmount": -10.0,
      "impactSalesTaxAmount": 0.0,
      "impactSalesTaxRate": 0.0,
      "serviceFeeAmount": -2.0,
      "serviceFeeSalesTaxAmount": -0.4,
      "serviceFeeSalesTaxRate": 0.2
    }
  ],
  "taxLiability": "platform",
  "reversalId": "9c1b2d3e-4f5a-6b7c-8d9e-0a1b2c3d4e5f"
}