FrameSDK/com.framepayments.framesdk.chargeintents/ChargeIntentEndpoints

ChargeIntentEndpoints

sealed class ChargeIntentEndpoints : FrameNetworkingEndpoints

Defines every API endpoint used to manage charge intents.

Each case carries the data required to build its URL, HTTP method, and query parameters. Implement FrameNetworkingEndpoints so the networking layer can dispatch requests uniformly.

Inheritors

VoidRemainingChargeIntent

Types

CancelChargeIntent

data class CancelChargeIntent(val intentId: String) : ChargeIntentEndpoints

Cancels a charge intent before it is captured (POST /v1/charge_intents/{intentId}/cancel).

CaptureChargeIntent

data class CaptureChargeIntent(val intentId: String) : ChargeIntentEndpoints

Captures an authorized charge intent (POST /v1/charge_intents/{intentId}/capture).

ConfirmChargeIntent

data class ConfirmChargeIntent(val intentId: String) : ChargeIntentEndpoints

Confirms a charge intent, triggering payment processing (POST /v1/charge_intents/{intentId}/confirm).

CreateChargeIntent

object CreateChargeIntent : ChargeIntentEndpoints

Creates a new charge intent (POST /v1/charge_intents).

GetAllChargeIntents

data class GetAllChargeIntents(val perPage: Int?, val page: Int?) : ChargeIntentEndpoints

Retrieves a paginated list of all charge intents (GET /v1/charge_intents).

GetChargeIntent

data class GetChargeIntent(val intentId: String) : ChargeIntentEndpoints

Retrieves a single charge intent by ID (GET /v1/charge_intents/{intentId}).

UpdateChargeIntent

data class UpdateChargeIntent(val intentId: String) : ChargeIntentEndpoints

Updates an existing charge intent (PATCH /v1/charge_intents/{intentId}).

VoidRemainingChargeIntent

data class VoidRemainingChargeIntent(val intentId: String) : ChargeIntentEndpoints

Voids the uncaptured remainder of a partially captured charge intent (POST /v1/charge_intents/{intentId}/void_remaining).

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

Returns the relative URL path for this endpoint.

httpMethod

open override val httpMethod: String

Returns the HTTP method string for this endpoint.

queryItems

open override val queryItems: List<QueryItem>?

Returns the URL query parameters for this endpoint, or null if none apply.