WIwithflex
Payment Intents

Cancel Payment Intent

Changed on

Cancels a PaymentIntent

post/v1/payment_intents/{id}/cancel

Request

  • Base URL
    https://api.withflex.com
  • URL
    https://api.withflex.com/v1/payment_intents/{id}/cancel
  • Auth
    HTTP bearer

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,
    "application_fee_amount": 0,
    "customer": "fcus_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
    "transfer_data": {
      "amount": 2500,
      "destination": "facct_01J9XR8M3K7VZ8N2YB4WJ6T0RA"
    },
    "status": "canceled",
    "latest_charge": "fch_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
    "created_at": "2026-06-15T14:30:00Z",
    "invoice": "fin_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
    "capture_method": "automatic",
    "client_secret": "string",
    "metadata": {
      "order_id": "8842",
      "channel": "shopify"
    },
    "payment_method": "fpm_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
    "test_mode": false,
    "transfer_group": "example_value",
    "payment_card_type": "primary",
    "letter_fee_amount": 0,
    "transaction_fee": 0,
    "last_payment_error": {
      "type": "string",
      "code": "string",
      "decline_code": "string",
      "message": "string",
      "payment_method": "fpm_01J9XR8M3K7VZ8N2YB4WJ6T0RA"
    }
  }
}

Changes

  • eec642897a22Revision changes
    • breaking

      the ////////// response's property format changed from email to no format for status

    • breaking

      the /////////////////// response's property format changed from email to no format for status

    • breaking

      the //////////////////////////// response's property format changed from email to no format for status

    • breaking

      the ///////////////////////////////// response's property format changed from email to no format for status

    • breaking

      the /////////////////// response's property format changed from email to no format for status

    • breaking

      the //////////////////////////// response's property format changed from email to no format for status

    • breaking

      the ///////////////////////////////////// response's property format changed from email to no format for status

    • breaking

      the ////////////////////////////////////////// response's property format changed from email to no format for status

    • breaking

      the /////////////// response's property format changed from email to no format for status

    • warning

      added the new adaptiveShoesDependent enum value to the /////////////////////////////////// response property for the response status

    • warning

      added the new adaptiveShoesDependent enum value to the //////////////////////////////////////////// response property for the response status

    • warning

      added the new automatedCleaner enum value to the /////////////////////////////////// response property for the response status

    • warning

      added the new automatedCleaner enum value to the //////////////////////////////////////////// response property for the response status

    • warning

      added the new babyMonitorSplit enum value to the /////////////////////////////////// response property for the response status

    • warning

      added the new babyMonitorSplit enum value to the //////////////////////////////////////////// response property for the response status

    • warning

      added the new babySleepApp enum value to the /////////////////////////////////// response property for the response status

    • warning

      added the new babySleepApp enum value to the //////////////////////////////////////////// response property for the response status

    • warning

      added the new bodyPillow enum value to the /////////////////////////////////// response property for the response status

    • warning

      added the new bodyPillow enum value to the //////////////////////////////////////////// response property for the response status

    • warning

      added the new breathWorkDependent enum value to the /////////////////////////////////// response property for the response status

    • warning

      added the new breathWorkDependent enum value to the //////////////////////////////////////////// response property for the response status

    • warning

      added the new coolingSleepwear enum value to the /////////////////////////////////// response property for the response status

    • warning

      added the new coolingSleepwear enum value to the //////////////////////////////////////////// response property for the response status

    • warning

      added the new meneralsNootropicPouch enum value to the /////////////////////////////////// response property for the response status

    • warning

      added the new meneralsNootropicPouch enum value to the //////////////////////////////////////////// response property for the response status

    • warning

      added the new nonenalOdor enum value to the /////////////////////////////////// response property for the response status

    • warning

      added the new nonenalOdor enum value to the //////////////////////////////////////////// response property for the response status

    • warning

      added the new nursingChairs enum value to the /////////////////////////////////// response property for the response status

    • warning

      added the new nursingChairs enum value to the //////////////////////////////////////////// response property for the response status

    • warning

      added the new speechHealthDependent enum value to the /////////////////////////////////// response property for the response status

    • warning

      added the new speechHealthDependent enum value to the //////////////////////////////////////////// response property for the response status

    • warning

      added the new uvClothing enum value to the /////////////////////////////////// response property for the response status

    • warning

      added the new uvClothing enum value to the //////////////////////////////////////////// response property for the response status

    • warning

      added the new uvGlasses enum value to the /////////////////////////////////// response property for the response status

    • warning

      added the new uvGlasses enum value to the //////////////////////////////////////////// response property for the response status

    • info

      added the optional property ////////// to the response with the status

    • info

      added the optional property /////////////////// to the response with the status

    • info

      added the optional property ////////////////////////// to the response with the status

    • info

      added the optional property /////////////////// to the response with the status

    • info

      added the optional property /////////////////// to the response with the status

    • info

      added the optional property //////////////////////////// to the response with the status

    • info

      added the optional property /////////////////////////////////// to the response with the status

    • info

      added the optional property //////////////////////////// to the response with the status