Refund a return
curl --request POST \
--url https://api.arcuserp.com/v1/returns/{id}/refund \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"amount": 123,
"payment_method": "original",
"allocations": [
{
"payment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"amount": 123,
"reason": "<string>"
}
],
"reason": "<string>"
}
'import requests
url = "https://api.arcuserp.com/v1/returns/{id}/refund"
payload = {
"amount": 123,
"payment_method": "original",
"allocations": [
{
"payment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"amount": 123,
"reason": "<string>"
}
],
"reason": "<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({
amount: 123,
payment_method: 'original',
allocations: [
{
payment_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
amount: 123,
reason: '<string>'
}
],
reason: '<string>'
})
};
fetch('https://api.arcuserp.com/v1/returns/{id}/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.arcuserp.com/v1/returns/{id}/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([
'amount' => 123,
'payment_method' => 'original',
'allocations' => [
[
'payment_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'amount' => 123,
'reason' => '<string>'
]
],
'reason' => '<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://api.arcuserp.com/v1/returns/{id}/refund"
payload := strings.NewReader("{\n \"amount\": 123,\n \"payment_method\": \"original\",\n \"allocations\": [\n {\n \"payment_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"amount\": 123,\n \"reason\": \"<string>\"\n }\n ],\n \"reason\": \"<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://api.arcuserp.com/v1/returns/{id}/refund")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": 123,\n \"payment_method\": \"original\",\n \"allocations\": [\n {\n \"payment_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"amount\": 123,\n \"reason\": \"<string>\"\n }\n ],\n \"reason\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.arcuserp.com/v1/returns/{id}/refund")
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 \"amount\": 123,\n \"payment_method\": \"original\",\n \"allocations\": [\n {\n \"payment_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"amount\": 123,\n \"reason\": \"<string>\"\n }\n ],\n \"reason\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"return_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"return_number": "<string>",
"amount": 123,
"payment_method_type": "<string>",
"order_refund_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"credit_memo_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"batch_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"allocations": [
{
"payment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"source_method": "<string>",
"amount": 123,
"order_refund_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"refund_payment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"status": "succeeded",
"idempotent": true
}
}{
"error": "not_found",
"code": "not_found",
"type": "not_found",
"hint": "The requested order does not exist or does not belong to this entity.",
"param": "expand[0]",
"required": "accounts:read",
"request_id": "req_abc123"
}{
"error": "not_found",
"code": "not_found",
"type": "not_found",
"hint": "The requested order does not exist or does not belong to this entity.",
"param": "expand[0]",
"required": "accounts:read",
"request_id": "req_abc123"
}{
"error": "not_found",
"code": "not_found",
"type": "not_found",
"hint": "The requested order does not exist or does not belong to this entity.",
"param": "expand[0]",
"required": "accounts:read",
"request_id": "req_abc123"
}{
"error": "not_found",
"code": "not_found",
"type": "not_found",
"hint": "The requested order does not exist or does not belong to this entity.",
"param": "expand[0]",
"required": "accounts:read",
"request_id": "req_abc123"
}{
"error": "not_found",
"code": "not_found",
"type": "not_found",
"hint": "The requested order does not exist or does not belong to this entity.",
"param": "expand[0]",
"required": "accounts:read",
"request_id": "req_abc123",
"meta": {
"refund_hold": {
"return_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"return_number": "<string>",
"note_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"held_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"held_by_name": "<string>",
"held_at": "2023-11-07T05:31:56Z",
"question": "<string>"
}
}
}{
"error": "not_found",
"code": "not_found",
"type": "not_found",
"hint": "The requested order does not exist or does not belong to this entity.",
"param": "expand[0]",
"required": "accounts:read",
"request_id": "req_abc123"
}Returns
Refund a return
Issues a refund against a received, inspected, restocked, written-off, sent-to-vendor, or closed return, optionally split across multiple original payment sources via allocations[]. Requires returns:write and payments:write scopes plus the payments.refund_void permission; calling it again with the same amount on the same return returns the cached result, and a different amount returns 409. A return whose refund accounting has put on hold with a question for the office is refused with 409 refund_on_hold until the office answers; nothing is refunded and no amount owed changes while it is held.
POST
/
returns
/
{id}
/
refund
Refund a return
curl --request POST \
--url https://api.arcuserp.com/v1/returns/{id}/refund \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"amount": 123,
"payment_method": "original",
"allocations": [
{
"payment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"amount": 123,
"reason": "<string>"
}
],
"reason": "<string>"
}
'import requests
url = "https://api.arcuserp.com/v1/returns/{id}/refund"
payload = {
"amount": 123,
"payment_method": "original",
"allocations": [
{
"payment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"amount": 123,
"reason": "<string>"
}
],
"reason": "<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({
amount: 123,
payment_method: 'original',
allocations: [
{
payment_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
amount: 123,
reason: '<string>'
}
],
reason: '<string>'
})
};
fetch('https://api.arcuserp.com/v1/returns/{id}/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.arcuserp.com/v1/returns/{id}/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([
'amount' => 123,
'payment_method' => 'original',
'allocations' => [
[
'payment_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'amount' => 123,
'reason' => '<string>'
]
],
'reason' => '<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://api.arcuserp.com/v1/returns/{id}/refund"
payload := strings.NewReader("{\n \"amount\": 123,\n \"payment_method\": \"original\",\n \"allocations\": [\n {\n \"payment_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"amount\": 123,\n \"reason\": \"<string>\"\n }\n ],\n \"reason\": \"<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://api.arcuserp.com/v1/returns/{id}/refund")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": 123,\n \"payment_method\": \"original\",\n \"allocations\": [\n {\n \"payment_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"amount\": 123,\n \"reason\": \"<string>\"\n }\n ],\n \"reason\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.arcuserp.com/v1/returns/{id}/refund")
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 \"amount\": 123,\n \"payment_method\": \"original\",\n \"allocations\": [\n {\n \"payment_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"amount\": 123,\n \"reason\": \"<string>\"\n }\n ],\n \"reason\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"return_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"return_number": "<string>",
"amount": 123,
"payment_method_type": "<string>",
"order_refund_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"credit_memo_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"batch_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"allocations": [
{
"payment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"source_method": "<string>",
"amount": 123,
"order_refund_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"refund_payment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"status": "succeeded",
"idempotent": true
}
}{
"error": "not_found",
"code": "not_found",
"type": "not_found",
"hint": "The requested order does not exist or does not belong to this entity.",
"param": "expand[0]",
"required": "accounts:read",
"request_id": "req_abc123"
}{
"error": "not_found",
"code": "not_found",
"type": "not_found",
"hint": "The requested order does not exist or does not belong to this entity.",
"param": "expand[0]",
"required": "accounts:read",
"request_id": "req_abc123"
}{
"error": "not_found",
"code": "not_found",
"type": "not_found",
"hint": "The requested order does not exist or does not belong to this entity.",
"param": "expand[0]",
"required": "accounts:read",
"request_id": "req_abc123"
}{
"error": "not_found",
"code": "not_found",
"type": "not_found",
"hint": "The requested order does not exist or does not belong to this entity.",
"param": "expand[0]",
"required": "accounts:read",
"request_id": "req_abc123"
}{
"error": "not_found",
"code": "not_found",
"type": "not_found",
"hint": "The requested order does not exist or does not belong to this entity.",
"param": "expand[0]",
"required": "accounts:read",
"request_id": "req_abc123",
"meta": {
"refund_hold": {
"return_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"return_number": "<string>",
"note_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"held_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"held_by_name": "<string>",
"held_at": "2023-11-07T05:31:56Z",
"question": "<string>"
}
}
}{
"error": "not_found",
"code": "not_found",
"type": "not_found",
"hint": "The requested order does not exist or does not belong to this entity.",
"param": "expand[0]",
"required": "accounts:read",
"request_id": "req_abc123"
}Authorizations
API key issued per entity via Settings > Developers > API Keys.
Each key carries scopes (e.g. orders:read, products:write).
Bearer token format: Authorization: Bearer ark_live_ent_Test keys use ark_test_ent_. Both are issued per entity
via Settings > Developers > API Keys.
Headers
Client-generated unique key for idempotent POST/PATCH/DELETE operations. Alias for the Idempotency parameter. Max 255 chars. On retry with the same key, the original response is returned without re-executing the operation. Keys expire after 24 hours.
Maximum string length:
255Path Parameters
Body
application/json
Refund amount. Defaults to sum of return_items.refund_amount. When allocations[] is supplied, must equal SUM(allocations[].amount).
Single-source path only. Ignored when allocations[] is supplied.
Available options:
original, store_credit, check, cash Multi-source refund split. When present, the refund is executed per-payment across these order_payments rows (operator-picks). SUM(allocations[].amount) must equal the total refund within 1 cent.
Show child attributes
Show child attributes
Response
Refund issued
Show child attributes
Show child attributes
Was this page helpful?