Update vendor refund payment

curl --request PATCH \
  --url https://sandbox.thredfi.com/v1/platform/businesses/{business_id}/vendor-refunds/payments/{vendor_refund_payment_id}/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "failure_reason": "<string>",
  "payment_reference": "<string>",
  "memo": "<string>",
  "metadata": "<unknown>"
}
'

import requests

url = "https://sandbox.thredfi.com/v1/platform/businesses/{business_id}/vendor-refunds/payments/{vendor_refund_payment_id}/"

payload = {
    "failure_reason": "<string>",
    "payment_reference": "<string>",
    "memo": "<string>",
    "metadata": "<unknown>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    failure_reason: '<string>',
    payment_reference: '<string>',
    memo: '<string>',
    metadata: '<unknown>'
  })
};

fetch('https://sandbox.thredfi.com/v1/platform/businesses/{business_id}/vendor-refunds/payments/{vendor_refund_payment_id}/', 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://sandbox.thredfi.com/v1/platform/businesses/{business_id}/vendor-refunds/payments/{vendor_refund_payment_id}/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'failure_reason' => '<string>',
    'payment_reference' => '<string>',
    'memo' => '<string>',
    'metadata' => '<unknown>'
  ]),
  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://sandbox.thredfi.com/v1/platform/businesses/{business_id}/vendor-refunds/payments/{vendor_refund_payment_id}/"

	payload := strings.NewReader("{\n  \"failure_reason\": \"<string>\",\n  \"payment_reference\": \"<string>\",\n  \"memo\": \"<string>\",\n  \"metadata\": \"<unknown>\"\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://sandbox.thredfi.com/v1/platform/businesses/{business_id}/vendor-refunds/payments/{vendor_refund_payment_id}/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"failure_reason\": \"<string>\",\n  \"payment_reference\": \"<string>\",\n  \"memo\": \"<string>\",\n  \"metadata\": \"<unknown>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sandbox.thredfi.com/v1/platform/businesses/{business_id}/vendor-refunds/payments/{vendor_refund_payment_id}/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"failure_reason\": \"<string>\",\n  \"payment_reference\": \"<string>\",\n  \"memo\": \"<string>\",\n  \"metadata\": \"<unknown>\"\n}"

response = http.request(request)
puts response.read_body

{
  "refund": {},
  "payment": {},
  "allocations": [
    {}
  ]
}

{
  "error_code": "<string>",
  "message": "<string>",
  "detail": {},
  "request_id": "<string>"
}

{
  "error_code": "<string>",
  "message": "<string>",
  "detail": {},
  "request_id": "<string>"
}

{
  "error_code": "<string>",
  "message": "<string>",
  "detail": {},
  "request_id": "<string>"
}

{
  "error_code": "<string>",
  "message": "<string>",
  "detail": {},
  "request_id": "<string>"
}

{
  "error_code": "<string>",
  "message": "<string>",
  "detail": {},
  "request_id": "<string>"
}

{
  "error_code": "<string>",
  "message": "<string>",
  "detail": {},
  "request_id": "<string>"
}

{
  "error_code": "<string>",
  "message": "<string>",
  "detail": {},
  "request_id": "<string>"
}

Vendor Refund Payments

Update vendor refund payment

Update an existing vendor refund payment’s status or details.

Updatable Fields:

status: Update payment status (with validation)
failure_reason: Required when status is ‘failed’
payment_reference: Update external reference
processing_fee_cents: Update processing fee

Status Transitions:

pending → processing, completed, failed, cancelled
processing → completed, failed
completed → (no transitions allowed)
failed → (no transitions allowed)
cancelled → (no transitions allowed)

PATCH

platform

businesses

{business_id}

vendor-refunds

payments

{vendor_refund_payment_id}

Update vendor refund payment

curl --request PATCH \
  --url https://sandbox.thredfi.com/v1/platform/businesses/{business_id}/vendor-refunds/payments/{vendor_refund_payment_id}/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "failure_reason": "<string>",
  "payment_reference": "<string>",
  "memo": "<string>",
  "metadata": "<unknown>"
}
'

import requests

