Create a refund
curl --request POST \
--url https://api.getivy.de/api/service/refund/create \
--header 'Content-Type: application/json' \
--header 'X-Ivy-Api-Key: <api-key>' \
--data '
{
"orderId": "<string>",
"referenceId": "<string>",
"bankStatementReference": "<string>",
"amount": 123
}
'import requests
url = "https://api.getivy.de/api/service/refund/create"
payload = {
"orderId": "<string>",
"referenceId": "<string>",
"bankStatementReference": "<string>",
"amount": 123
}
headers = {
"X-Ivy-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Ivy-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
orderId: '<string>',
referenceId: '<string>',
bankStatementReference: '<string>',
amount: 123
})
};
fetch('https://api.getivy.de/api/service/refund/create', 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.getivy.de/api/service/refund/create",
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([
'orderId' => '<string>',
'referenceId' => '<string>',
'bankStatementReference' => '<string>',
'amount' => 123
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Ivy-Api-Key: <api-key>"
],
]);
$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.getivy.de/api/service/refund/create"
payload := strings.NewReader("{\n \"orderId\": \"<string>\",\n \"referenceId\": \"<string>\",\n \"bankStatementReference\": \"<string>\",\n \"amount\": 123\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Ivy-Api-Key", "<api-key>")
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.getivy.de/api/service/refund/create")
.header("X-Ivy-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"orderId\": \"<string>\",\n \"referenceId\": \"<string>\",\n \"bankStatementReference\": \"<string>\",\n \"amount\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getivy.de/api/service/refund/create")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Ivy-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"orderId\": \"<string>\",\n \"referenceId\": \"<string>\",\n \"bankStatementReference\": \"<string>\",\n \"amount\": 123\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"amount": 1,
"currency": "EUR",
"status": "initiated",
"orderId": "<string>",
"transactionId": "<string>"
}Refund
Create a refund
Creates a refund for the specified order. The order can be specified either by Ivy’s internal orderId or by the referenceId provided by the merchant during checkout creation. If the refund should only be partial, you can specifiy this with the amount parameter.
POST
/
api
/
service
/
refund
/
create
Create a refund
curl --request POST \
--url https://api.getivy.de/api/service/refund/create \
--header 'Content-Type: application/json' \
--header 'X-Ivy-Api-Key: <api-key>' \
--data '
{
"orderId": "<string>",
"referenceId": "<string>",
"bankStatementReference": "<string>",
"amount": 123
}
'import requests
url = "https://api.getivy.de/api/service/refund/create"
payload = {
"orderId": "<string>",
"referenceId": "<string>",
"bankStatementReference": "<string>",
"amount": 123
}
headers = {
"X-Ivy-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Ivy-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
orderId: '<string>',
referenceId: '<string>',
bankStatementReference: '<string>',
amount: 123
})
};
fetch('https://api.getivy.de/api/service/refund/create', 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.getivy.de/api/service/refund/create",
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([
'orderId' => '<string>',
'referenceId' => '<string>',
'bankStatementReference' => '<string>',
'amount' => 123
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Ivy-Api-Key: <api-key>"
],
]);
$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.getivy.de/api/service/refund/create"
payload := strings.NewReader("{\n \"orderId\": \"<string>\",\n \"referenceId\": \"<string>\",\n \"bankStatementReference\": \"<string>\",\n \"amount\": 123\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Ivy-Api-Key", "<api-key>")
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.getivy.de/api/service/refund/create")
.header("X-Ivy-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"orderId\": \"<string>\",\n \"referenceId\": \"<string>\",\n \"bankStatementReference\": \"<string>\",\n \"amount\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getivy.de/api/service/refund/create")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Ivy-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"orderId\": \"<string>\",\n \"referenceId\": \"<string>\",\n \"bankStatementReference\": \"<string>\",\n \"amount\": 123\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"amount": 1,
"currency": "EUR",
"status": "initiated",
"orderId": "<string>",
"transactionId": "<string>"
}Headers
Body
application/json
Response
200 - application/json
Creates a refund and returns the details of created refund
Was this page helpful?