AddSpecialField Method

Adds a special field name and the corresponding value.

Syntax

• C++
• Objective-C
• C

ANSI (Cross Platform)
int AddSpecialField(const char* lpszName, const char* lpszValue);

Unicode (Windows)
INT AddSpecialField(LPCWSTR lpszName, LPCWSTR lpszValue);

- (void)addSpecialField:(NSString*)name :(NSString*)value;

#define MID_LEVEL3_ADDSPECIALFIELD 2

INPAY_EXTERNAL int INPAY_CALL InPay_Level3_Do(void *lpObj, int methid, int cparam, void *param[], int cbparam[], int64 *lpllVal);

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 LineItems. 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 LineItems 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 SpecialFieldName and SpecialFieldValue properties for more information on form variables and how they are managed.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)