Paymentinstructions

Payment instructions provide the necessary creation details for defining valid payment instruments for corresponding third-party payment providers.

Read Order Request Instructions Form

Provides the form to request payment instructions for a third-party payment provider.

Workflow

1. Start with order payment method
2. GET the link with rel: requestinstructionsform
3. Render the response

Response Fields

Type: elasticpath.paymentinstructions.payment-method-configuration

Name	Description	Type
billing-address	The billing address information used during the payment instrument creation process.	object
name	The customer name.	object
given-name	The person’s given name.	string
family-name	The person’s family name.	string
address	The customer address. Address field names are based on the v.card specification. For more information on this specification, see v.card.	object
street-address	Street address line 1.	string
street-address-2	Street address line 2. This field is optional.	string
street-address-3	Street address line 3. This field is optional.	string
locality	The city name.	string
region	The region name. A region typically corresponds to a province or a state of a country.	string
postal-code	The postal code or zip code.	string
country-name	The country name.	string
phone-number	The phone number.	string
organization	The organization.	string

Request Order Payment Instructions

Provide the form to a third-party payment provider to request payment instructions.

Workflow

1. Start with order payment method
2. GET the link with rel: requestinstructionsform
3. Fill out the form
4. POST the form using the link with rel: requestpaymentinstructionsaction

Request Fields

Type: elasticpath.paymentinstructions.payment-method-configuration

Name	Description	Type
billing-address	The billing address information used during the payment instrument creation process.	object
name	The customer name.	object
given-name	The person’s given name.	string
family-name	The person’s family name.	string
address	The customer address. Address field names are based on the v.card specification. For more information on this specification, see v.card.	object
street-address	Street address line 1.	string
street-address-2	Street address line 2. This field is optional.	string
street-address-3	Street address line 3. This field is optional.	string
locality	The city name.	string
region	The region name. A region typically corresponds to a province or a state of a country.	string
postal-code	The postal code or zip code.	string
country-name	The country name.	string
phone-number	The phone number.	string
organization	The organization.	string