CustomerPaymentInstrumentRequest document (Shop API 20.3)

(supports custom properties)

Document representing a customer payment instrument request.

Property Type Constraints Description
bank_routing_number String maxLength=256 The bank routing number.
gift_certificate_code String maxLength=256 The gift certificate code.
payment_bank_account PaymentBankAccountRequest   The payment bank account request data.
payment_card CustomerPaymentCardRequest   The customer payment card.
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.