v1
latestOpenAPI 3.1.02026-07-2684271522.2 KBPayment Intents
Cancel Payment Intent
Cancels a PaymentIntent
post/v1/payment_intents/{id}/cancel
Path parameters
idstring required
Example:fpi_01J9XR8M3K7VZ8N2YB4WJ6T0RA
Response
An envelope wrapping a single payment intent object.
Example response
{
"payment_intent": {
"payment_intent_id": "fpi_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
"amount": 2500,
"amount_capturable": 2500,
"amount_received": 2500,
"transfer_data": {},
"status": "canceled",
"created_at": "2026-06-15T14:30:00Z",
"capture_method": "automatic",
"metadata": {
"order_id": "8842",
"channel": "shopify"
},
"test_mode": false,
"transfer_group": "example_value",
"payment_card_type": "primary",
"last_payment_error": {}
}
}