Century TypeScript SDK

Base URLs

prod
https://centuryvtu.com
preview
https://project--<id>-dev.lovable.app

Authentication

Protected endpoints require a Supabase bearer access token:

Authorization: Bearer <access_token>
Content-Type: application/json

Calling a server function

POST /_serverFn/buyAirtime
Authorization: Bearer <access_token>
Content-Type: application/json

{
  "data": {
    "network": "MTN",
    "phone": "080XXXXXXXX",
    "amount": 500,
    "pin": "1234"
  }
}

101 endpoints

POST

/_serverFn/sendLoginOtpPublicAuth

sendLoginOtp

Send a login one-time code to an email address.

Request body (JSON)

Field	Type	Required
email	string	yes

Response

{ ok: true }

Errors

401 — Unauthorized – missing or invalid bearer token.
400 — Validation failed – input did not match the schema.
429 — Rate limited – slow down and retry.
500 — Server error – reported and logged with an error ID.

POST

/_serverFn/getOtpCooldownPublicAuth

getOtpCooldown

Check cooldown before another OTP can be requested.

Request body (JSON)

Field	Type	Required
email	string	yes

Response

{ secondsRemaining: number }

Errors

401 — Unauthorized – missing or invalid bearer token.
400 — Validation failed – input did not match the schema.
429 — Rate limited – slow down and retry.
500 — Server error – reported and logged with an error ID.

POST

/_serverFn/sendPhoneOtpPublicAuth

sendPhoneOtp

Send an SMS OTP to a phone number.

Request body (JSON)

Field	Type	Required
phone	string	yes

Errors

401 — Unauthorized – missing or invalid bearer token.
400 — Validation failed – input did not match the schema.
429 — Rate limited – slow down and retry.
500 — Server error – reported and logged with an error ID.

POST

/_serverFn/verifyPhoneOtpPublicAuth

verifyPhoneOtp

Verify a phone OTP.

Request body (JSON)

Field	Type	Required
phone	string	yes
code	string	yes

Errors

401 — Unauthorized – missing or invalid bearer token.
400 — Validation failed – input did not match the schema.
429 — Rate limited – slow down and retry.
500 — Server error – reported and logged with an error ID.

POST

/_serverFn/isPhoneVerifiedBearerAuth

isPhoneVerified

Whether the caller's phone has been verified.

Request body (JSON)

Field	Type	Required
phone	string	yes

Errors

401 — Unauthorized – missing or invalid bearer token.
400 — Validation failed – input did not match the schema.
429 — Rate limited – slow down and retry.
500 — Server error – reported and logged with an error ID.

POST

/_serverFn/resolveLoginIdentifierPublicAuth

resolveLoginIdentifier

Resolve an @username or email to an account for PIN login.

Request body (JSON)

Field	Type	Required
identifier	string	yes

Errors

401 — Unauthorized – missing or invalid bearer token.
400 — Validation failed – input did not match the schema.
429 — Rate limited – slow down and retry.
500 — Server error – reported and logged with an error ID.

POST

/_serverFn/startPinLoginPublicAuth

startPinLogin

Request body (JSON)

Field	Type	Required
identifier	string	yes
pin	string	yes

Response

{ session: SupabaseSession }

Errors

401 — Unauthorized – missing or invalid bearer token.
400 — Validation failed – input did not match the schema.
429 — Rate limited – slow down and retry.
500 — Server error – reported and logged with an error ID.

GET

/_serverFn/getLoginPinStatusBearerAuth

getLoginPinStatus

Whether the caller has a login PIN enrolled.

Errors

401 — Unauthorized – missing or invalid bearer token.
400 — Validation failed – input did not match the schema.
429 — Rate limited – slow down and retry.
500 — Server error – reported and logged with an error ID.

POST

/_serverFn/setLoginPinBearerAuth

setLoginPin

Enrol/update the 6-digit login PIN.

Request body (JSON)

Field	Type	Required
pin	string	yes

Errors

401 — Unauthorized – missing or invalid bearer token.
400 — Validation failed – input did not match the schema.
429 — Rate limited – slow down and retry.
500 — Server error – reported and logged with an error ID.

POST

/_serverFn/disableLoginPinBearerAuth

disableLoginPin

Turn off PIN login.

Errors

401 — Unauthorized – missing or invalid bearer token.
400 — Validation failed – input did not match the schema.
429 — Rate limited – slow down and retry.
500 — Server error – reported and logged with an error ID.

POST

/_serverFn/claimSessionBearerAuth

claimSession

Claim exclusive single-device session.

Request body (JSON)

Field	Type	Required
deviceId	string	yes
userAgent	string	no

