Shopware icon

Shopware

Shopware

Actions778

Payment Method → Create Payment Method

AI-generated

Overview

This node operation allows users to create a new Payment Method in the Shopware system. It is useful for automating the addition of payment methods with detailed configurations such as plugin information, handler identifiers, availability rules, sales channel assignments, and custom fields. For example, an e-commerce platform administrator can use this node to programmatically add a new payment method with specific settings and availability conditions.

Use Case Examples

  1. Create a new payment method with a unique ID, name, and plugin association.
  2. Set availability rules and sales channel assignments for the payment method to control where and how it is available.
  3. Include custom fields and media attachments to enrich the payment method's metadata.

Properties

Name Meaning
Response Data format for response, either basic or detailed.
Id Unique identifier for the payment method (required).
Plugin Id Identifier of the plugin associated with the payment method.
Handler Identifier Identifier for the payment handler.
Name Name of the payment method (required).
Distinguishable Name A distinguishable name for the payment method.
Description Description of the payment method.
Position Position or order of the payment method.
Active Whether the payment method is active.
After Order Enabled Whether the payment method is enabled after order placement.
Custom Fields Custom fields as JSON object for additional data.
Availability Rule Id Identifier for the availability rule.
Media Id Identifier for associated media.
Formatted Handler Identifier Runtime field for formatted handler identifier, not used in criteria.
Synchronous Runtime field indicating if the payment method is synchronous, not used in criteria.
Asynchronous Runtime field indicating if the payment method is asynchronous, not used in criteria.
Prepared Runtime field indicating if the payment method is prepared, not used in criteria.
Refundable Runtime field indicating if the payment method is refundable, not used in criteria.
Recurring Runtime field indicating if the payment method supports recurring payments, not used in criteria.
Short Name Runtime field for short name, not used in criteria.
Technical Name Technical name of the payment method.
Created At Creation timestamp of the payment method.
Updated At Last update timestamp of the payment method.
Translated Translated fields as JSON object.
Media Media information as JSON object.
Availability Rule Availability rule details as JSON object.
Sales Channel Default Assignments Sales channel default assignments as JSON array.
Plugin Plugin details as JSON object.
Customers Customer details as JSON array.
Order Transactions Order transaction details as JSON array.
Sales Channels Sales channel details as JSON array.
App Payment Method App payment method details as JSON object.

Output

JSON

  • id - Unique identifier of the created payment method.
  • name - Name of the created payment method.
  • active - Indicates if the payment method is active.
  • pluginId - Identifier of the associated plugin.
  • handlerIdentifier - Identifier for the payment handler.
  • description - Description of the payment method.
  • position - Position or order of the payment method.
  • customFields - Custom fields associated with the payment method.
  • availabilityRuleId - Identifier for the availability rule.
  • mediaId - Identifier for associated media.
  • createdAt - Creation timestamp of the payment method.
  • updatedAt - Last update timestamp of the payment method.

Dependencies

  • An API key credential for Shopware Admin API

Troubleshooting

  • Ensure required fields 'Id' and 'Name' are provided to avoid validation errors.
  • Check JSON formatting for fields like 'customFields', 'translated', 'media', 'availabilityRule', 'salesChannelDefaultAssignments', 'plugin', 'customers', 'orderTransactions', 'salesChannels', and 'appPaymentMethod' to prevent parsing errors.
  • Verify API credentials and base URL configuration to avoid authentication or connection issues.

Discussion