Skip to main content
GET
/
v1
/
platform
/
businesses
/
{business_id}
/
invoices
/
refunds
/
{refund_id}
Get refund
curl --request GET \
  --url https://sandbox.thredfi.com/v1/platform/businesses/{business_id}/invoices/refunds/{refund_id}/ \
  --header 'Authorization: Bearer <token>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "refunded_amount": 123,
  "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "customer_name": "<string>",
  "allocations": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "allocation_type": "invoice",
      "amount": 123,
      "invoice_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "invoice_number": "<string>",
      "invoice_outstanding_balance_cents": 123,
      "target_description": "<string>",
      "description": "<string>",
      "allocation_date": "2023-11-07T05:31:56Z"
    }
  ],
  "refund_payments": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "refund_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "refunded_amount": 123,
      "refund_processing_fee": 123,
      "reconciled_bank_transactions": [
        {
          "bank_transaction_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "bank_transaction_date": "2023-11-07T05:31:56Z",
          "bank_transaction_amount_cents": 123,
          "bank_transaction_direction": "<string>",
          "reconciled_amount_cents": 123,
          "reconciliation_link_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "reconciled_at": "2023-11-07T05:31:56Z",
          "currency": "<string>",
          "payment_type": "<string>",
          "bank_account_name": "<string>",
          "notes": "<string>"
        }
      ],
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "external_id": "<string>",
      "completed_at": "2023-11-07T05:31:56Z",
      "method": "BANK_TRANSFER",
      "processor": "<string>",
      "transaction_tags": "<unknown>",
      "memo": "<string>",
      "metadata": "<unknown>"
    }
  ],
  "document": {
    "url": "<string>",
    "expires_in": 123,
    "document_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "file_name": "<string>",
    "file_size": 123,
    "mime_type": "<string>"
  },
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "external_id": "<string>",
  "status": "pending",
  "completed_at": "2023-11-07T05:31:56Z",
  "is_dedicated": true,
  "memo": "<string>",
  "reference_number": "<string>",
  "metadata": "<unknown>",
  "currency": "EUR"
}

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

Unique refund identifier

refunded_amount
integer
required

Total refunded amount in cents

customer_id
string<uuid>
required

UUID of the customer receiving the refund

customer_name
string
required

Customer display name

allocations
object[]
required
refund_payments
object[]
required
document
object
required

Latest document linked to this refund

created_at
string<date-time>
required

Refund creation timestamp

updated_at
string<date-time>
required

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