v1

latestOpenAPI 3.1.02026-07-2684271522.2 KB

Refunds

Get Refund

Retrieves the details of an existing refund by its ID.

get/v1/refunds/{refund_id}

Path parameters

refund_idstring required

Example:fre_01J9XR8M3K7VZ8N2YB4WJ6T0RA

Response

An envelope wrapping a single refund object.

Example response

{
  "refund": {
    "refund_id": "fre_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
    "payment_intent_id": "fpi_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
    "amount": 2500,
    "created_at": "2026-06-15T14:30:00Z",
    "reason": "duplicate",
    "status": "pending",
    "test_mode": false,
    "metadata": {
      "order_id": "8842",
      "channel": "shopify"
    },
    "reference_id": "obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
    "reference_type": "acquirer_reference_number",
    "reference_status": "available",
    "items": [
      {}
    ],
    "subscription_id": "fsub_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
    "invoice_id": "fin_01J9XR8M3K7VZ8N2YB4WJ6T0RA"
  }
}