View as Markdown
SureCart icon

SureCart ACTION

Create Refund

Create a new refund for a charge. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's SureCart account once, then configure and run Create Refund 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: "surecart-create-refund",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    surecart: { authProvisionId: "apn_xxxxxxx" },
    amount: 10,
    reason: "Reason",
  },
})

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.

Create Refund inputs
Property Type Description
amount Amount integer
Amount to refund in cents. Example: 9900 for $99.00
Required
reason Reason string
Reason for the refund.
Required
charge Charge ID string
UUID of the charge to refund. Example: ch_abc123
Required
returnRequest Return Request ID string
UUID of an associated return request. Use List Return Requests to find return request IDs. Example: rr_abc123
Optional
refundItems Refund Items string
Line items to refund. Each item: { "line_item": "li_abc123", "quantity": 1, "restock": true, "revoke_purchase": false }
Optional
updateReferralCommission Update Referral Commission boolean
Reduce referral commission proportionally based on the refund ratio.
Optional
metadata Metadata object
Additional key-value metadata to attach to the refund. Example: { "order_ref": "ORD-001" }
Optional

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
surecart-create-refund
Version
0.0.3
App
SureCart
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes