FrameSDK/com.framepayments.framesdk.refunds/RefundEndpoints

RefundEndpoints

sealed class RefundEndpoints : FrameNetworkingEndpoints

Defines the API endpoints available for refund operations.

Each case maps to a specific URL path and HTTP method used by FrameNetworking.

Inheritors

Types

object CreateRefund : RefundEndpoints

Endpoint for creating a new refund via POST to /v1/refunds.

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.

data class GetRefundWith(val refundId: String) : RefundEndpoints

Endpoint for retrieving a single refund via GET to /v1/refunds/{refundId}.

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.

open override val endpointURL: String

The fully qualified URL string for this endpoint.

open override val httpMethod: String

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

open override val queryItems: List<QueryItem>?

Optional query-string parameters appended to endpointURL.