List Refunds

Required scope: payment:read

Lists refunds for the workspace. Optionally restrict to one customerId, one paymentId, or one status. pageSize is capped at 100. Amounts are integer minor currency units.

Generated Reference

POST /public-api/publicapi.v1.Payment/ListRefunds

Lists refunds visible to the API key actor with bounded pagination.

Request ListRefundsRequest

Response ListRefundsResponse

ListRefundsRequest

Field	Type	Description
customer_id	optional string	Restrict to refunds for one customer.
payment_id	optional string	Restrict to refunds for one payment.
status	RefundStatus	Restrict to refunds in one status.
page	int32	Zero-based page index.
page_size	int32	Page size, capped server-side.

ListRefundsResponse

Field	Type	Description
refunds	repeated Refund	Refunds on the requested page.
total	int32	Total refunds matching the filters.
page	int32	Zero-based page index returned.
page_size	int32	Page size returned.

Related Types

Refund

Field	Type	Description
id	string	Stable refund identifier.
payment_id	optional string	Payment the refund was issued against, when linked.
customer_id	string	Customer the refund belongs to.
status	RefundStatus	Refund lifecycle status.
amount_minor	int64	Requested refund amount in minor currency units.
amount_refunded_minor	int64	Amount actually refunded in minor currency units.
currency	string	ISO 4217 currency code.
reason	optional string	Refund reason, when provided.
refunded_at	optional int64	Time the refund completed as unix seconds, when completed.
created_at	int64	Creation time as unix seconds.
updated_at	int64	Last update time as unix seconds.

Request

{
  "customerId": "<customer-id>",
  "status": "PUBLIC_REFUND_STATUS_COMPLETED",
  "page": 0,
  "pageSize": 50
}

Omit the filters to list all refunds the API key can read.

Response

{
  "refunds": [
    {
      "id": "<refund-id>",
      "paymentId": "<payment-id>",
      "customerId": "<customer-id>",
      "status": "PUBLIC_REFUND_STATUS_COMPLETED",
      "amountMinor": "12500",
      "amountRefundedMinor": "12500",
      "currency": "EUR",
      "createdAt": "1737936000",
      "updatedAt": "1737939600"
    }
  ],
  "total": 1,
  "page": 0,
  "pageSize": 50
}