Errors

401 — Unauthorized – missing or invalid bearer token.
400 — Validation failed – input did not match the schema.
429 — Rate limited – slow down and retry.
500 — Server error – reported and logged with an error ID.

POST

/_serverFn/heartbeatSessionBearerAuth

heartbeatSession

Refresh session heartbeat.

Request body (JSON)

Field	Type	Required
deviceId	string	yes

Errors

401 — Unauthorized – missing or invalid bearer token.
400 — Validation failed – input did not match the schema.
429 — Rate limited – slow down and retry.
500 — Server error – reported and logged with an error ID.

POST

/_serverFn/releaseSessionBearerAuth

releaseSession

Release the current session.

Errors

401 — Unauthorized – missing or invalid bearer token.
400 — Validation failed – input did not match the schema.
429 — Rate limited – slow down and retry.
500 — Server error – reported and logged with an error ID.

POST

/_serverFn/notifyLoginBearerAuth

notifyLogin

Record a login event and email an alert.

Request body (JSON)

Field	Type	Required
device	string	no
method	string	no
sessionId	string	no

Errors

401 — Unauthorized – missing or invalid bearer token.
400 — Validation failed – input did not match the schema.
429 — Rate limited – slow down and retry.
500 — Server error – reported and logged with an error ID.

POST

/_serverFn/getMyTwoFactorBearer2FA

getMyTwoFactor

Return 2FA enrollment / challenge state.

Request body (JSON)

Field	Type	Required
grantToken	string	no

Errors

401 — Unauthorized – missing or invalid bearer token.
400 — Validation failed – input did not match the schema.
429 — Rate limited – slow down and retry.
500 — Server error – reported and logged with an error ID.

POST

/_serverFn/beginTotpEnrollmentBearer2FA

beginTotpEnrollment

Start TOTP enrollment (returns provisioning URI).

Errors

401 — Unauthorized – missing or invalid bearer token.
400 — Validation failed – input did not match the schema.
429 — Rate limited – slow down and retry.
500 — Server error – reported and logged with an error ID.

POST

/_serverFn/confirmTotpEnrollmentBearer2FA

confirmTotpEnrollment

Confirm TOTP setup by supplying a code.

Request body (JSON)

Field	Type	Required
code	string	yes

Errors

401 — Unauthorized – missing or invalid bearer token.
400 — Validation failed – input did not match the schema.
429 — Rate limited – slow down and retry.
500 — Server error – reported and logged with an error ID.

POST

/_serverFn/sendStepupEmailCodeBearer2FA

sendStepupEmailCode

Send an email step-up code.

Errors

401 — Unauthorized – missing or invalid bearer token.
400 — Validation failed – input did not match the schema.
429 — Rate limited – slow down and retry.
500 — Server error – reported and logged with an error ID.

POST

/_serverFn/verifyStepupChallengeBearer2FA

verifyStepupChallenge

Verify a step-up TOTP or email code.

Request body (JSON)

Field	Type	Required
totpCode	string	yes

Response

{ grantToken: string }

Errors

401 — Unauthorized – missing or invalid bearer token.
400 — Validation failed – input did not match the schema.
429 — Rate limited – slow down and retry.
500 — Server error – reported and logged with an error ID.

POST

/_serverFn/revokeGrantBearer2FA

revokeGrant

Revoke a step-up grant.

Request body (JSON)

Field	Type	Required
grantToken	string	yes

Errors

401 — Unauthorized – missing or invalid bearer token.
400 — Validation failed – input did not match the schema.
429 — Rate limited – slow down and retry.
500 — Server error – reported and logged with an error ID.

GET

/_serverFn/getWalletStateBearerWallet

getWalletState

Balance, locked bonuses, recent ledger.

Response

{ balance, lockedBonus, referralLockedBonus, log: WalletLedgerRow[] }

Errors

401 — Unauthorized – missing or invalid bearer token.
400 — Validation failed – input did not match the schema.
429 — Rate limited – slow down and retry.
500 — Server error – reported and logged with an error ID.

POST

/_serverFn/createTopupIntentBearerWallet

createTopupIntent

Create a server-side top-up intent with an immutable reference.

Request body (JSON)

Field	Type	Required
amount	number (₦100–₦1,000,000)	yes
processor	string	yes

Response

{ id, reference, amount }

Errors

401 — Unauthorized – missing or invalid bearer token.
400 — Validation failed – input did not match the schema.
429 — Rate limited – slow down and retry.
500 — Server error – reported and logged with an error ID.

GET

/_serverFn/getTopupIntentBearerWallet

getTopupIntent

