Search payment options

GET https://app.ecwid.com/api/v3/{storeId}/profile/paymentOptions

Required access scopes

Your app must have the following access scopes to make this request: read_store_profile , add_payment_method

Path params

All path params are required.

Param	Type	Description
storeId	number	Ecwid store ID.

Query params

All query params are optional.

Name	Type	Description
lang	string	Language ISO code for translations in JSON response, e.g. en, fr. Translates fields like: title, description, pickupInstruction, text, etc.

Headers

The Authorization header is required.

Header	Format	Description
Authorization	Bearer secret_ab***cd	Access token of the application.

Response JSON

JSON array of objects with the following fields:

Field	Type	Description
id	string	Internal payment option ID.
enabled	boolean	true if payment option is enabled and visible at the checkout, false otherwise.
configured	boolean	Setup status of the payment option. If false, highlights payment methods with the red border.
checkoutTitle	string	Name visible to customers at the checkout above the payment option name.
checkoutTitleTranslated	object translations	Available translations for payment option title.
checkoutDescription	string	Payment method description visible under the payment option name at the checkout.
paymentProcessorId	string	Payment processor ID in Ecwid
paymentProcessorTitle	string	Payment processor title. The same as paymentModule in order details in REST API
orderBy	number	Payment method position at checkout and in Ecwid Control Panel. The smaller the number, the higher the position is
appClientId	string	client_id value of payment application. "" if not an application
paymentSurcharges	object paymentSurcharges	Payment method fee added to the order as a set amount or as a percentage of the order total
instructionsForCustomer	object instructionsForCustomer	Payment instructions visible to customers at the checkout.
shippingSettings	object shippingSettings	Limit payment option availability by the list of shipping methods selected at the checkout.

paymentSurcharges

Field	Type	Description
type	string	Surcharge type that defines how it applies to the payment. One of: ABSOLUTE PERCENT
value	number	Surcharge value.

instructionsForCustomer

Field	Type	Description
instructionsTitle	string	Name visible above the payment instructions block at the checkout.
instructions	string	Content inside the payment instructions block. Supports HTML tags.
instructionsTranslated	object translations	Available translations for payment instructions content. Supports HTML tags.

shippingSettings

Field	Type	Description
enabledShippingMethods	array of strings	List of shipping methods (internal shipping method IDs). If specified, the payment option is only available when customers select the specified shipping method at the checkout. It allows, for example, disabling online payments for pickup orders (leaving it available for deliveries).

translations

Object with text field translations in the "lang": "text" format, where the "lang" is an ISO 639-1 language code. For example:

{
    "en": "Sample text",
    "nl": "Voorbeeldtekst"
}

Translations are available for all active store languages. Only the default language translations are returned if no other translations are provided for the field. Find active store languages with GET /profile request > languages > enabledLanguages.