OrderPaymentInstrument Document (Shop API 15.2)

(supports custom properties)

Document representing an order payment instrument.

Property Type Constraints Description
amount Decimal   The amount for the payment transaction.
etag String   The etag to show the last update status.
payment_bank_account PaymentBankAccount   The payment bank account.
payment_card PaymentCard   Convenience property to transfer payment card information.
payment_method_id String maxLength=256 The payment method id. In case of the system payment method CREDIT_CARD the id is combined with a particular payment card type like "CREDIT_CARD.Visa". It is mandatory for creating a payment instrument.
uuid String   The payment instrument uuid.
OCAPI obsolete versions 13.x and 14.x will be end of life in 2020 and versions 15.x and 16.x in 2021. For dates and more information, see the OCAPI versioning and deprecation policy and this Knowledge Article.
X Privacy Update: We use cookies to make interactions with our websites and services easy and meaningful, to better understand how they are used. By continuing to use this site you are giving us your consent to do this. Privacy Policy.