OrderPaymentInstrument document (Shop API 20.9)

(supports custom properties)

Document representing an order payment instrument.

Property Type Constraints Description
amount Decimal   The payment transaction amount.
authorization_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     The payment bank account.
payment_card     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.

Infocenter Retirement: On June 30, 2023, the Infocenter was retired, and documentation currently hosted on the Infocenter will be published to Salesforce Help, Commerce Cloud Developer Center, and Salesforce B2C Commerce Developer Documentation Resources. For more information, see the release note.

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.