Skip to main content
GET
List invoice payments

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

customer_id
string

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

date_from
string<date-time>

Filter payments from this date/time (ISO format)

date_to
string<date-time>

Filter payments to this date/time (ISO format)

fully_allocated
boolean

Filter by allocation status (true=fully allocated, false=partially/unallocated)

invoice_id
string<uuid>

Filter by invoice ID (payments allocated to this invoice)

max_amount
integer

Maximum payment amount in cents (e.g., 100000 for €1000.00)

method
string

Filter by payment method

min_amount
integer

Minimum payment amount in cents (e.g., 10050 for €100.50)

order
string

Sort order (asc, desc). Default: desc

page
integer

Page number (default: 1)

page_size
integer

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

processor
string

Filter by payment processor

Search by payment reference, external_id, processor_reference, bank_reference, customer name, or notes

sort
string

Sort field (payment_date, amount, created_at). Default: payment_date

status
string

Filter by payment status (pending, processing, completed, failed, cancelled, refunded)

Response

200 - application/json
count
integer
required

Total number of items

Example:

123

page_info
object
required
Example:
results
object[]
required