View as Markdown
Shopwaive icon

Shopwaive ACTION

Set Available Balance

Updates the available balance of a customer to an exact value. See the documentation
  • Action
  • Writes data
  • Destructive
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Shopwaive account once, then configure and run Set Available Balance from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "shopwaive-set-available-balance",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    shopwaive: { authProvisionId: "apn_xxxxxxx" },
    customerEmail: "Customer Email",
    balance: 10,
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Set Available Balance inputs
Property Type Description
customerEmail Customer Email string
The email address of the customer
Required
balance New Balance integer
Value to assign to the customer's available balance
Required
note Note string
Description of the transaction
Required

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
shopwaive-set-available-balance
Version
0.0.2
App
Shopwaive
Authentication
API key
Read-only
No
Destructive
Yes
Open world
Yes