Skip to main content
Version: 8.4.x

Paymentmethods

The payment mechanism selected to create the customer’s payment instrument, such as a credit card or PayPal. To submit a payment, create one or more payment instruments. Each payment instrument must correspond to a chosen payment method.

Read Order Payment Methods​

Retrieve the available order payment methods for a store.

Workflow​

  1. Start with order
  2. GET the link with rel: paymentmethodinfo
  3. Render the response

Read Order Payment Method​

Retrieve an order payment method for a store.

Workflow​

  1. Start with order payment methods
  2. GET the link with rel: element
  3. Render the response

Response Fields​

Type: paymentmethods.payment-method​

NameDescriptionType
nameThe payment method name.string
display-nameThe localized payment method name, intended for display in the client application.string