cURL
curl --request POST \
--url https://api.example.com/v1/panel/finance/orders/{orderID}/refund \
--header 'Content-Type: application/json' \
--header 'X-CSRF-Token: <x-csrf-token>' \
--header 'X-Operator-Reason: <x-operator-reason>' \
--data '
{
"amountMinor": 123,
"currency": "<string>",
"refundId": "<string>"
}
'import requests
url = "https://api.example.com/v1/panel/finance/orders/{orderID}/refund"
payload = {
"amountMinor": 123,
"currency": "<string>",
"refundId": "<string>"
}
headers = {
"X-CSRF-Token": "<x-csrf-token>",
"X-Operator-Reason": "<x-operator-reason>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-CSRF-Token': '<x-csrf-token>',
'X-Operator-Reason': '<x-operator-reason>',
'Content-Type': 'application/json'
},
body: JSON.stringify({amountMinor: 123, currency: '<string>', refundId: '<string>'})
};
fetch('https://api.example.com/v1/panel/finance/orders/{orderID}/refund', 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.example.com/v1/panel/finance/orders/{orderID}/refund",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'amountMinor' => 123,
'currency' => '<string>',
'refundId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-CSRF-Token: <x-csrf-token>",
"X-Operator-Reason: <x-operator-reason>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v1/panel/finance/orders/{orderID}/refund"
payload := strings.NewReader("{\n \"amountMinor\": 123,\n \"currency\": \"<string>\",\n \"refundId\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-CSRF-Token", "<x-csrf-token>")
req.Header.Add("X-Operator-Reason", "<x-operator-reason>")
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))
}HttpResponse<String> response = Unirest.post("https://api.example.com/v1/panel/finance/orders/{orderID}/refund")
.header("X-CSRF-Token", "<x-csrf-token>")
.header("X-Operator-Reason", "<x-operator-reason>")
.header("Content-Type", "application/json")
.body("{\n \"amountMinor\": 123,\n \"currency\": \"<string>\",\n \"refundId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/panel/finance/orders/{orderID}/refund")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-CSRF-Token"] = '<x-csrf-token>'
request["X-Operator-Reason"] = '<x-operator-reason>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"amountMinor\": 123,\n \"currency\": \"<string>\",\n \"refundId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"request_id": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"request_id": "<string>"
}panel
Post v1panelfinanceorders refund
Requires finance.write and a reason. The refund itself is executed by the payment service against the provider’s own capabilities; this records the decision and its rationale.
POST
/
v1
/
panel
/
finance
/
orders
/
{orderID}
/
refund
cURL
curl --request POST \
--url https://api.example.com/v1/panel/finance/orders/{orderID}/refund \
--header 'Content-Type: application/json' \
--header 'X-CSRF-Token: <x-csrf-token>' \
--header 'X-Operator-Reason: <x-operator-reason>' \
--data '
{
"amountMinor": 123,
"currency": "<string>",
"refundId": "<string>"
}
'import requests
url = "https://api.example.com/v1/panel/finance/orders/{orderID}/refund"
payload = {
"amountMinor": 123,
"currency": "<string>",
"refundId": "<string>"
}
headers = {
"X-CSRF-Token": "<x-csrf-token>",
"X-Operator-Reason": "<x-operator-reason>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-CSRF-Token': '<x-csrf-token>',
'X-Operator-Reason': '<x-operator-reason>',
'Content-Type': 'application/json'
},
body: JSON.stringify({amountMinor: 123, currency: '<string>', refundId: '<string>'})
};
fetch('https://api.example.com/v1/panel/finance/orders/{orderID}/refund', 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.example.com/v1/panel/finance/orders/{orderID}/refund",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'amountMinor' => 123,
'currency' => '<string>',
'refundId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-CSRF-Token: <x-csrf-token>",
"X-Operator-Reason: <x-operator-reason>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v1/panel/finance/orders/{orderID}/refund"
payload := strings.NewReader("{\n \"amountMinor\": 123,\n \"currency\": \"<string>\",\n \"refundId\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-CSRF-Token", "<x-csrf-token>")
req.Header.Add("X-Operator-Reason", "<x-operator-reason>")
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))
}HttpResponse<String> response = Unirest.post("https://api.example.com/v1/panel/finance/orders/{orderID}/refund")
.header("X-CSRF-Token", "<x-csrf-token>")
.header("X-Operator-Reason", "<x-operator-reason>")
.header("Content-Type", "application/json")
.body("{\n \"amountMinor\": 123,\n \"currency\": \"<string>\",\n \"refundId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/panel/finance/orders/{orderID}/refund")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-CSRF-Token"] = '<x-csrf-token>'
request["X-Operator-Reason"] = '<x-operator-reason>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"amountMinor\": 123,\n \"currency\": \"<string>\",\n \"refundId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"request_id": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"request_id": "<string>"
}Headers
Echoes the token from the current session. Required on every unsafe method.
Why the change is being made. Carried as a header because almost every operations mutation needs one; the API refuses a change that requires a reason and did not get one.
Required string length:
1 - 400Path Parameters
Response
Recorded