Skip to content

List Payments

Required scope: payment:read

Generated Reference

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

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

Request ListPaymentsRequest

Response ListPaymentsResponse

ListPaymentsRequest

Field	Type
`page`	`int32`
`page_size`	`int32`
`status`	`PaymentStatus`
`method`	`optional string`
`portfolio_id`	`optional string`

ListPaymentsResponse

Field	Type
`payments`	`repeated Payment`
`total`	`int32`
`page`	`int32`
`page_size`	`int32`

Related Types

Payment

Field	Type
`id`	`string`
`portfolio_id`	`string`
`transaction_id`	`optional string`
`status`	`PaymentStatus`
`amount`	`int64`
`amount_paid`	`int64`
`currency`	`string`
`method`	`string`
`checkout_url`	`optional string`
`customer_name`	`optional string`
`billing_address_line1`	`optional string`
`billing_address_line2`	`optional string`
`billing_city`	`optional string`
`billing_postal_code`	`optional string`
`billing_country`	`optional string`
`reference_number`	`optional string`
`description`	`optional string`
`due_date`	`optional int64`
`paid_at`	`optional int64`
`created_at`	`int64`
`updated_at`	`int64`
`portfolio_title`	`optional string`
`portfolio_reference_number`	`optional string`

{
  "portfolioId": "<portfolio-id>",
  "page": 1,
  "pageSize": 25
}