url = "https://sandbox.thredfi.com/v1/platform/businesses/{business_id}/vendor-refunds/payments/{vendor_refund_payment_id}/"

payload = {
    "failure_reason": "<string>",
    "payment_reference": "<string>",
    "memo": "<string>",
    "metadata": "<unknown>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    failure_reason: '<string>',
    payment_reference: '<string>',
    memo: '<string>',
    metadata: '<unknown>'
  })
};

fetch('https://sandbox.thredfi.com/v1/platform/businesses/{business_id}/vendor-refunds/payments/{vendor_refund_payment_id}/', 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://sandbox.thredfi.com/v1/platform/businesses/{business_id}/vendor-refunds/payments/{vendor_refund_payment_id}/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'failure_reason' => '<string>',
    'payment_reference' => '<string>',
    'memo' => '<string>',
    'metadata' => '<unknown>'
  ]),
  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://sandbox.thredfi.com/v1/platform/businesses/{business_id}/vendor-refunds/payments/{vendor_refund_payment_id}/"

	payload := strings.NewReader("{\n  \"failure_reason\": \"<string>\",\n  \"payment_reference\": \"<string>\",\n  \"memo\": \"<string>\",\n  \"metadata\": \"<unknown>\"\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://sandbox.thredfi.com/v1/platform/businesses/{business_id}/vendor-refunds/payments/{vendor_refund_payment_id}/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"failure_reason\": \"<string>\",\n  \"payment_reference\": \"<string>\",\n  \"memo\": \"<string>\",\n  \"metadata\": \"<unknown>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sandbox.thredfi.com/v1/platform/businesses/{business_id}/vendor-refunds/payments/{vendor_refund_payment_id}/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"failure_reason\": \"<string>\",\n  \"payment_reference\": \"<string>\",\n  \"memo\": \"<string>\",\n  \"metadata\": \"<unknown>\"\n}"

response = http.request(request)
puts response.read_body

{
  "refund": {},
  "payment": {},
  "allocations": [
    {}
  ]
}

{
  "error_code": "<string>",
  "message": "<string>",
  "detail": {},
  "request_id": "<string>"
}

{
  "error_code": "<string>",
  "message": "<string>",
  "detail": {},
  "request_id": "<string>"
}

{
  "error_code": "<string>",
  "message": "<string>",
  "detail": {},
  "request_id": "<string>"
}

{
  "error_code": "<string>",
  "message": "<string>",
  "detail": {},
  "request_id": "<string>"
}

{
  "error_code": "<string>",
  "message": "<string>",
  "detail": {},
  "request_id": "<string>"
}

{
  "error_code": "<string>",
  "message": "<string>",
  "detail": {},
  "request_id": "<string>"
}

{
  "error_code": "<string>",
  "message": "<string>",
  "detail": {},
  "request_id": "<string>"
}

Authorizations

Authorization

string

header

required

Business-scoped JWT token. Token payload includes business_id to automatically scope requests. Format: Bearer <your-jwt-token>

Use this for: Business-specific operations where the business context is embedded in the token.

Path Parameters

business_id

string<uuid>

required

Business UUID

vendor_refund_payment_id

string<uuid>

required

Vendor Refund Payment UUID

Body

Serializer for updating vendor refund payment status and details.

status

enum<string>

New payment status

pending - pending
processing - processing
completed - completed
failed - failed
cancelled - cancelled

Available options:

pending,

processing,

completed,

failed,

cancelled

failure_reason

string

Reason for failure (required if status is 'failed')

payment_reference

string

Updated payment reference

Maximum string length: 100

memo

string

Updated memo

metadata

any | null

Updated metadata

Response

Serializer for vendor refund payment create/update responses.

This serializer formats the response data for successful refund payment creation operations. Renamed from VendorRefundPaymentResponseSerializer to avoid naming conflict with vendor_refund_serializers.py.

refund

object

required

Complete refund information

Show child attributes

payment

object | null

required

Payment information

Show child attributes

allocations

object[]

required

List of allocations created

Show child attributes

Managing Businesses

Importing Business Activity

Financial Reports

Update vendor refund payment

Authorizations

Path Parameters

Body

Response