FrameSDK/com.framepayments.framesdk.disputes/DisputeEndpoints/GetDisputes

GetDisputes

data class GetDisputes(val chargeId: String?, val chargeIntentId: String?, val perPage: Int?, val page: Int?) : DisputeEndpoints

Endpoint for retrieving a paginated list of disputes, optionally filtered by charge or charge intent.

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 identifier of the charge to filter results by.

Link copied to clipboard
val chargeIntentId: String?

Optional identifier of the charge intent to filter results by.

Link copied to clipboard
open override val endpointURL: String

The relative URL path for this endpoint.

Link copied to clipboard
open override val httpMethod: String

The HTTP method used for this endpoint.

Link copied to clipboard
val page: Int?

The page number to retrieve.

Link copied to clipboard
val perPage: Int?

Number of disputes to return per page.

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

The query parameters appended to the request URL, or null if none apply.