FrameSDK/com.framepayments.framesdk.disputes/DisputeEndpoints

DisputeEndpoints

sealed class DisputeEndpoints : FrameNetworkingEndpoints

Defines the API endpoints available for dispute operations.

Each case maps to a specific Frame API route and HTTP method. Callers construct the appropriate case and pass it to the networking layer to execute the request.

Inheritors

UpdateDispute

GetDispute

GetDisputes

Types

GetDispute

data class GetDispute(val disputeId: String) : DisputeEndpoints

Endpoint for retrieving a single dispute by its identifier.

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.

UpdateDispute

data class UpdateDispute(val disputeId: String) : DisputeEndpoints

Endpoint for updating an existing dispute with new evidence.

Properties

additionalHeaders

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.

endpointURL

open override val endpointURL: String

The relative URL path for this endpoint.

httpMethod

open override val httpMethod: String

The HTTP method used for this endpoint.

queryItems

open override val queryItems: List<QueryItem>?

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