FrameSDK/com.framepayments.framesdk.transfers/TransferEndpoints/GetTransfers

GetTransfers

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

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

Constructors

GetTransfers

constructor(perPage: Int?, page: Int?)

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

The resolved URL path for this endpoint.

httpMethod

open override val httpMethod: String

The HTTP method for this endpoint.

page

val page: Int?

The page number to retrieve, or null to retrieve the first page.

perPage

val perPage: Int?

The number of results per page, or null to use the API default.

queryItems

open override val queryItems: List<QueryItem>?

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