FrameSDK/com.framepayments.framesdk.transfersv2/TransferV2Endpoints

TransferV2Endpoints

sealed class TransferV2Endpoints : FrameNetworkingEndpoints

Defines the network endpoints for the Transfers V2 API (/v2/transfers).

Each case maps to a specific API route and HTTP method used by TransfersV2API.

Inheritors

Types

CaptureTransfer

data class CaptureTransfer(val transferId: String, val idempotencyKey: String) : TransferV2Endpoints

Endpoint for capturing a manually authorized payment transfer (POST /v2/transfers/{id}/capture).

ConfirmTransfer

data class ConfirmTransfer(val transferId: String, val idempotencyKey: String? = null) : TransferV2Endpoints

Endpoint for confirming a deferred-confirm payment transfer (POST /v2/transfers/{id}/confirm).

CreateTransfer

data class CreateTransfer(val idempotencyKey: String) : TransferV2Endpoints

Endpoint for creating a new V2 transfer (POST /v2/transfers).

GetTransfers

data class GetTransfers(val perPage: Int?, val page: Int?) : TransferV2Endpoints

Endpoint for retrieving a paginated list of V2 transfers (GET /v2/transfers).

GetTransferWith

data class GetTransferWith(val transferId: String) : TransferV2Endpoints

Endpoint for retrieving a single V2 transfer by identifier (GET /v2/transfers/{id}).

RefundTransfer

data class RefundTransfer(val transferId: String, val idempotencyKey: String) : TransferV2Endpoints

Endpoint for refunding a succeeded payment transfer (POST /v2/transfers/{id}/refund).

UpdateTransfer

data class UpdateTransfer(val transferId: String) : TransferV2Endpoints

Endpoint for updating a deferred-confirm payment transfer (PATCH /v2/transfers/{id}).

VoidTransfer

data class VoidTransfer(val transferId: String, val idempotencyKey: String) : TransferV2Endpoints

Endpoint for voiding a manually authorized payment transfer (POST /v2/transfers/{id}/void).

Properties

additionalHeaders

open override val additionalHeaders: Map<String, String>

Extra headers; mutating money-movement members send Idempotency-Key.

endpointURL

open override val endpointURL: String

The resolved URL path for this endpoint.

httpMethod

open override val httpMethod: String

The HTTP method for this endpoint.

queryItems

open override val queryItems: List<QueryItem>?

Query parameters appended to the request URL, populated for GetTransfers only.