Skip to main content
PATCH
/
v1
/
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 '
{
  "status": "pending",
  "failure_reason": "<string>",
  "payment_reference": "<string>",
  "memo": "<string>",
  "metadata": "<unknown>"
}
'
{
  "refund": {},
  "payment": {},
  "allocations": [
    {}
  ]
}

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

​
payment
object
required

Payment information

​
allocations
object[]
required

List of allocations created