Poll the status of your top-up intent.

Request body (JSON)

Field	Type	Required
reference	string	yes

Errors

401 — Unauthorized – missing or invalid bearer token.
400 — Validation failed – input did not match the schema.
429 — Rate limited – slow down and retry.
500 — Server error – reported and logged with an error ID.

POST

/_serverFn/debitWalletFnBearerWallet

debitWalletFn

Debit the caller's wallet (requires transaction PIN).

Request body (JSON)

Field	Type	Required
amount	number (min ₦50)	yes
note	string	yes
pin	string (4 digits)	yes

Errors

401 — Unauthorized – missing or invalid bearer token.
400 — Validation failed – input did not match the schema.
429 — Rate limited – slow down and retry.
500 — Server error – reported and logged with an error ID.

POST

/_serverFn/transferWalletFnBearerWallet

transferWalletFn

Send funds to another Century user (KYC Tier 2 required).

Request body (JSON)

Field	Type	Required
username	string	yes
amount	number	yes
note	string	no
pin	string	yes

Errors

401 — Unauthorized – missing or invalid bearer token.
400 — Validation failed – input did not match the schema.
429 — Rate limited – slow down and retry.
500 — Server error – reported and logged with an error ID.

POST

/_serverFn/lookupProfileByUsernameBearerWallet

lookupProfileByUsername

Resolve a @username to a recipient profile.

Request body (JSON)

Field	Type	Required
username	string	yes

Errors

401 — Unauthorized – missing or invalid bearer token.
400 — Validation failed – input did not match the schema.
429 — Rate limited – slow down and retry.
500 — Server error – reported and logged with an error ID.

POST

/_serverFn/startPaystackTopupBearerPayments

startPaystackTopup

Initialize a Paystack transaction and return an authorization URL.

Request body (JSON)

Field	Type	Required
amount	number	yes
email	string	yes
callbackUrl	string	yes

Errors

401 — Unauthorized – missing or invalid bearer token.
400 — Validation failed – input did not match the schema.
429 — Rate limited – slow down and retry.
500 — Server error – reported and logged with an error ID.

POST

/_serverFn/verifyPaystackTopupBearerPayments

verifyPaystackTopup

Verify a Paystack reference and credit the wallet if unsettled.

Request body (JSON)

Field	Type	Required
reference	string	yes

Errors

401 — Unauthorized – missing or invalid bearer token.
400 — Validation failed – input did not match the schema.
429 — Rate limited – slow down and retry.
500 — Server error – reported and logged with an error ID.

GET

/_serverFn/getTopupReceiptBearerPayments

getTopupReceipt

Fetch a shareable top-up receipt.

Request body (JSON)

Field	Type	Required
reference	string	yes

Errors

401 — Unauthorized – missing or invalid bearer token.
400 — Validation failed – input did not match the schema.
429 — Rate limited – slow down and retry.
500 — Server error – reported and logged with an error ID.

GET

/_serverFn/listPaymentHistoryBearerPayments

listPaymentHistory

List the caller's payment intents/settlements.

Errors

401 — Unauthorized – missing or invalid bearer token.
400 — Validation failed – input did not match the schema.
429 — Rate limited – slow down and retry.
500 — Server error – reported and logged with an error ID.

GET

/_serverFn/listAirtimeNetworksBearerVTU

listAirtimeNetworks

Available airtime networks.

Errors

401 — Unauthorized – missing or invalid bearer token.
400 — Validation failed – input did not match the schema.
429 — Rate limited – slow down and retry.
500 — Server error – reported and logged with an error ID.

GET

/_serverFn/listDataNetworksBearerVTU

listDataNetworks

Available data networks.

Errors

401 — Unauthorized – missing or invalid bearer token.
400 — Validation failed – input did not match the schema.
429 — Rate limited – slow down and retry.
500 — Server error – reported and logged with an error ID.

GET

/_serverFn/listDataPlanTypesBearerVTU

listDataPlanTypes

Plan categories (SME/CG/GIFTING…) for a network.

Request body (JSON)

Field	Type	Required
network	string	yes

Errors

401 — Unauthorized – missing or invalid bearer token.
400 — Validation failed – input did not match the schema.
429 — Rate limited – slow down and retry.
500 — Server error – reported and logged with an error ID.

GET

/_serverFn/listDataPlansBearerVTU

listDataPlans

All data plans for a network.

Request body (JSON)

Field	Type	Required
network	string	yes

Errors

401 — Unauthorized – missing or invalid bearer token.
400 — Validation failed – input did not match the schema.
429 — Rate limited – slow down and retry.
500 — Server error – reported and logged with an error ID.

