Bolt has moved to boltapp.com. Stores still using bolt.com hosts must update now: see the migration guide.

Skip to content

Cancel a transfer

View As MarkdownMCP
POST
/v3/transfers/{id}/cancel

Withdraw a transfer that has not yet been included in a payout, and release the hold on the sending account's balance. Only transfers in pending can be cancelled.

Once a transfer is in_transit the money is on its way to the bank: it can be neither cancelled nor reversed until it reaches paid, at which point a reversal is the way to bring the money back.

Cancelling an already cancelled transfer still returns transfer_not_cancelable, so send an Idempotency-Key if you need a retry that is safe to repeat.

Authorization

X-API-Key X-Publishable-Key
X-API-Key<token>

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

X-Publishable-Key<token>

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

id*string

The ID of the transfer to operate on.

Header Parameters

Idempotency-Key?string

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.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v3/transfers/trf_9f8e7d6c5b/cancel" \  -H "Idempotency-Key: 8f14e45f-ea8f-4b3c-9b1a-0d1c2e3f4a5b"
{  "id": "trf_1c2d3e4f5a",  "created_at": "2026-10-14T18:04:11Z",  "updated_at": "2026-10-14T18:19:50Z",  "status": "cancelled",  "direction": "payout",  "seller_id": "seller_5512",  "reference": "payout-2026-10-14-seller5512",  "amount": {    "units": 1250,    "currency": "USD"  },  "amount_reversed": {    "units": 0,    "currency": "USD"  },  "reversed": false,  "description": null,  "transfer_group": "PAYOUT_2026_10_W2",  "payout_reference": null,  "failure_reason": null,  "reversals": [],  "metadata": {}}