FrameSDK/com.framepayments.framesdk.chargeintents/ChargeIntentEndpoints/VoidRemainingChargeIntent

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).

Constructors

constructor(intentId: String)

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.

intentId

val intentId: String

The ID of the charge intent whose remaining authorized amount should be voided.

queryItems

open override val queryItems: List<QueryItem>?

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