GET

/_serverFn/listDataPlansForCategoryBearerVTU

listDataPlansForCategory

Plans in one category.

Request body (JSON)

Field	Type	Required
network	string	yes
planType	string	yes

Errors

401 — Unauthorized – missing or invalid bearer token.
400 — Validation failed – input did not match the schema.
429 — Rate limited – slow down and retry.
500 — Server error – reported and logged with an error ID.

GET

/_serverFn/listCableProvidersBearerVTU

listCableProviders

Cable TV providers.

Errors

401 — Unauthorized – missing or invalid bearer token.
400 — Validation failed – input did not match the schema.
429 — Rate limited – slow down and retry.
500 — Server error – reported and logged with an error ID.

GET

/_serverFn/listCablePlansBearerVTU

listCablePlans

Cable plans for a provider.

Request body (JSON)

Field	Type	Required
identifier	string	yes

Errors

401 — Unauthorized – missing or invalid bearer token.
400 — Validation failed – input did not match the schema.
429 — Rate limited – slow down and retry.
500 — Server error – reported and logged with an error ID.

GET

/_serverFn/listElectricityPlansBearerVTU

listElectricityPlans

Available discos.

Errors

401 — Unauthorized – missing or invalid bearer token.
400 — Validation failed – input did not match the schema.
429 — Rate limited – slow down and retry.
500 — Server error – reported and logged with an error ID.

GET

/_serverFn/listBetCompaniesBearerVTU

listBetCompanies

Supported betting companies.

Errors

401 — Unauthorized – missing or invalid bearer token.
400 — Validation failed – input did not match the schema.
429 — Rate limited – slow down and retry.
500 — Server error – reported and logged with an error ID.

POST

/_serverFn/quotePriceBearerVTU

quotePrice

Return retail price after markup.

Request body (JSON)

Field	Type	Required
service	string	yes
provider	string	no
wholesale	number	yes

Errors

401 — Unauthorized – missing or invalid bearer token.
400 — Validation failed – input did not match the schema.
429 — Rate limited – slow down and retry.
500 — Server error – reported and logged with an error ID.

POST

/_serverFn/verifyCableIUCBearerVTU

verifyCableIUC

Lookup cable subscriber name.

Request body (JSON)

Field	Type	Required
iuc	string	yes
identifier	string	yes

Errors

401 — Unauthorized – missing or invalid bearer token.
400 — Validation failed – input did not match the schema.
429 — Rate limited – slow down and retry.
500 — Server error – reported and logged with an error ID.

POST

/_serverFn/verifyMeterBearerVTU

verifyMeter

Lookup meter/customer name.

Request body (JSON)

Field	Type	Required
meter	string	yes
plan	string	yes
type	'prepaid'\|'postpaid'	yes

Errors

401 — Unauthorized – missing or invalid bearer token.
400 — Validation failed – input did not match the schema.
429 — Rate limited – slow down and retry.
500 — Server error – reported and logged with an error ID.

POST

/_serverFn/verifyBetAccountBearerVTU

verifyBetAccount

Lookup betting customer.

Request body (JSON)

Field	Type	Required
betting_company	string	yes
customer_id	string	yes

Errors

401 — Unauthorized – missing or invalid bearer token.
400 — Validation failed – input did not match the schema.
429 — Rate limited – slow down and retry.
500 — Server error – reported and logged with an error ID.

POST

/_serverFn/buyAirtimeBearerVTU

buyAirtime

Purchase airtime (requires PIN).

Request body (JSON)

Field	Type	Required
network	string	yes
phone	string	yes
amount	number	yes
pin	string	yes

Errors

401 — Unauthorized – missing or invalid bearer token.
400 — Validation failed – input did not match the schema.
429 — Rate limited – slow down and retry.
500 — Server error – reported and logged with an error ID.

POST

/_serverFn/buyDataBearerVTU

buyData

Purchase a data bundle (requires PIN).

Request body (JSON)

Field	Type	Required
network	string	yes
plan_id	string	yes
phone	string	yes
amount	number	yes
pin	string	yes

Errors

401 — Unauthorized – missing or invalid bearer token.
400 — Validation failed – input did not match the schema.
429 — Rate limited – slow down and retry.
500 — Server error – reported and logged with an error ID.

POST

/_serverFn/subscribeCableBearerVTU

subscribeCable

Pay a cable subscription (requires PIN).

Errors

401 — Unauthorized – missing or invalid bearer token.
400 — Validation failed – input did not match the schema.
429 — Rate limited – slow down and retry.
500 — Server error – reported and logged with an error ID.

POST

