Skip to content

TypeScript SDK

The TypeScript SDK is a fetch-based client for browser, Bun, Deno, edge, and other runtimes that provide fetch.

Package

FieldValue
Package@f-wallet/typescript
Version0.1.0
Repositoryf-wallet/fwallet-js
Terminal window
npm install @f-wallet/typescript

Client setup

import { Configuration, WalletsApi } from "@f-wallet/typescript";
const config = new Configuration({
basePath: "https://api.fwallet.co.ug",
apiKey: "fwk_live_...",
});
const wallets = new WalletsApi(config);
const wallet = await wallets.walletsGetWalletsById({ id: "wallet-id" });

Resource clients

ResourceClass
AdminAdminApi
AuthAuthApi
DepositsDepositsApi
DeveloperDeveloperApi
HealthHealthApi
JournalJournalApi
PayoutsPayoutsApi
SystemSystemApi
TeamTeamApi
TenantsTenantsApi
TransfersTransfersApi
WalletsWalletsApi

Operation methods

ResourceMethods
AdminadminGetAdminDashboard, adminGetAdminFeeSchedules, adminPostAdminFeeSchedulesByIdRules
AuthauthGetAuthMe
DepositsdepositsPostDepositsBankSlipVerify, depositsPostDepositsBankStatements, depositsPostDepositsMomoWebhook
DeveloperdeveloperGetDeveloperApiKeys, developerGetDeveloperApps, developerGetDeveloperRequestLogs, developerPatchDeveloperApiKeysByIdRestrictions, developerPatchDeveloperAppsById, developerPostDeveloperApiKeys, developerPostDeveloperApiKeysByIdRevoke, developerPostDeveloperApiKeysByIdRotate, developerPostDeveloperApps
HealthhealthGetHealth
JournaljournalGetJournal, journalGetJournalById
PayoutspayoutsGetPayoutsCases, payoutsPostPayouts, payoutsPostPayoutsByCaseIdApprove, payoutsPostPayoutsByCaseIdReject
SystemsystemGetSystemOrganizations, systemGetSystemOverview, systemGetSystemTransactions, systemGetSystemWallets, systemPostSystemOrganizations
TeamteamGetTeam, teamPostTeam
TenantstenantsGetTenantsById, tenantsPostTenants, tenantsPostTenantsByIdApiKeys
TransferstransfersPostTransfers, transfersPostTransfersSimulateFee
WalletswalletsGetWallets, walletsGetWalletsById, walletsGetWalletsLookup, walletsPostWallets

Signing

The package exports request signing helpers from signing.ts. Use those helpers on server-side runtimes when you need HMAC signed requests instead of bearer API keys.