Get information about store payment options: settings, availability, titles, etc. The same content is provided in Get store profile -> Payment -> paymentOptions
Headers
Name
Type
Description
Authorization
string
oAuth token with mandatory Bearer before it. Example: Bearer e***s0, where e***s0 should be replaced with your oAuth token.
Response
A JSON array with elements of type 'PaymentOptionInfo' with the following fields:
PaymentOptionInfo
Field
Type
Description
id
string
Payment method ID in a store
enabled
boolean
true if payment method is enabled and shown in storefront, false otherwise
configured
boolean
Contains the payment method setup status. Read-only for in-built payment methods (where "appClientId": ""). Can be set for payment applications and will affect the payment method list in a store dashboard, see https://ecwid.d.pr/i/FpeCIb.
checkoutTitle
string
Payment method title at checkout
checkoutTitleTranslated
<Translations>
Available translations for payment option title.
checkoutDescription
string
Payment method description at checkout (subtitle)
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
<PaymentSurcharges>
Payment method fee added to the order as a set amount or as a percentage of the order total
instructionsForCustomer
<InstructionsForCustomerInfo>
Customer instructions details
shippingSettings
<ShippingSettingsInfo>
Shipping settings of the payment option
PaymentSurcharges
Field
Type
Description
type
string
Supported values: ABSOLUTE, PERCENT
value
number
Surcharge value
InstructionsForCustomerInfo
Field
Type
Description
instructionsTitle
string
Payment instructions title
instructions
string
Payment instructions content. Can contain HTML tags
instructionsTranslated
<Translations>
Available translations for instructions.
ShippingSettings
Field
Type
Description
enabledShippingMethods
Array of string
Contains IDs of shipping methods, if payment method is available for certain shipping methods only ("Payment Per Shipping" feature)
Translations
Field
Type
Description
<ISO_LANG_CODE>
string
Translations for each available language. If no other translations are provided, the default language translations is returned. See available languages in store language settings
Language
Click Try It! to start a request and see the response here!
