wire docs

Cancel a PaymentIntent

Cancels an intent that has not been paid. Allowed from `requires_payment_method`, `requires_action`, `requires_capture` and `processing`. If an operator invoice was already created, Wire voids it where the operator supports that. Sends a `payment_intent.canceled` event. Idempotent: canceling an intent that is already `canceled` returns it unchanged and sends no second event. **Errors:** `400 payment_intent_unexpected_state` — the intent already `succeeded`, or its status changed while canceling (re-read it); `404 resource_missing`. Because this is a `POST` under `/v1/payment_intents`, it can also return `403 connector_required` / `403 settlement_account_required`.

POST/v1/payment_intents/{id}/cancel

Authorization

bearerAuth
AuthorizationBearer <token>

Secret API key as a bearer token: Authorization: Bearer sk_live_…. Test keys (sk_test_…) are refused with 401 test_mode_unavailable. Keys are issued per project in the dashboard. Never expose a secret key in browser or mobile code.

In: header

Path Parameters

id*string

PaymentIntent id (pi_…).

Header Parameters

Idempotency-Key*string

Required on every POST and DELETE (missing → 400 parameter_missing; longer than 255 characters → 400 parameter_invalid). Use one stable key per logical operation, e.g. your order id plus the action. A retry with the same key and the same body returns the recorded response (header Idempotent-Replayed: true) instead of acting twice. The same key with a different body or path → 409 idempotency_key_in_use. While the first request is still running, a duplicate gets 409 idempotency_in_flight — wait a moment and retry. Successful (2xx) and declined (402) responses are recorded for 48 hours; other errors are not, so a retry after fixing a 400 runs normally. Keys are scoped to the API key's project.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/payment_intents/pi_k3vq7m2xw5nbt4rj6yhc2dpa7e/cancel" \  -H "Idempotency-Key: order-1001-create"
{
  "id": "pi_k3vq7m2xw5nbt4rj6yhc2dpa7e",
  "object": "payment_intent",
  "amount": 15000,
  "currency": "MNT",
  "description": "Order #1001",
  "status": "canceled",
  "client_secret": "cs_n2xk5q7mw3tz4vbr6jcy2gfa7m",
  "automatic_operator": true,
  "allowed_operators": [],
  "selected_operator": null,
  "next_action": null,
  "metadata": {
    "order_id": "1001"
  },
  "livemode": true,
  "created": 1791774000,
  "expires_at": 1791774600
}
{
  "error": {
    "type": "invalid_request_error",
    "code": "parameter_missing",
    "message": "amount is required",
    "param": "amount",
    "request_id": "req_8f3a1c9e5b7d2f4a6c0e9b1d"
  }
}

{
  "error": {
    "type": "api_error",
    "code": "test_mode_unavailable",
    "message": "test keys are not accepted by this API; use a live secret key",
    "request_id": "req_8f3a1c9e5b7d2f4a6c0e9b1d"
  }
}

{
  "error": {
    "type": "api_error",
    "code": "connector_required",
    "message": "connect a payment operator before creating payments — see the Connectors page in your dashboard",
    "request_id": "req_8f3a1c9e5b7d2f4a6c0e9b1d"
  }
}
{
  "error": {
    "type": "invalid_request_error",
    "code": "resource_missing",
    "message": "no such payment_intent",
    "request_id": "req_8f3a1c9e5b7d2f4a6c0e9b1d"
  }
}
{
  "error": {
    "type": "idempotency_error",
    "code": "idempotency_in_flight",
    "message": "A request with this Idempotency-Key is still being processed; retry shortly",
    "request_id": "req_8f3a1c9e5b7d2f4a6c0e9b1d"
  }
}