Skip to main content
GET
/
v1
/
platform
/
businesses
/
{business_id}
/
invoices
/
refunds
List refunds
curl --request GET \
  --url https://sandbox.thredfi.com/v1/platform/businesses/{business_id}/invoices/refunds/ \
  --header 'Authorization: Bearer <token>'
{
  "count": 123,
  "page_info": {
    "total_count": 123,
    "current_page": 1,
    "total_pages": 7,
    "page_size": 20
  },
  "results": [
    {
      "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)

Query Parameters

​
completed_at_end
string<date-time>

Filter refunds completed at or before this timestamp

​
completed_at_start
string<date-time>

Filter refunds completed at or after this timestamp

​
customer_external_id
string

Filter by customer external ID

​
customer_id
string

Filter by customer ID (supports comma-separated UUIDs for multiple customers)

​
external_id
string

Filter by external id

​
is_dedicated
boolean

Filter by dedicated flag

​
max_amount
integer

Maximum refunded amount in cents

​
min_amount
integer

Minimum refunded amount in cents

​
ordering
string

Ordering fields, e.g. -completed_at,-created_at

​
page
integer

Page number (default: 1)

​
page_size
integer

Items per page (default: 20, max: 100)

​
reference_numbers
string

Comma-separated list of reference numbers

​
search
string

Search in external_id, reference_number, memo, customer name

​
status
string

Comma-separated statuses (pending,processing,paid,failed,cancelled)

Response

​
count
integer
required

Total number of items

Example:

123

​
page_info
object
required
Example:
{
  "total_count": 123,
  "current_page": 1,
  "total_pages": 7,
  "page_size": 20
}
​
results
object[]
required