Update Payment Settings

Sets a custom fee structure for a product. Requires the stores.products.update permission.

PUT /stores/{storeId}/products/{productId}/payment

Update payment settings

cURL

curl --request PUT \
  --url https://api.komerza.com/stores/{storeId}/products/{productId}/payment \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "blacklistedPaymentGateways": [
    "<string>"
  ],
  "additionalFees": {},
  "additionalFixedFees": {}
}
'

200

{
  "success": true,
  "message": "<string>",
  "code": "<string>",
  "data": "<unknown>"
}

Authorizations

Authorization · string · header · required

Your API key goes here

Path Parameters

storeId · string<uuid> · required

The ID of the store.

productId · string<uuid> · required

The ID of the product.

Body

application/json

The Komerza.Common.Forms.Products.ProductPaymentForm with fee details.

Form for updating product payment information

blacklistedPaymentGateways · string[] · required

The array of blocklisted payment methods for the specific product must be a valid Komerza payment method ID

additionalFees · object · required

The list of payment method fees, Payment Method -> Fee percentage

Show child attributes

additionalFixedFees · object · required

The list of fixed payment method fees, Payment Method -> Fixed fee amount

Show child attributes

Response

200

application/json

The object was successfully updated.

Represents a default generic response for API endpoints.

success · boolean · required

Indicates whether the operation or response was successful.

message · string | null

A descriptive message providing additional context or information about the response.

code · string | null

The error code (if there was an error) to use when referencing the error

data · any | null

Represents the data associated with a response.