bookmark_borderForm Data

Introduction

Form Data ($form_data) is an associative array containing the payment related properties for the entry being processed by the Authorize.net add-on which extends the GFPaymentAddOn class. It is populated using the values from the Submission Data generated during form validation.

Usage

We recommend accessing the properties in $form_data using the rgar() function e.g.

$form_data = rgar( $submission_data, 'payment_amount' );

Properties

  • form_title string

    The form title.

  • email string

    The value of the field which was mapped to the billing information Email field.

  • address1 string

    The value of the field which was mapped to the billing information Address field.

  • address2 string

    The value of the field which was mapped to the billing information Address 2 field.

  • city string

    The value of the field which was mapped to the billing information City field.

  • state string

    The value of the field which was mapped to the billing information State field.

  • zip string

    The value of the field which was mapped to the billing information Zip field.

  • country string

    The value of the field which was mapped to the billing information Country field.

  • first_name string

    The Credit Card cardholder first name.

  • last_name string

    The Credit Card cardholder last name.

  • amount float

    Either the form total or the value of the field mapped to the feeds payment amount or recurring amount setting.

  • fee_amount integer

    Zero or the value of the field mapped to the setup fee setting.

  • line_items array

    An indexed array of line items with unit prices greater than or equal to zero. Created from the submitted pricing fields. See Line Item for available properties.

Line Item

array(
	'item_id'          => 1,
	'item_name'        => 'Product A',
	'item_description' => '',
	'item_quantity'    => '1',
	'item_unit_price'  => 10,
	'item_taxable'     => 'Y',
)

Each line item is an associative array containing the following properties.

  • item_id integer

    The field ID.

  • item_name string

    The product name or shipping name.

  • item_description string

    Comma separated string of selected option names.

  • item_quantity integer

    The quantity.

  • item_unit_price float

    The total unit price for the product and any selected options or the shipping price.

  • item_taxable string

    Is the line item taxable? Default is Y.

Hooks

The Form Data can be modified by using the gform_authorizenet_form_data filter.