OrderPaymentInstrument Document (Shop API 16.1)

(supports custom properties)

Document representing an order payment instrument.

Property Type Constraints Description
amount Decimal   The payment transaction amount.
bank_routing_number String maxLength=256 The bank routing number.
etag String   The etag to show the last update status.
masked_gift_certificate_code String   The masked gift certificate code.
payment_bank_account PaymentBankAccount   The payment bank account.
payment_card PaymentCard   The payment card.
payment_instrument_id String   The payment instrument ID.
payment_method_id String maxLength=256 The payment method id. Optional if a customer payment instrument id is specified.
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.