/_serverFn/buyElectricityBearerVTU

buyElectricity

Buy electricity token (requires PIN, min ₦1,000).

Errors

401 — Unauthorized – missing or invalid bearer token.
400 — Validation failed – input did not match the schema.
429 — Rate limited – slow down and retry.
500 — Server error – reported and logged with an error ID.

POST

/_serverFn/fundBetBearerVTU

fundBet

Fund a betting wallet (requires PIN).

Errors

401 — Unauthorized – missing or invalid bearer token.
400 — Validation failed – input did not match the schema.
429 — Rate limited – slow down and retry.
500 — Server error – reported and logged with an error ID.

POST

/_serverFn/buyEducationPinBearerVTU

buyEducationPin

Buy an exam pin (requires PIN).

Errors

401 — Unauthorized – missing or invalid bearer token.
400 — Validation failed – input did not match the schema.
429 — Rate limited – slow down and retry.
500 — Server error – reported and logged with an error ID.

GET

/_serverFn/listMyVtuTransactionsBearerVTU

listMyVtuTransactions

Recent VTU transactions.

Errors

401 — Unauthorized – missing or invalid bearer token.
400 — Validation failed – input did not match the schema.
429 — Rate limited – slow down and retry.
500 — Server error – reported and logged with an error ID.

POST

/_serverFn/getMyVtuTransactionBearerVTU

getMyVtuTransaction

Fetch one VTU transaction by id.

Request body (JSON)

Field	Type	Required
id	uuid	yes

Errors

401 — Unauthorized – missing or invalid bearer token.
400 — Validation failed – input did not match the schema.
429 — Rate limited – slow down and retry.
500 — Server error – reported and logged with an error ID.

POST

/_serverFn/submitNinKycBearerKYC

submitNinKyc

Submit Tier 1 (NIN).

Request body (JSON)

Field	Type	Required
nin	string	yes
slipPath	string	yes
fullName	string	no

Errors

401 — Unauthorized – missing or invalid bearer token.
400 — Validation failed – input did not match the schema.
429 — Rate limited – slow down and retry.
500 — Server error – reported and logged with an error ID.

POST

/_serverFn/submitBankKycBearerKYC

submitBankKyc

Submit Tier 2 (bank + ID).

Errors

401 — Unauthorized – missing or invalid bearer token.
400 — Validation failed – input did not match the schema.
429 — Rate limited – slow down and retry.
500 — Server error – reported and logged with an error ID.

POST

/_serverFn/submitTier3KycBearerKYC

submitTier3Kyc

Submit Tier 3 (liveness frames).

Errors

401 — Unauthorized – missing or invalid bearer token.
400 — Validation failed – input did not match the schema.
429 — Rate limited – slow down and retry.
500 — Server error – reported and logged with an error ID.

POST

/_serverFn/getKycFileUrlBearerKYC

getKycFileUrl

Signed URL for a KYC upload.

Request body (JSON)

Field	Type	Required
path	string	yes

Errors

401 — Unauthorized – missing or invalid bearer token.
400 — Validation failed – input did not match the schema.
429 — Rate limited – slow down and retry.
500 — Server error – reported and logged with an error ID.

POST

/_serverFn/lookupNinBearerKYC

lookupNin

Server-side NIN lookup.

Errors

401 — Unauthorized – missing or invalid bearer token.
400 — Validation failed – input did not match the schema.
429 — Rate limited – slow down and retry.
500 — Server error – reported and logged with an error ID.

POST

/_serverFn/verifyBankAccountBearerKYC

verifyBankAccount

NUBAN name enquiry.

Request body (JSON)

Field	Type	Required
accountNumber	string	yes
bankCode	string	yes

Errors

401 — Unauthorized – missing or invalid bearer token.
400 — Validation failed – input did not match the schema.
429 — Rate limited – slow down and retry.
500 — Server error – reported and logged with an error ID.

GET

/_serverFn/listBanksBearerKYC

listBanks

List Nigerian banks.

Errors

401 — Unauthorized – missing or invalid bearer token.
400 — Validation failed – input did not match the schema.
429 — Rate limited – slow down and retry.
500 — Server error – reported and logged with an error ID.

GET

/_serverFn/listNotificationsBearerNotifications

listNotifications

Caller's inbox.

Errors

401 — Unauthorized – missing or invalid bearer token.
400 — Validation failed – input did not match the schema.
429 — Rate limited – slow down and retry.
500 — Server error – reported and logged with an error ID.

POST

/_serverFn/markAllNotificationsReadBearerNotifications

markAllNotificationsRead

Mark all as read.

Errors

