Paymentmethods

The Payment Methods resource is responsible for the customer’s paymentmethods. This resource lists all the paymentmethods defined for the customer payment tokens. Selecting a payment method for a purchase is set during the purchase’s order phase.

Orders Paymentmethods Selector

Use a selector to select paymentmethod to use for the purchase. Follow the workflow to read the paymentmethodsinfo and then create a choice to select the paymentmethod to use for the purchase.

Workflow

1. Start with paymentmethod-info
2. GET the link with rel: selector
3. GET the link with rel: choice
4. GET the link with rel: chosen
5. GET the link with rel: description
6. POST the choice using the link with rel: selectaction

Read Order Payment Method

Read the payment method currently selected for the order.

Workflow

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

Response Fields

Type: elasticpath.paymentmethods.payment-token

Name	Description	Type
display-name	A description of the payment token to be used for display purposes.	string
token	The payment token created by a payment tokenization service.	string

Read Paymentmethod Needinfo From Order

Read payment-needinfo from order. When a paymentmethod needinfo is on the order, it means the payment method has not been selected for the purchase. Follow the workflow to read the needinfo.

Workflow

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

Response Fields

Type: elasticpath.controls.info

Name	Description	Type
name	The info object’s name.	string

Read Paymentmethod Needinfo From Purchaseform

Read payment needinfo from the purchase form. When a payment method needinfo is on the purchase form, it means the payment method has not been selected for the purchase. Follow the workflow to read the needinfo.

Workflow

1. Start with create-purchase-form
2. GET the link with rel: needinfo
3. Render the response

Response Fields

Type: elasticpath.controls.info

Name	Description	Type
name	The info object’s name.	string

Read Customer Payment Methods

Read the list of available customer payment methods.

Workflow

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

Read Customer Payment Method

Read a payment method from the list of available customer payment methods.

Workflow

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

Response Fields

Type: elasticpath.paymentmethods.payment-token

Name	Description	Type
display-name	A description of the payment token to be used for display purposes.	string
token	The payment token created by a payment tokenization service.	string

Read Default Payment Method

Read the customer’s default payment method. The default payment method is the first payment method the customer created.

Workflow

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

Response Fields

Type: elasticpath.paymentmethods.payment-token

Name	Description	Type
display-name	A description of the payment token to be used for display purposes.	string
token	The payment token created by a payment tokenization service.	string

Delete Payment Method

Delete a payment method from a shopper’s profile. If you delete a payment method that has already been selected for an order, that payment method will be deleted from the profile but not from the order. The payment method will remain selected on the order until that order is purchased.

Workflow

1. Start with paymentmethods
2. GET the link with rel: element
3. DELETE paymentmethod