FrameSDK/com.framepayments.framesdk.customers/CustomersAPI

CustomersAPI

object CustomersAPI

Provides coroutine-based and callback-based methods for managing customers via the Frame API.

Each operation is available in two overloads: a suspend function for use with Kotlin coroutines, and a callback variant for use without coroutines.

Functions

blockCustomerWith

suspend fun blockCustomerWith(customerId: String): Pair<FrameObjects.Customer?, NetworkingError?>

Blocks a customer, preventing them from completing transactions.

fun blockCustomerWith(customerId: String, completionHandler: (FrameObjects.Customer?, NetworkingError?) -> Unit)

Blocks a customer and delivers the result to a callback.

suspend fun createCustomer(request: CustomersRequests.CreateCustomerRequest): Pair<FrameObjects.Customer?, NetworkingError?>

Creates a new customer record.

fun createCustomer(request: CustomersRequests.CreateCustomerRequest, completionHandler: (FrameObjects.Customer?, NetworkingError?) -> Unit)

Creates a new customer record and delivers the result to a callback.

suspend fun deleteCustomer(customerId: String): Pair<FrameObjects.Customer?, NetworkingError?>

Deletes a customer record by their unique identifier.

fun deleteCustomer(customerId: String, completionHandler: (FrameObjects.Customer?, NetworkingError?) -> Unit)

Deletes a customer record by their unique identifier and delivers the result to a callback.

suspend fun getCustomers(page: Int? = null, perPage: Int? = null): Pair<CustomersResponses.ListCustomersResponse?, NetworkingError?>

Retrieves a paginated list of customers.

fun getCustomers(page: Int? = null, perPage: Int? = null, completionHandler: (CustomersResponses.ListCustomersResponse?, NetworkingError?) -> Unit)

Retrieves a paginated list of customers and delivers the result to a callback.

getCustomerWith

suspend fun getCustomerWith(customerId: String): Pair<FrameObjects.Customer?, NetworkingError?>

Retrieves a single customer by their unique identifier.

fun getCustomerWith(customerId: String, completionHandler: (FrameObjects.Customer?, NetworkingError?) -> Unit)

Retrieves a single customer by their unique identifier and delivers the result to a callback.

searchCustomers

suspend fun searchCustomers(request: CustomersRequests.SearchCustomersRequest): Pair<List<FrameObjects.Customer>?, NetworkingError?>

Searches customers using the criteria specified in the request.

fun searchCustomers(request: CustomersRequests.SearchCustomersRequest, completionHandler: (List<FrameObjects.Customer>?, NetworkingError?) -> Unit)

Searches customers using the criteria specified in the request and delivers results to a callback.

unblockCustomerWith

suspend fun unblockCustomerWith(customerId: String): Pair<FrameObjects.Customer?, NetworkingError?>

Unblocks a previously blocked customer, restoring their ability to transact.

fun unblockCustomerWith(customerId: String, completionHandler: (FrameObjects.Customer?, NetworkingError?) -> Unit)

Unblocks a previously blocked customer and delivers the result to a callback.

suspend fun updateCustomer(customerId: String, request: CustomersRequests.UpdateCustomerRequest): Pair<FrameObjects.Customer?, NetworkingError?>

Updates an existing customer record.

fun updateCustomer(customerId: String, request: CustomersRequests.UpdateCustomerRequest, completionHandler: (FrameObjects.Customer?, NetworkingError?) -> Unit)

Updates an existing customer record and delivers the result to a callback.