401 — Unauthorized – missing or invalid bearer token.
400 — Validation failed – input did not match the schema.
429 — Rate limited – slow down and retry.
500 — Server error – reported and logged with an error ID.

POST

/_serverFn/markNotificationReadBearerNotifications

markNotificationRead

Mark one as read.

Request body (JSON)

Field	Type	Required
id	uuid	yes

Errors

401 — Unauthorized – missing or invalid bearer token.
400 — Validation failed – input did not match the schema.
429 — Rate limited – slow down and retry.
500 — Server error – reported and logged with an error ID.

GET

/_serverFn/listBroadcastsBearerNotifications

listBroadcasts

List active broadcasts.

Errors

401 — Unauthorized – missing or invalid bearer token.
400 — Validation failed – input did not match the schema.
429 — Rate limited – slow down and retry.
500 — Server error – reported and logged with an error ID.

POST

/_serverFn/votePollBearerNotifications

votePoll

Vote in a broadcast poll.

Request body (JSON)

Field	Type	Required
pollId	uuid	yes
optionId	uuid	yes

Errors

401 — Unauthorized – missing or invalid bearer token.
400 — Validation failed – input did not match the schema.
429 — Rate limited – slow down and retry.
500 — Server error – reported and logged with an error ID.

GET

/_serverFn/getPushPublicKeyPublicPush

getPushPublicKey

VAPID public key for Web Push.

Errors

401 — Unauthorized – missing or invalid bearer token.
400 — Validation failed – input did not match the schema.
429 — Rate limited – slow down and retry.
500 — Server error – reported and logged with an error ID.

POST

/_serverFn/savePushSubscriptionBearerPush

savePushSubscription

Request body (JSON)

Field	Type	Required
endpoint	string	yes
p256dh	string	yes
auth	string	yes

Errors

401 — Unauthorized – missing or invalid bearer token.
400 — Validation failed – input did not match the schema.
429 — Rate limited – slow down and retry.
500 — Server error – reported and logged with an error ID.

POST

/_serverFn/deletePushSubscriptionBearerPush

deletePushSubscription

Delete a push endpoint.

Request body (JSON)

Field	Type	Required
endpoint	string	yes

Errors

401 — Unauthorized – missing or invalid bearer token.
400 — Validation failed – input did not match the schema.
429 — Rate limited – slow down and retry.
500 — Server error – reported and logged with an error ID.

GET

/_serverFn/hasTransactionPinBearerSettings

hasTransactionPin

Whether transaction PIN is set.

Errors

401 — Unauthorized – missing or invalid bearer token.
400 — Validation failed – input did not match the schema.
429 — Rate limited – slow down and retry.
500 — Server error – reported and logged with an error ID.

POST

/_serverFn/setTransactionPinFnBearerSettings

setTransactionPinFn

Set/change 4-digit transaction PIN.

Request body (JSON)

Field	Type	Required
pin	string (4 digits)	yes
currentPin	string	no

Errors

401 — Unauthorized – missing or invalid bearer token.
400 — Validation failed – input did not match the schema.
429 — Rate limited – slow down and retry.
500 — Server error – reported and logged with an error ID.

GET

/_serverFn/getPreferencesBearerSettings

getPreferences

User preferences.

Errors

401 — Unauthorized – missing or invalid bearer token.
400 — Validation failed – input did not match the schema.
429 — Rate limited – slow down and retry.
500 — Server error – reported and logged with an error ID.

POST

/_serverFn/updatePreferencesBearerSettings

updatePreferences

Update user preferences.

Errors

401 — Unauthorized – missing or invalid bearer token.
400 — Validation failed – input did not match the schema.
429 — Rate limited – slow down and retry.
500 — Server error – reported and logged with an error ID.

POST

/_serverFn/closeAccountBearerSettings

closeAccount

Close the account.

Request body (JSON)

Field	Type	Required
confirm	string ("DELETE")	yes

Errors

401 — Unauthorized – missing or invalid bearer token.
400 — Validation failed – input did not match the schema.
429 — Rate limited – slow down and retry.
500 — Server error – reported and logged with an error ID.

GET

/_serverFn/getMyReferralStatusBearerGrowth

getMyReferralStatus

Referral code, invitees and locked bonus.

Errors

401 — Unauthorized – missing or invalid bearer token.
400 — Validation failed – input did not match the schema.
429 — Rate limited – slow down and retry.
500 — Server error – reported and logged with an error ID.

GET

/_serverFn/getPendingMilestonesBearerGrowth

getPendingMilestones

Milestones awaiting acknowledgement.

Errors

