FrameSDK/com.framepayments.framesdk.refunds/RefundEndpoints/GetRefunds

GetRefunds

data class GetRefunds(val chargeId: String?, val chargeIntentId: String?, val perPage: Int?, val page: Int?) : RefundEndpoints

Endpoint for retrieving a paginated list of refunds via GET to /v1/refunds.

Constructors

Link copied to clipboard
constructor(chargeId: String?, chargeIntentId: String?, perPage: Int?, page: Int?)

Properties

Link copied to clipboard
open val additionalHeaders: Map<String, String>

Optional extra HTTP headers to attach to the request (e.g. Accept: application/json). Defaults to empty. Applied after the standard Frame Authorization/User-Agent headers but before Content-Type (set on POST/PATCH), so an entry may override the former but not the latter. Prefer supplemental headers like Accept; don't rely on this to set auth headers.

Link copied to clipboard
val chargeId: String?

Optional charge ID to filter results.

Link copied to clipboard
val chargeIntentId: String?

Optional charge intent ID to filter results.

Link copied to clipboard
open override val endpointURL: String

The fully qualified URL string for this endpoint.

Link copied to clipboard
open override val httpMethod: String

HTTP method, e.g. "GET", "POST", "DELETE".

Link copied to clipboard
val page: Int?

Optional page number to retrieve.

Link copied to clipboard
val perPage: Int?

Optional number of results per page.

Link copied to clipboard
open override val queryItems: List<QueryItem>?

Optional query-string parameters appended to endpointURL.