Action shop:payment_profile

shop:payment_profile CMS action

Defined in	/modules/shop/classes/shop_actions.php, lines 2442-2458
Author	LemonStand eCommerce Inc.

Base action for the Payment Profile page. The payment profile page expects the payment method identifier to be specified in the first URL segment.

Supported form fields

Field	Type	Description
submit_profile	string	a name for the submit button for saving the payment profile.
delete_profile	string	a name for the submit button for deleting the payment profile.

Generated PHP variables

Variable	Type	Description
payment_method	Shop_PaymentMethod	the payment method object.
payment_method_obj	Shop_PaymentType	an instance of a specific payment method class.
payment_profile	Shop_CustomerPaymentProfile	a payment profile object.

Built-in AJAX handlers

Handler	Description
shop:on_updatePaymentProfile	Updates (or creates) the payment profile.
shop:on_deletePaymentProfile	Deletes the payment profile.

Supported form field details

¶ submit_profile form field

A name for the submit button for saving the payment profile. The Save submit button should have name submit_profile if you are implementing a regular POST form. Alternatively you can use the shop:on_updatePaymentProfile handler.

¶ delete_profile form field

A name for the submit button for deleting the payment profile. The Delete submit button should have name delete_profile if you are implementing a regular POST form. Alternatively you can use the shop:on_deletePaymentProfile handler.

Generated PHP variable details

¶ payment_method variable

Shop_PaymentMethod $payment_method;

The payment method object. This variable can be empty if the payment method not found.

¶ payment_method_obj variable

Shop_PaymentType $payment_method_obj;

An instance of a specific payment method class. Call the render_payment_profile_form() method of this object to render the payment profile form.

¶ payment_profile variable

Shop_CustomerPaymentProfile $payment_profile;

A payment profile object If the profile does not exist, this variable has NULL value.

LemonStand API