401 — Unauthorized – missing or invalid bearer token.
400 — Validation failed – input did not match the schema.
429 — Rate limited – slow down and retry.
500 — Server error – reported and logged with an error ID.

POST

/_serverFn/ackMilestoneBearerGrowth

ackMilestone

Acknowledge a milestone.

Request body (JSON)

Field	Type	Required
threshold	number	yes

Errors

401 — Unauthorized – missing or invalid bearer token.
400 — Validation failed – input did not match the schema.
429 — Rate limited – slow down and retry.
500 — Server error – reported and logged with an error ID.

GET

/_serverFn/getCheckinStatusBearerGrowth

getCheckinStatus

Daily check-in status.

Errors

401 — Unauthorized – missing or invalid bearer token.
400 — Validation failed – input did not match the schema.
429 — Rate limited – slow down and retry.
500 — Server error – reported and logged with an error ID.

POST

/_serverFn/claimCheckinBearerGrowth

claimCheckin

Claim today's check-in.

Errors

401 — Unauthorized – missing or invalid bearer token.
400 — Validation failed – input did not match the schema.
429 — Rate limited – slow down and retry.
500 — Server error – reported and logged with an error ID.

POST

/_serverFn/withdrawCheckinBearerGrowth

withdrawCheckin

Withdraw accrued check-in bonus.

Errors

401 — Unauthorized – missing or invalid bearer token.
400 — Validation failed – input did not match the schema.
429 — Rate limited – slow down and retry.
500 — Server error – reported and logged with an error ID.

GET

/_serverFn/listSavingsLocksBearerSavings

listSavingsLocks

List savings locks.

Errors

401 — Unauthorized – missing or invalid bearer token.
400 — Validation failed – input did not match the schema.
429 — Rate limited – slow down and retry.
500 — Server error – reported and logged with an error ID.

POST

/_serverFn/createSavingsLockBearerSavings

createSavingsLock

Lock funds for N days.

Request body (JSON)

Field	Type	Required
amount	number	yes
days	number	yes

Errors

401 — Unauthorized – missing or invalid bearer token.
400 — Validation failed – input did not match the schema.
429 — Rate limited – slow down and retry.
500 — Server error – reported and logged with an error ID.

POST

/_serverFn/breakSavingsLockBearerSavings

breakSavingsLock

Break a savings lock early.

Request body (JSON)

Field	Type	Required
lockId	uuid	yes

Errors

401 — Unauthorized – missing or invalid bearer token.
400 — Validation failed – input did not match the schema.
429 — Rate limited – slow down and retry.
500 — Server error – reported and logged with an error ID.

GET

/_serverFn/getLoanOverviewBearerLoans

getLoanOverview

Loan eligibility and outstanding balance.

Errors

401 — Unauthorized – missing or invalid bearer token.
400 — Validation failed – input did not match the schema.
429 — Rate limited – slow down and retry.
500 — Server error – reported and logged with an error ID.

POST

/_serverFn/takeLoanBearerLoans

takeLoan

Take a loan.

Errors

401 — Unauthorized – missing or invalid bearer token.
400 — Validation failed – input did not match the schema.
429 — Rate limited – slow down and retry.
500 — Server error – reported and logged with an error ID.

GET

/_serverFn/listMyMarketplaceOrdersBearerMarketplace

listMyMarketplaceOrders

Caller's marketplace orders.

Errors

401 — Unauthorized – missing or invalid bearer token.
400 — Validation failed – input did not match the schema.
429 — Rate limited – slow down and retry.
500 — Server error – reported and logged with an error ID.

POST

/_serverFn/createMarketplaceOrderBearerMarketplace

createMarketplaceOrder

Create a marketplace order.

Errors

401 — Unauthorized – missing or invalid bearer token.
400 — Validation failed – input did not match the schema.
429 — Rate limited – slow down and retry.
500 — Server error – reported and logged with an error ID.

GET

/_serverFn/getMarketplaceOrderBearerMarketplace

getMarketplaceOrder

Fetch one order.

Request body (JSON)

Field	Type	Required
id	uuid	yes

Errors

401 — Unauthorized – missing or invalid bearer token.
400 — Validation failed – input did not match the schema.
429 — Rate limited – slow down and retry.
500 — Server error – reported and logged with an error ID.

GET

/_serverFn/listMySubscriptionOrdersBearerSubscriptions

listMySubscriptionOrders

Caller's subscription orders.

Errors

401 — Unauthorized – missing or invalid bearer token.
400 — Validation failed – input did not match the schema.
429 — Rate limited – slow down and retry.
500 — Server error – reported and logged with an error ID.

POST

/_serverFn/submitSubscriptionOrderBearerSubscriptions

