Skip to main content
GET
List refunds

Authorizations

Authorization
string
header
required

Bearer authentication: send your API key, agent key, or OAuth access token as Authorization: Bearer <credential>.

Headers

X-Instance-ID
string | null

Caller-chosen identifier for the agent run, session, or conversation, required when an agent moves money.

Maximum string length: 1024

Query Parameters

customerPartyId
string

Customer party to act for (pty_*). Omit for your own account. Requires authorization from that customer.

Pattern: ^pty_[0-9a-f]{32}$
paymentIntentId
string

Only refunds of this payment intent.

Pattern: ^pmi_[0-9a-f]{32}$
cardPaymentId
string

Only refunds of this card payment. If paymentIntentId is also supplied, both filters must match.

Pattern: ^cpy_[0-9a-f]{32}$
limit
integer
default:50

Maximum results per page.

Required range: 1 <= x <= 100
cursor
string

Cursor from the previous page.

Maximum string length: 1024

Response

Successful Response

data
RefundResource · object[]
required
meta
object
required