PaymentMethod document (Shop API 23.2)
(supports custom properties)
Document representing a payment method.
| Property | Type | Constraints | Description |
|---|---|---|---|
cards |
[PaymentCardSpec] | The sorted array of payment cards (included only when the system payment method is CREDIT_CARD). | |
description |
Localized<String> | The localized description of the payment method or card. | |
id |
String | mandatory=true, maxLength=256, nullable=false | The id of the payment method or card. |
image |
String | The URL to the image that represents the payment method or card. | |
name |
Localized<String> | The localized name of the payment method or card. | |
payment_processor_id |
String | The payment processor ID. |
X
OCAPI versions 15.x and 16.x will be retired on March 31, 2021. For dates and more information, see the OCAPI versioning and deprecation policy and this Knowledge Article.
