DUduda
Payment Gateways

Update custom payment gateway

Updates the custom payment gateway with the given id. Accepts changes to its live and test payment methods endpoints, display name, description, image, icons, and management URL.

patch/api/sites/multiscreen/{site_name}/ecommerce/payment-gateways/{id}

Request

  • Base URL
    https://api.duda.co
  • URL
    https://api.duda.co/api/sites/multiscreen/{site_name}/ecommerce/payment-gateways/{id}
  • Auth
    HTTP basic

Path parameters

site_namestring required

The site's unique name (its ID), returned when the site is created.

idstring required

Request body

live_payment_methods_urlstring nullable
test_payment_methods_urlstring nullable
namestring nullable
descriptionstring nullable
imagestring nullable
iconsstring[] nullable
management_urlstring nullable

Response

OK

idstring

System identifier of the custom payment gateway

live_payment_methods_urlstring uri

The payment methods API endpoint that will be called to retrieve the available payment methods for the cart in LIVE mode

test_payment_methods_urlstring uri

The payment methods API endpoint that will be called to retrieve the available payment methods for the cart in TEST mode. This URL can be the same as live_payment_methods_url

namestring nullable

Display name visible to merchants in the dashboard of the payment gateway

descriptionstring nullable

Description visible to merchants in the dashboard of the payment gateway

imagestring nullable

Image URL representing the payment gateway visible in the merchant dashboard

iconsstring[] nullable

List of icons URLs representing the available payment methods for the payment gateway

management_urlstring nullable

URL defined by the payment gateway to redirect merchants on their platform

Changes

No recorded changes to this operation across all 1 revision of this API.