List vendor refund payments

List all vendor refund payments for a business with filtering and pagination.

Features:

• Filter by status (pending, processing, completed, failed, cancelled)
• Filter by payment method
• Filter by date range
• Search by payment reference
• Pagination support (default: 20 per page, max: 100)

Use Cases:

• View all pending payments requiring processing
• Monitor payment status across all refunds
• Generate payment reports
• Reconciliation dashboard

Available Filters:

• status: Filter by payment status
• payment_method: Filter by payment method (bank_transfer, check, etc.)
• refund_id: Filter by specific vendor refund UUID
• payment_date_start / payment_date_end: Filter by date range
• search: Search by payment_reference

GET /v1/platform/businesses/{business_id}/vendor-refunds/payments

List vendor refund payments

cURL

curl --request GET \
  --url https://sandbox.thredfi.com/v1/platform/businesses/{business_id}/vendor-refunds/payments/ \
  --header 'Authorization: Bearer <token>'

200

{
  "count": 123,
  "page_info": {
    "total_count": 123,
    "current_page": 1,
    "total_pages": 7,
    "page_size": 20
  },
  "results": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "refund_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "vendor_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "vendor_name": "<string>",
      "payment_reference": "<string>",
      "payment_method": "<string>",
      "processor": "<string>",
      "refunded_amount_cents": 123,
      "processing_fee_cents": 123,
      "net_amount_cents": 123,
      "currency": "<string>",
      "status": "<string>",
      "payment_date": "2023-12-25",
      "submitted_at": "2023-11-07T05:31:56Z",
      "completed_at": "2023-11-07T05:31:56Z",
      "failed_at": "2023-11-07T05:31:56Z",
      "failure_reason": "<string>",
      "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"
    }
  ]
}

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

Query Parameters

page · integer

A page number within the paginated result set.

page_size · integer

Number of results to return per page.

payment_date_end · string<date>

Filter payments to this date (YYYY-MM-DD)

payment_date_start · string<date>

Filter payments from this date (YYYY-MM-DD)

payment_method · string

Filter by payment method

refund_id · string<uuid>

Filter by vendor refund UUID

search · string

Search by payment reference

status · string

Filter by payment status

Response

200

application/json

count · integer · required

Total number of items

Example:

123

page_info · object · required

Show child attributes

Example:

{
  "total_count": 123,
  "current_page": 1,
  "total_pages": 7,
  "page_size": 20
}

results · object[] · required

Show child attributes