FrameSDK/com.framepayments.framesdk.paymentmethods/PaymentMethodEndpoints

PaymentMethodEndpoints

sealed class PaymentMethodEndpoints : FrameNetworkingEndpoints

Defines every HTTP endpoint used by PaymentMethodsAPI.

Each case encapsulates the path parameters required to construct the endpoint URL, the HTTP method, and any query string items. Merchants interact with these indirectly through PaymentMethodsAPI and do not need to instantiate cases directly.

Inheritors

GetPaymentMethods

GetPaymentMethodWith

GetPaymentMethodsWithCustomer

GetPaymentMethodsWithAccount

CreatePaymentMethod

UpdatePaymentMethodWith

AttachPaymentMethodWith

DetachPaymentMethodWith

BlockPaymentMethodWith

UnblockPaymentMethodWith

ConnectPlaidBankAccount

Types

AttachPaymentMethodWith

data class AttachPaymentMethodWith(val paymentMethodId: String) : PaymentMethodEndpoints

Attaches a payment method to a customer or merchant account.

BlockPaymentMethodWith

data class BlockPaymentMethodWith(val paymentMethodId: String) : PaymentMethodEndpoints

Blocks a payment method, preventing it from being used for new transactions.

ConnectPlaidBankAccount

object ConnectPlaidBankAccount : PaymentMethodEndpoints

Creates an ACH payment method by exchanging a Plaid public token for a connected bank account.

CreatePaymentMethod

object CreatePaymentMethod : PaymentMethodEndpoints

Creates a new payment method (card, ACH, or Google Pay).

DetachPaymentMethodWith

data class DetachPaymentMethodWith(val paymentMethodId: String) : PaymentMethodEndpoints

Detaches a payment method from its associated customer or account.

GetPaymentMethods

data class GetPaymentMethods(val perPage: Int? = null, val page: Int? = null) : PaymentMethodEndpoints

Fetches a paginated list of all payment methods.

GetPaymentMethodsWithAccount

data class GetPaymentMethodsWithAccount(val accountId: String) : PaymentMethodEndpoints

Fetches all payment methods associated with a specific merchant account.

GetPaymentMethodsWithCustomer

data class GetPaymentMethodsWithCustomer(val customerId: String) : PaymentMethodEndpoints

Fetches all payment methods associated with a specific customer.

GetPaymentMethodWith

data class GetPaymentMethodWith(val paymentMethodId: String) : PaymentMethodEndpoints

Fetches a single payment method by its unique identifier.

UnblockPaymentMethodWith

data class UnblockPaymentMethodWith(val paymentMethodId: String) : PaymentMethodEndpoints

Unblocks a previously blocked payment method, restoring its ability to be used for transactions.

UpdatePaymentMethodWith

data class UpdatePaymentMethodWith(val paymentMethodId: String) : PaymentMethodEndpoints

Updates mutable fields on an existing payment method.

Properties

endpointURL

open override val endpointURL: String

The fully qualified URL string for this endpoint.

httpMethod

open override val httpMethod: String

HTTP method, e.g. "GET", "POST", "DELETE".

queryItems

open override val queryItems: List<QueryItem>?

Optional query-string parameters appended to endpointURL.