add_special_field Method

Adds a special field name and the corresponding value.

Syntax

def add_special_field(name: str, value: str) -> None: ...

Remarks

This method allows for specifying special fields for level 3 details at a transaction as well as a line item level. Typically level 3 details pertain to item details, however some gateways expose fields that are not item specific. This method allows you to specify these fields. Additionally you can specify item specific fields that aren't exposed via line_items. Please consult the gateways specifications to obtain available fields and their format.

Gateways implemented using XML may require the elements to be split into their own line item elements. In such a case, the specified Name value can be specified in the form "[index]:[name]" (where 'index' is the line_items index and 'name' is the name of the element you wish to add). The component will then parse the format and place line item data within the correct element in the request.

The following gateways are implemented using XML and support indexed special field values:

• gwBankOfAmerica (13)
• gwOrbital (23)
• gwSterling (45)
• gwLitle (63)
• gwPayTrace (70)
• gwDataCash (77)
• gwFirstDataE4 (80)

Please refer to the special_field_name and special_field_value properties for more information on form variables and how they are managed.