BlueForge Docs

client.wallet.credit

Credit (adjust) a workspace wallet

Signature

class Client {
  wallet: {
    credit(workspaceId: string, input: CreditInput): Promise<{
      transactionId: string
      balanceCents: number
    }>
  }
}

Parameters

NameTypeRequiredNotes
workspaceId
string
YesWorkspace ID
input
CreditInput
YesCredit details (amountCents, reason?, metadata?)

Throws

  • NotFoundError
    — workspace not found

Examples

import { Client } from '@blueforge/client'

const bf = new Client({ apiKey: process.env.BF_API_KEY!, url: 'https://your-project.blueforge.dev' })

const { transactionId, balanceCents } = await bf.wallet.credit('ws_abc', { amountCents: 1000, reason: 'Promo credit' })

Pitfalls

  • Admin only — requires elevated credentials

See also

  • client.wallet.debit
  • client.wallet.getBalance

Tested against

  • Unit: 
    packages/client/src/__tests__/wallet.test.ts