TransferEndpoints

Defines the network endpoints for the Transfers API.

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

Inheritors

Types

Link copied to clipboard

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

Link copied to clipboard
data class GetTransfers(val perPage: Int?, val page: Int?) : TransferEndpoints

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

Link copied to clipboard
data class GetTransferWith(val transferId: String) : TransferEndpoints

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

Properties

Link copied to clipboard
open override val endpointURL: String

The resolved URL path for this endpoint.

Link copied to clipboard
open override val httpMethod: String

The HTTP method for this endpoint.

Link copied to clipboard
open override val queryItems: List<QueryItem>?

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