Skip to main content
POST
/
v1
/
payment_intents
/
{id}
/
cancel
Cancel Payment Intent
curl --request POST \
  --url https://api.withflex.com/v1/payment_intents/{id}/cancel \
  --header 'Authorization: Bearer <token>'
{
  "payment_intent": {
    "payment_intent_id": "obj_01EXAMPLE00000000000000000",
    "amount": 0,
    "amount_capturable": 0,
    "amount_received": 0,
    "application_fee_amount": 0,
    "customer": "string",
    "transfer_data": {
      "amount": 0,
      "destination": "string"
    },
    "status": "canceled",
    "latest_charge": "string",
    "created_at": "2024-01-01T00:00:00Z",
    "invoice": "string",
    "capture_method": "automatic",
    "client_secret": "string",
    "metadata": {},
    "payment_method": "string",
    "test_mode": false,
    "transfer_group": "string",
    "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": "string"
    }
  }
}

Authorizations

Authorization
string
header
required

Use a Bearer token to access this API.

Path Parameters

id
string
required
Example:

"obj_01EXAMPLE00000000000000000"

Response

Success

payment_intent
object
required
Example:
{
"payment_intent_id": "obj_01EXAMPLE00000000000000000",
"amount": 0,
"amount_capturable": 0,
"amount_received": 0,
"application_fee_amount": 0,
"customer": "string",
"transfer_data": { "amount": 0, "destination": "string" },
"status": "canceled",
"latest_charge": "string",
"created_at": "2024-01-01T00:00:00Z",
"invoice": "string",
"capture_method": "automatic",
"client_secret": "string",
"metadata": {},
"payment_method": "string",
"test_mode": false,
"transfer_group": "string",
"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": "string"
}
}