Issue an explicit refund against an RMA

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"
      }
    ],
    "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"
}

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

Issue an explicit refund against an RMA

Authorization: requires returns:write + payments:write API-key scopes AND the per-user payments.refund_void permission (SoD parity sweep 2026-05-16; refunds are highest-trust AICPA SoD action). System-actor calls denied.

Phase A canonical: refundReturn() extracted from postReturnFinancialSettlement. Routes by payment_method:

original/check/cash: calls processRefund (Stripe + GL via postRefundEntry)
store_credit: calls issueCreditMemo (DR sales_returns_allowances / CR customer_credits)

Multi-source refund (allocations[]): when the invoice was paid via 2+ payment sources, pass allocations: [{ payment_id, amount, reason? }, ...] to split the refund across those sources (operator-picks, industry standard per Stripe + NetSuite — no auto-routing). Each payment_id must be an order_payments.id on the RMA’s original order and SUM(allocations[].amount) must equal the total refund (within 1 cent). Every allocation refunds inside ONE transaction under one GL batch_id; a failure on any allocation rolls back the whole refund. Card-source allocations do NOT refund the original processing fee (non-recoverable).

State guard: must be received, inspecting, restocked, written_off, sent_to_vendor, or closed. Idempotency: same amount on same RMA returns cached result; different amount returns 409. Rule 23 SSOT: returns.refund_amount written only by this endpoint. Compound scope required: returns:write AND payments:write.

POST

returns

{id}

refund

Issue an explicit refund against an RMA

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"
      }
    ],
    "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"
}

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

Authorization

string

header

required

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

Idempotency-Key

string

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: 255

Path Parameters

string<uuid>

required

Body

application/json

amount

number<float>

Refund amount. Defaults to sum of return_items.refund_amount. When allocations[] is supplied, must equal SUM(allocations[].amount).

payment_method

enum<string>

default:original

Single-source path only. Ignored when allocations[] is supplied.

Available options:

original,

store_credit,

check,

cash

allocations

object[]

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

reason

string

Response

Refund issued

data

object

Show child attributes

Overview

All Endpoints

Issue an explicit refund against an RMA

Authorizations

Headers

Path Parameters

Body

Response