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 Profile Payment Methods
Retrieve the available profile payment methods for a store.
Workflow
- Start with profile
GETthe link with rel: paymentmethods- Render the response
Read Profile Payment Method
Retrieve a shopper’s profile payment method for a store.
Workflow
- Start with profile-payment-methods
GETthe link with rel: element- Render the response
Response Fields
Type: 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 |
Read Order Payment Methods
Retrieve the available order payment methods for a store.
Workflow
- Start with order
GETthe link with rel: paymentmethodinfo- Render the response
Read Order Payment Method
Retrieve an order payment method for a store.
Workflow
- Start with order-payment-methods
GETthe link with rel: element- Render the response
Response Fields
Type: 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 |