Skip to main content
GET
Get refund

Authorizations

Authorization
string
header
required

Partner-level JWT token (unscoped). Token payload includes partner_id. Business access is validated via partner ownership. Format: Bearer <your-jwt-token>

Use this for: Multi-business operations where the business_id is specified in the URL and partner has access to multiple businesses.

Path Parameters

business_id
string<uuid>
required

Business UUID provided by Thred (unique identifier for the business)

refund_id
string<uuid>
required

A UUID string identifying this refund.

Response

Serializer for refunds (simple response). All amounts in cents.

id
string<uuid>
required
read-only

Unique refund identifier

refunded_amount
integer
required
read-only

Total refunded amount in cents

customer_id
string<uuid>
required
read-only

UUID of the customer receiving the refund

customer_name
string
required
read-only

Customer display name

allocations
object[]
required
read-only
refund_payments
object[]
required
read-only
document
object
required

Latest document linked to this refund

created_at
string<date-time>
required
read-only

Refund creation timestamp

updated_at
string<date-time>
required
read-only

Last update timestamp

external_id
string

Your unique identifier for this refund (used for idempotency)

Maximum string length: 255
status
enum<string>

Refund status (pending, processing, paid, failed, cancelled)

  • pending - Pending
  • processing - Processing
  • paid - Paid
  • failed - Failed
  • cancelled - Cancelled
Available options:
pending,
processing,
paid,
failed,
cancelled
completed_at
string<date-time> | null

Timestamp when refund was fully paid

is_dedicated
boolean

Whether this is a dedicated refund (true/false)

memo
string

Description or reason for the refund

reference_number
string

Reference number for tracking

Maximum string length: 100
metadata
any

Custom key-value pairs for additional context

currency
enum<string>

Three-letter ISO 4217 currency code (EUR, GBP, USD)

  • EUR - Euro
  • GBP - British Pound
  • USD - US Dollar
  • SEK - Swedish Krona
  • NOK - Norwegian Krone
  • DKK - Danish Krone
  • ISK - Icelandic Króna
  • MYR - Malaysian Ringgit
  • SGD - Singapore Dollar
Available options:
EUR,
GBP,
USD,
SEK,
NOK,
DKK,
ISK,
MYR,
SGD