Skip to content

ReferralsService

Available as client.referrals. Every operation is scoped by workspaceId.

MethodPurpose
getProgram(workspaceId)Get referral program settings
updateProgram(workspaceId, data)Create or update the program
deleteProgram(workspaceId)Delete the program and void pending referrals
list(workspaceId, query?)List referrals
getStats(workspaceId)Get aggregate statistics
getAnalytics(workspaceId, days?)Get time-window analytics
cancel(workspaceId, referralId)Cancel a pending referral
cancelAllPending(workspaceId)Cancel all pending referrals
complete(workspaceId, referralId)Complete a pending referral administratively
getClientReferral(workspaceId, clientId)Get a client's referral information

WalletHero Documentation