Update an existing payment option referring to its ID.
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.
Request
Field
Type
Description
enabled
boolean
true to enable payment option to customers at checkout. 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 option title at checkout
checkoutDescription
string
Payment option description at checkout
paymentSurcharges
<PaymentSurcharges>
Payment method fee added to the order as a set amount or as a percentage of the order total
instructionsForCustomer
<InstructionsForCustomer>
Text instructions for customers
PaymentSurcharges
Field
Type
Description
type
string
Supported values: ABSOLUTE, PERCENT
value
number
Surcharge value
InstructionsForCustomer
Field
Type
Description
instructionsTitle
string
Instruction title
instructions
string
Text of the instructions
Response
A JSON object of type 'UpdateStatus' with the following fields:
UpdateStatus
Field
Type
Description
updateCount
number
The number of updated options (1 or 0 depending on whether the update was successful)
Errors
In case of error, Ecwid responds with an error HTTP status code and, optionally, JSON-formatted body containing error description
HTTP codes
HTTP Status
Description
Code (optional)
400
Request parameters are malformed
402
The functionality/method is not available on the merchant plan
403
Access token doesn't have update_store_profile scope
415
Unsupported content-type: expected application/json or text/json
Error response body (optional)
Field
Type
Description
errorMessage
string
Error message
errorCode
string
Error code
Language
Click Try It! to start a request and see the response here!