submitSubscriptionOrder

Submit a subscription order (requires PIN).

Errors

401 — Unauthorized – missing or invalid bearer token.
400 — Validation failed – input did not match the schema.
429 — Rate limited – slow down and retry.
500 — Server error – reported and logged with an error ID.

POST

/_serverFn/getOrCreateThreadBearerSupport

getOrCreateThread

Get or create the caller's support thread.

Errors

401 — Unauthorized – missing or invalid bearer token.
400 — Validation failed – input did not match the schema.
429 — Rate limited – slow down and retry.
500 — Server error – reported and logged with an error ID.

GET

/_serverFn/listThreadMessagesBearerSupport

listThreadMessages

List messages in a support thread.

Request body (JSON)

Field	Type	Required
threadId	uuid	yes

Errors

401 — Unauthorized – missing or invalid bearer token.
400 — Validation failed – input did not match the schema.
429 — Rate limited – slow down and retry.
500 — Server error – reported and logged with an error ID.

POST

/_serverFn/sendSupportMessageBearerSupport

sendSupportMessage

Post a support message.

Request body (JSON)

Field	Type	Required
threadId	uuid	yes
body	string	yes

Errors

401 — Unauthorized – missing or invalid bearer token.
400 — Validation failed – input did not match the schema.
429 — Rate limited – slow down and retry.
500 — Server error – reported and logged with an error ID.

GET

/_serverFn/listSchedulesBearerSchedules

listSchedules

List scheduled purchases.

Errors

401 — Unauthorized – missing or invalid bearer token.
400 — Validation failed – input did not match the schema.
429 — Rate limited – slow down and retry.
500 — Server error – reported and logged with an error ID.

POST

/_serverFn/upsertScheduleBearerSchedules

upsertSchedule

Create or update a schedule.

Errors

401 — Unauthorized – missing or invalid bearer token.
400 — Validation failed – input did not match the schema.
429 — Rate limited – slow down and retry.
500 — Server error – reported and logged with an error ID.

POST

/_serverFn/toggleScheduleBearerSchedules

toggleSchedule

Pause/resume a schedule.

Request body (JSON)

Field	Type	Required
id	uuid	yes
active	boolean	yes

Errors

401 — Unauthorized – missing or invalid bearer token.
400 — Validation failed – input did not match the schema.
429 — Rate limited – slow down and retry.
500 — Server error – reported and logged with an error ID.

POST

/_serverFn/deleteScheduleBearerSchedules

deleteSchedule

Delete a schedule.

Request body (JSON)

Field	Type	Required
id	uuid	yes

Errors

401 — Unauthorized – missing or invalid bearer token.
400 — Validation failed – input did not match the schema.
429 — Rate limited – slow down and retry.
500 — Server error – reported and logged with an error ID.

POST

/_serverFn/createTransactionReportBearerReports

createTransactionReport

Report a failed/disputed transaction.

Errors

401 — Unauthorized – missing or invalid bearer token.
400 — Validation failed – input did not match the schema.
429 — Rate limited – slow down and retry.
500 — Server error – reported and logged with an error ID.

GET

/_serverFn/listMyReportsBearerReports

listMyReports

Caller's issue reports.

Errors

401 — Unauthorized – missing or invalid bearer token.
400 — Validation failed – input did not match the schema.
429 — Rate limited – slow down and retry.
500 — Server error – reported and logged with an error ID.

POST

/_serverFn/signReceiptBearerReceipts

signReceipt

Sign a receipt payload.

Errors

401 — Unauthorized – missing or invalid bearer token.
400 — Validation failed – input did not match the schema.
429 — Rate limited – slow down and retry.
500 — Server error – reported and logged with an error ID.

GET

/_serverFn/verifyReceiptPublicReceipts

verifyReceipt

Public receipt verification lookup.

Request body (JSON)

Field	Type	Required
needle	string	yes

Errors

401 — Unauthorized – missing or invalid bearer token.
400 — Validation failed – input did not match the schema.
429 — Rate limited – slow down and retry.
500 — Server error – reported and logged with an error ID.

POST

/api/public/payments/webhook/paystackSigned webhookWebhooks

Paystack webhook

Signed Paystack webhook. Verifies x-paystack-signature (HMAC-SHA512) before crediting wallets.

Errors

401 — Invalid signature.
200 — Event accepted.

POST

/api/public/report-issuePublicWebhooks

Public issue reporter

Post a client-side error/issue report (used by the ErrorScreen fallback).

POST

/api/public/login-failedPublicWebhooks

Login failure telemetry

Record failed login attempts for rate limiting and alerts.