OrderPaymentInstrument document (Shop API 19.3)

(supports custom properties)

Document representing an order payment instrument.

Property Type Constraints Description
amount Decimal   The payment transaction amount.
authorization_status Status   The authorization status of the payment transaction.
bank_routing_number String maxLength=256 The bank routing number.
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.