Shopware icon

Shopware

Shopware

Actions778

App Payment Method → Create App Payment Method

AI-generated

Overview

This node operation creates a new App Payment Method in the Shopware system. It is useful for integrating custom payment methods into an app, allowing users to define various URLs and identifiers related to the payment process, such as pay, finalize, validate, capture, refund, and recurring URLs. This operation is beneficial for developers who want to automate the creation and management of payment methods within their Shopware apps.

Use Case Examples

  1. Creating a new payment method for an app with specific URLs for payment processing and validation.
  2. Automating the setup of app payment methods with identifiers and media references for seamless integration.

Properties

Name Meaning
Response Data format for the response, either basic or detailed.
Id Unique identifier for the app payment method.
App Name Name of the app associated with the payment method.
Identifier Identifier for the payment method.
Pay Url URL to initiate the payment process.
Finalize Url URL to finalize the payment process.
Validate Url URL to validate the payment.
Capture Url URL to capture the payment.
Refund Url URL to refund the payment.
Recurring Url URL for recurring payments.
App Id Identifier of the app.
Original Media Id Identifier for the original media associated with the payment method.
Payment Method Id Identifier for the payment method.
Created At Timestamp when the payment method was created.
Updated At Timestamp when the payment method was last updated.
App JSON object representing the app details associated with the payment method.
Original Media JSON object representing the original media details associated with the payment method.
Payment Method JSON object representing the payment method details.

Output

JSON

  • id - Unique identifier of the created app payment method.
  • appName - Name of the app associated with the payment method.
  • identifier - Identifier of the payment method.
  • payUrl - URL to initiate the payment process.
  • finalizeUrl - URL to finalize the payment process.
  • validateUrl - URL to validate the payment.
  • captureUrl - URL to capture the payment.
  • refundUrl - URL to refund the payment.
  • recurringUrl - URL for recurring payments.
  • appId - Identifier of the app.
  • originalMediaId - Identifier for the original media associated with the payment method.
  • paymentMethodId - Identifier for the payment method.
  • createdAt - Timestamp when the payment method was created.
  • updatedAt - Timestamp when the payment method was last updated.
  • app - JSON object representing the app details associated with the payment method.
  • originalMedia - JSON object representing the original media details associated with the payment method.
  • paymentMethod - JSON object representing the payment method details.

Troubleshooting

  • Ensure all required fields (Id, App Name, Identifier, Payment Method Id) are provided to avoid validation errors.
  • Verify that JSON fields (App, Original Media, Payment Method) are correctly formatted to prevent parsing errors.
  • Check network connectivity and API credentials if the request to create the payment method fails.

Discussion