Skip to main content
POST
/
v1
/
refunds
Create Refund
curl --request POST \
  --url https://api.withflex.com/v1/refunds \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "refund": {
    "payment_intent_id": "obj_01EXAMPLE00000000000000000",
    "amount": 0,
    "reason": "duplicate",
    "metadata": {}
  }
}
'
{
  "refund": {
    "refund_id": "obj_01EXAMPLE00000000000000000",
    "payment_intent_id": "obj_01EXAMPLE00000000000000000",
    "amount": 0,
    "created_at": "2024-01-01T00:00:00Z",
    "reason": "duplicate",
    "status": "pending",
    "test_mode": false,
    "metadata": {},
    "reference_id": "obj_01EXAMPLE00000000000000000",
    "reference_type": "acquirer_reference_number",
    "reference_status": "available",
    "items": [
      {}
    ],
    "subscription_id": "obj_01EXAMPLE00000000000000000",
    "invoice_id": "obj_01EXAMPLE00000000000000000"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.withflex.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Use a Bearer token to access this API.

Body

application/json
​
refund
object
required
Example:
{
  "payment_intent_id": "obj_01EXAMPLE00000000000000000",
  "amount": 0,
  "reason": "duplicate",
  "metadata": {}
}

Response

Success

​
refund
object
required
Example:
{
  "refund_id": "obj_01EXAMPLE00000000000000000",
  "payment_intent_id": "obj_01EXAMPLE00000000000000000",
  "amount": 0,
  "created_at": "2024-01-01T00:00:00Z",
  "reason": "duplicate",
  "status": "pending",
  "test_mode": false,
  "metadata": {},
  "reference_id": "obj_01EXAMPLE00000000000000000",
  "reference_type": "acquirer_reference_number",
  "reference_status": "available",
  "items": [
    {
      "amount_refunded": 0,
      "payment_intent": "string",
      "payment_method_id": "obj_01EXAMPLE00000000000000000",
      "reference_id": "obj_01EXAMPLE00000000000000000",
      "reference_type": "acquirer_reference_number",
      "reference_status": "available"
    }
  ],
  "subscription_id": "obj_01EXAMPLE00000000000000000",
  "invoice_id": "obj_01EXAMPLE00000000000000000"
}