Paymentmethods

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

Read Payment Methods from Profile

Reads a list of the shopper’s payment instruments that can be used by the shopper for the current store.

Workflow

1. Start with profile
2. GET the link with rel: paymentmethods
3. Render the response

Read Payment Methods from Account

Reads a list of the shopper’s payment instruments that can be used by the shopper for the current store.

Workflow

1. Start with account
2. GET the link with rel: paymentmethods
3. Render the response

Read Payment Method

Reads a payment method from a list of payment methods.

Workflow

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

Response Fields

Type: elasticpath.paymentmethods.payment-method

Name	Description	Type
name	The payment method name.	string
display-name	The localized payment method name, intended for display in the client application.	string