Update Refund - Flex Documentation

Update Refund

cURL

curl --request PATCH \
  --url https://api.withflex.com/v1/refunds/{refund_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "refund": {
    "reason": "duplicate",
    "metadata": {
      "order_id": "8842",
      "channel": "shopify"
    }
  }
}
'  

Python

import requests

url = "https://api.withflex.com/v1/refunds/{refund_id}"

payload = { "refund": {
        "reason": "duplicate",
        "metadata": {
            "order_id": "8842",
            "channel": "shopify"
        }
    } }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

JavaScript (Fetch)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    refund: {reason: 'duplicate', metadata: {order_id: '8842', channel: 'shopify'}}
  })
};

fetch('https://api.withflex.com/v1/refunds/{refund_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

PHP

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.withflex.com/v1/refunds/{refund_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "", 
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'refund' => [
        'reason' => 'duplicate',
        'metadata' => [
                'order_id' => '8842',
                'channel' => 'shopify'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

Go

package main

import (
    "fmt"
    "strings"
    "net/http"
    "io"
)

func main() {

url := "https://api.withflex.com/v1/refunds/{refund_id}"

payload := strings.NewReader("{\n  \"refund\": {\n    \"reason\": \"duplicate\",\n    \"metadata\": {\n      \"order_id\": \"8842\",\n      \"channel\": \"shopify\"\n    }\n  }\n}")

req, _ := http.NewRequest("PATCH", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
    req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
    body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}

Unirest (Java)

HttpResponse<String> response = Unirest.patch("https://api.withflex.com/v1/refunds/{refund_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"refund\": {\n    \"reason\": \"duplicate\",\n    \"metadata\": {\n      \"order_id\": \"8842\",\n      \"channel\": \"shopify\"\n    }\n  }\n}")
  .asString();

Ruby

require 'uri'
require 'net/http'

url = URI("https://api.withflex.com/v1/refunds/{refund_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"refund\": {\n    \"reason\": \"duplicate\",\n    \"metadata\": {\n      \"order_id\": \"8842\",\n      \"channel\": \"shopify\"\n    }\n  }\n}"

response = http.request(request)
puts response.read_body

Response Codes

• 200 OK: Successful update
• 401 Unauthorized: Invalid token
• 403 Forbidden: Insufficient permissions
• 404 Not Found: Refund not found
• 409 Conflict: Conflict in request
• 422 Unprocessable Entity: Validation errors
• 429 Too Many Requests: Rate limit exceeded

Response Example

{
  "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"
  }
}

Error Response Example

{
  "code": "string",
  "detail": "string"
}