Refunds
Mark an order refund paid
Marks a pending manual refund paid once the store has handed the money back, for example cash returned at the counter. The refund becomes success, with the reference and method given, and the order’s payment status is updated (refunded once its refunds cover what was paid). Returns the refund. Fails with a 400 for a refund that isn’t manual, one no longer owed (failed or forfeited), or a payment_method that isn’t one of the store’s; with a 404 for an unknown order or refund; and with a 409, changing nothing, when it is already paid or payment records are briefly being updated.
POST
/
orders
/
{order_number}
/
refunds
/
{request_number}
/
mark-paid
Mark an order refund paid
curl --request POST \
--url https://staging.api.commercengine.io/api/v1/{store_id}/admin/orders/{order_number}/refunds/{request_number}/mark-paid \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"payment_reference_number": "<string>",
"payment_method": "<string>",
"remarks": "<string>"
}
'import requests
url = "https://staging.api.commercengine.io/api/v1/{store_id}/admin/orders/{order_number}/refunds/{request_number}/mark-paid"
payload = {
"payment_reference_number": "<string>",
"payment_method": "<string>",
"remarks": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
payment_reference_number: '<string>',
payment_method: '<string>',
remarks: '<string>'
})
};
fetch('https://staging.api.commercengine.io/api/v1/{store_id}/admin/orders/{order_number}/refunds/{request_number}/mark-paid', 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://staging.api.commercengine.io/api/v1/{store_id}/admin/orders/{order_number}/refunds/{request_number}/mark-paid",
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([
'payment_reference_number' => '<string>',
'payment_method' => '<string>',
'remarks' => '<string>'
]),
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;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://staging.api.commercengine.io/api/v1/{store_id}/admin/orders/{order_number}/refunds/{request_number}/mark-paid"
payload := strings.NewReader("{\n \"payment_reference_number\": \"<string>\",\n \"payment_method\": \"<string>\",\n \"remarks\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", 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))
}HttpResponse<String> response = Unirest.post("https://staging.api.commercengine.io/api/v1/{store_id}/admin/orders/{order_number}/refunds/{request_number}/mark-paid")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"payment_reference_number\": \"<string>\",\n \"payment_method\": \"<string>\",\n \"remarks\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://staging.api.commercengine.io/api/v1/{store_id}/admin/orders/{order_number}/refunds/{request_number}/mark-paid")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"payment_reference_number\": \"<string>\",\n \"payment_method\": \"<string>\",\n \"remarks\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"message": "Refund marked paid successfully.",
"success": true,
"content": {
"refund": {
"request_number": "<string>",
"status": "pending",
"payment_mode": "original-payment-mode",
"refund_amount": 123,
"payment_method": "<string>",
"payment_reference_number": "<string>",
"bank_account_number": "<string>",
"bank_name": "<string>",
"refund_remarks": "<string>",
"refund_date": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"modified_at": "2023-11-07T05:31:56Z"
}
}
}{
"message": "<string>",
"success": true,
"code": "<string>",
"errors": {},
"content": {},
"details": "<string>"
}{
"message": "<string>",
"success": true,
"code": "<string>",
"details": "<string>"
}{
"message": "<string>",
"success": true,
"code": "<string>",
"details": "<string>"
}{
"message": "The refund is already paid.",
"success": false
}{
"message": "<string>",
"success": true,
"code": "<string>",
"details": "<string>",
"error_id": "<string>"
}Authorizations
Path Parameters
Body
application/json
Was this page helpful?
⌘I
Mark an order refund paid
curl --request POST \
--url https://staging.api.commercengine.io/api/v1/{store_id}/admin/orders/{order_number}/refunds/{request_number}/mark-paid \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"payment_reference_number": "<string>",
"payment_method": "<string>",
"remarks": "<string>"
}
'import requests
url = "https://staging.api.commercengine.io/api/v1/{store_id}/admin/orders/{order_number}/refunds/{request_number}/mark-paid"
payload = {
"payment_reference_number": "<string>",
"payment_method": "<string>",
"remarks": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
payment_reference_number: '<string>',
payment_method: '<string>',
remarks: '<string>'
})
};
fetch('https://staging.api.commercengine.io/api/v1/{store_id}/admin/orders/{order_number}/refunds/{request_number}/mark-paid', 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://staging.api.commercengine.io/api/v1/{store_id}/admin/orders/{order_number}/refunds/{request_number}/mark-paid",
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([
'payment_reference_number' => '<string>',
'payment_method' => '<string>',
'remarks' => '<string>'
]),
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;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://staging.api.commercengine.io/api/v1/{store_id}/admin/orders/{order_number}/refunds/{request_number}/mark-paid"
payload := strings.NewReader("{\n \"payment_reference_number\": \"<string>\",\n \"payment_method\": \"<string>\",\n \"remarks\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", 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))
}HttpResponse<String> response = Unirest.post("https://staging.api.commercengine.io/api/v1/{store_id}/admin/orders/{order_number}/refunds/{request_number}/mark-paid")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"payment_reference_number\": \"<string>\",\n \"payment_method\": \"<string>\",\n \"remarks\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://staging.api.commercengine.io/api/v1/{store_id}/admin/orders/{order_number}/refunds/{request_number}/mark-paid")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"payment_reference_number\": \"<string>\",\n \"payment_method\": \"<string>\",\n \"remarks\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"message": "Refund marked paid successfully.",
"success": true,
"content": {
"refund": {
"request_number": "<string>",
"status": "pending",
"payment_mode": "original-payment-mode",
"refund_amount": 123,
"payment_method": "<string>",
"payment_reference_number": "<string>",
"bank_account_number": "<string>",
"bank_name": "<string>",
"refund_remarks": "<string>",
"refund_date": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"modified_at": "2023-11-07T05:31:56Z"
}
}
}{
"message": "<string>",
"success": true,
"code": "<string>",
"errors": {},
"content": {},
"details": "<string>"
}{
"message": "<string>",
"success": true,
"code": "<string>",
"details": "<string>"
}{
"message": "<string>",
"success": true,
"code": "<string>",
"details": "<string>"
}{
"message": "The refund is already paid.",
"success": false
}{
"message": "<string>",
"success": true,
"code": "<string>",
"details": "<string>",
"error_id": "<string>"
}