WalletApi
All URIs are relative to https://business.apis.kesk.app/v1
| Method | HTTP request | Description |
|---|---|---|
| getStripeCustomerId | GET /wallet/stripe-customer | Get Stripe customer ID for the authenticated user |
| getWalletAddress | GET /wallet/address | Get authenticated user’s wallet address |
| getWalletBalance | GET /wallet | Get wallet balance and details |
| getWalletTransactions | GET /wallet/transactions | Get wallet transaction history |
| initiateWalletAddressTransfer | POST /wallet/address/transfer | Transfer funds using recipient’s wallet address |
| searchWalletAddress | GET /wallet/address/search | Search for users by wallet address or details |
| topupWallet | POST /wallet/topup | Initiate wallet topup transaction |
| transferWalletBalance | POST /wallet/transfer | Transfer wallet balance to another user |
getStripeCustomerId
StripeCustomerResponse getStripeCustomerId()
Get Stripe customer ID for the authenticated user
Returns the Stripe customer ID for the authenticated user. Creates a new Stripe customer if one doesn’t exist.
Parameters
This endpoint does not need any parameter.
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
getWalletAddress
WalletAddressResponse getWalletAddress()
Get authenticated user’s wallet address
Retrieves the user’s encrypted wallet address that can be shared with others for receiving funds. The wallet address uniquely identifies the user’s wallet.
Parameters
This endpoint does not need any parameter.
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
getWalletBalance
WalletResponse getWalletBalance()
Get wallet balance and details
Retrieves the authenticated user’s wallet information including current balance. Creates a new wallet automatically if the user doesn’t have one yet.
Parameters
This endpoint does not need any parameter.
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
getWalletTransactions
PaginatedResponse_WalletTransactionResponse getWalletTransactions(page, per_page)
Get wallet transaction history
Retrieves a paginated list of all wallet transactions for the authenticated user including topups, transfers, and payments. Transactions show amount, type, and status.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| page | Integer | Page number for pagination (default: 1) | [optional] [default to null] |
| per_page | Integer | Number of items per page (default: 20) | [optional] [default to null] |
Return type
PaginatedResponse_WalletTransactionResponse
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
initiateWalletAddressTransfer
WalletTransferResult initiateWalletAddressTransfer(WalletAddressTransferRequest)
Transfer funds using recipient’s wallet address
Initiates a secure transfer to another user’s wallet using their encrypted wallet address. Requires password verification, validates balance, and prevents self-transfers.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| WalletAddressTransferRequest | WalletAddressTransferRequest | Transfer request containing encrypted wallet address, amount, and password |
Return type
Authorization
HTTP request headers
- Content-Type: application/json; charset=utf-8
- Accept: application/json; charset=utf-8
searchWalletAddress
PaginatedResponse_WalletUserResponse searchWalletAddress(keyword, page, per_page)
Search for users by wallet address or details
Searches for other users by name, email, phone, or wallet address to find transfer recipients. Returns up to 10 matching users excluding the current user.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| keyword | String | Search keyword to match against name, email, phone, or wallet address | [default to null] |
| page | Integer | [optional] [default to null] | |
| per_page | Integer | [optional] [default to null] |
Return type
PaginatedResponse_WalletUserResponse
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
topupWallet
WalletTopupResponse topupWallet(WalletTopupRequest)
Initiate wallet topup transaction
Creates a pending topup transaction and returns a payment link for the user to complete. Validates minimum topup amount and generates a unique reference code for tracking.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| WalletTopupRequest | WalletTopupRequest | Topup request containing the amount to add |
Return type
Authorization
HTTP request headers
- Content-Type: application/json; charset=utf-8
- Accept: application/json; charset=utf-8
transferWalletBalance
WalletTransferOperationResponse transferWalletBalance(WalletTransferRequest)
Transfer wallet balance to another user
Transfers funds from the authenticated user’s wallet to another user’s wallet. Validates sufficient balance, prevents self-transfers, and ensures transaction integrity.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| WalletTransferRequest | WalletTransferRequest | Transfer request containing recipient user ID and amount |
Return type
WalletTransferOperationResponse
Authorization
HTTP request headers
- Content-Type: application/json; charset=utf-8
- Accept: application/json; charset=utf-8