TypeScript SDK

Terminal
$ npm install @oris/sdk

Initialize

TypeScript
import { Agent } from '@oris/sdk' const agent = new Agent({ apiKey: 'oris_sk_live_...', apiSecret: 'oris_ss_live_...' })

Configuration

OptionTypeDefault
apiKeystringrequired
apiSecretstringrequired
agentIdstringundefined
baseUrlstringhttps://api.useoris.xyz
timeoutnumber30000
maxRetriesnumber3

All Methods (35)

MethodDescription
register(req)Register agent
getProfile()Agent profile
verify()Verify (L0-L1)
suspend(reason)Suspend
createWallet(opts?)Create wallet
getWallets()List wallets
getBalance(id)Balance
setPolicy(opts)Create policy
getPolicies()List policies
simulatePayment(opts)Simulate
pay(opts)Execute payment
getPayment(id)Get payment
getPayments(opts?)List payments
openChannel(opts)Open channel
meter(opts)Micropayment
listService(opts)Create listing
findServices(opts)Search
placeOrder(opts)Place order
completeOrder(id)Complete
fileDispute(opts)Dispute
getReputation(id?)Reputation
getEarnings()Earnings
onRamp(opts)Fiat in
offRamp(opts)Fiat out
getExchangeRate(s,d)FX rate
getTierLimits()Tier limits
generateAttestation(chain)ZKP
requestPromotion()Promote
getWhiteLabelConfig()WL config
updateWhiteLabelConfig(opts)Update WL
createPaymentStream(opts?)WS stream
createMempool(size?)Mempool