Update a transfer reversal
Update a reversal's description or metadata. The amount cannot be changed. Send only
the fields you want to change.
Authorization
X-API-Key X-Publishable-Key Your Bolt API key, from Developer > API in the Bolt Merchant Dashboard. Server-side only.
Sandbox keys work only against api-sandbox.boltapp.com. Using a sandbox key against
production, or the reverse, returns 401.
In: header
The publicly shareable identifier for your merchant division. Your authenticated account is always one side of a transfer, and seller IDs are resolved against it.
In: header
Path Parameters
The ID of the transfer to operate on.
The ID of the reversal to operate on.
Header Parameters
Bolt's standard replay protection for POST and PATCH requests. Use a UUID, up to 255
characters. A key can only be replayed on an identical request, and a replayed response
carries Idempotent-Replayed: true. Concurrent requests sharing a key return 409. Keys
expire after 24 hours.
On Create transfer this is secondary to reference, whose protection does not expire.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Only description and metadata can be changed.
Response Body
application/json
application/json
application/json
application/json
curl -X PATCH "https://example.com/v3/transfers/trf_9f8e7d6c5b/reversals/trr_4a3b2c1d0e" \ -H "Idempotency-Key: 8f14e45f-ea8f-4b3c-9b1a-0d1c2e3f4a5b" \ -H "Content-Type: application/json" \ -d '{}'{ "id": "trr_4a3b2c1d0e", "created_at": "2026-10-20T11:02:44Z", "transfer_id": "trf_9f8e7d6c5b", "status": "pending", "amount": { "currency": "USD", "units": 4000 }, "reference": "reversal-return-8831", "description": "Partial return, 1 of 3 items", "payout_reference": "po_20261021_0044", "metadata": { "invoice": "INV-2026-0114" }}