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 /v1/platform/businesses/{business_id}/vendor-refunds/payments/{vendor_refund_payment_id}

Update vendor refund payment

cURL

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>"
}
'

200

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

Authorizations

BusinessScopedJWTPartnerJWTBasicAuthBearerUnscopedBearerBusinessScoped

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

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

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

200

application/json

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 · required

Payment information

Show child attributes

allocations · object[] · required

List of allocations created

Show child attributes