QuickBooks: Create a paymentmethod

← paymentmethod operations · Get started · OpenAPI downloads

Contract 2026-10-20 · Operation quickbooks.paymentmethod.create_a_paymentmethod

Provider route: POST /v3/company/{realmID}/paymentmethod. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/quickbooks with npm, or alter-sdk-quickbooks with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { QuickBooksIntegration } from "@alter-ai/quickbooks";

async function execute(input: Parameters<QuickBooksIntegration["paymentmethod"]["create"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new QuickBooksIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.paymentmethod.create(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_quickbooks import QuickBooksIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = QuickBooksIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.paymentmethod.create(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
query	object	Optional	Additional keys: not allowed
query.minorversion	integer	Optional	Must equal: 75
query.requestid	string	Optional	Minimum length: 1
body	object	Required within parent	Fields not accepted: Id, SyncToken Additional keys: not allowed
body.Active	JSON	Optional	If true, this entity is currently enabled for use by QuickBooks.
body.Active (anyOf 1)	boolean	Alternative
body.Active (anyOf 2)	string	Alternative	One of: true, false
body.MetaData	Model	Optional	Expand Read a bill — response body — Bill Meta Data Descriptive information about the object. The MetaData values are set by Data Services and are read only for all applications.
body.Name	string	Required within parent	User recognizable name for the payment method.
body.Type	string	Optional	Defines the type of payment. Valid values include CREDIT_CARD or NON_CREDIT_CARD .
body.domain	string	Optional
body.sparse	boolean	Optional

Referenced models: Read a bill — response body — Bill Meta Data

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: allowed
time	string	Optional
PaymentMethod	Model	Optional	Expand Read a paymentmethod — response body — Payment Method

Referenced models: Read a paymentmethod — response body — Payment Method

Policy, approvals and errors

SDK function policy ID: quickbooks.paymentmethod.create_a_paymentmethod. Catalog operation: paymentmethod/create_a_paymentmethod. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Official provider source