THthredfi
Refunds

Create refund (full or partial)

Create a simple refund for an invoice. Provide partial_amount to create a partial refund.

post/v1/platform/businesses/{business_id}/invoices/refunds/

Request

  • Base URL
    https://docs.thredfi.com (the document declares no server; this is the origin it was published from)
  • Auth
    • HTTP bearer
    • or HTTP bearer
    • or HTTP basic
    • or HTTP bearer
    • or HTTP bearer

Path parameters

business_idstring uuid required

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

Request body

invoice_idstring uuid required

Invoice to refund

method'CASH' | 'CHECK' | 'CREDIT_CARD' | 'DEBIT_CARD' | 'ACH' | 'BANK_TRANSFER' | 'PAYPAL' | 'STRIPE' | 'OTHER' required

Payment method for the refund

  • CASH - Cash
  • CHECK - Check
  • CREDIT_CARD - Credit Card
  • DEBIT_CARD - Debit Card
  • ACH - ACH
  • BANK_TRANSFER - Bank Transfer
  • PAYPAL - PayPal
  • STRIPE - Stripe
  • OTHER - Other
completed_atstring date-time required

When the refund was completed

amount_centsinteger

Optional: Partial refund amount in cents. If not provided, refunds full amount.

external_idstring required

Required external identifier for idempotency (unique per business)

memostring

Optional description

reference_numberstring

Optional reference number

processorstring

Payment processor (e.g., STRIPE)

refund_processing_fee_centsinteger

Processing fee for the refund in cents

Response

idstring uuid required

Unique refund identifier

external_idstring

Your unique identifier for this refund (used for idempotency)

refunded_amountinteger required

Total refunded amount in cents

status'pending' | 'processing' | 'paid' | 'failed' | 'cancelled'

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

  • pending - Pending
  • processing - Processing
  • paid - Paid
  • failed - Failed
  • cancelled - Cancelled
completed_atstring date-time nullable

Timestamp when refund was fully paid

is_dedicatedboolean

Whether this is a dedicated refund (true/false)

memostring

Description or reason for the refund

reference_numberstring

Reference number for tracking

metadataunknown
customer_idstring uuid required

UUID of the customer receiving the refund

customer_namestring required

Customer display name

currency'EUR' | 'GBP' | 'USD' | 'SEK' | 'NOK' | 'DKK' | 'ISK' | 'MYR' | 'SGD'

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
created_atstring date-time required

Refund creation timestamp

updated_atstring date-time required

Last update timestamp

Changes

No recorded changes to this operation across all 1 revision of this API.