E-Payment Integrator 2020 PHP Edition

Questions / Feedback?

Level3 Class

Properties   Methods   Events   Configuration Settings   Errors  

The Level3 class is a tool used to create Level3 Corporate Purchasing Card aggregates, which can then be passed to the ICharge or Retail classes.

Class Name

InPay_Level3

Procedural Interface

 inpay_level3_open();
 inpay_level3_close($res);
 inpay_level3_register_callback($res, $id, $function);
 inpay_level3_get_last_error($res);
 inpay_level3_get_last_error_code($res);
 inpay_level3_set($res, $id, $index, $value);
 inpay_level3_get($res, $id, $index);
 inpay_level3_do_addspecialfield($res, $name, $value);
 inpay_level3_do_config($res, $configurationstring);
 inpay_level3_do_getaggregate($res);

Remarks

The available fields for each gateway supporting Level 3 data can be found below. Note: This list of fields does not designate what is required but rather only the fields made available by the gateway. For the required fields required to obtain the best rates, please consult your gateway for further information.

GatewayQuantityCommodityCodeNameDescriptionUnitsUnitCostProductCodeDiscountAmountDiscountRateTotalTaxableTaxAmountTaxRateTaxType
gwAuthorizeNet (1)XXXXXX
gwPayFlowPro (6)XXXXXXXXXXX
gwUSAePay (7)XXXXXXXXXXXX
gwPlugNPay (8)XXXXXXXX
gwMPCS (10)XXXXXX
gwRTWare (11)XXXXXX
gwECX (12)XXXXXX
gwBankOfAmerica (13)XXXXXXXXXXX
gw3DSI (18)XXXXXX
gwTrustCommerce (19)XXXXXXXX
gwPSIGate (20)XXXX
gwPayFuse (21)XXXXXXXXXXXXXX
gwOrbital (23)XXXXXXXXXXXXX
gwLinkPoint (24)XXXX
gwMoneris (25)XXXX
gwNetworkMerchants (28)XXXXXXXXXXXX
gwIngenico (29)XXXXXXX
gwFirstData (33)XXXX
gwYourPay (34)XXXX
gwCyberSource (37)XXXXXXXXXXX
gwGoEMerchant (39)XXXX
gwChase (41)XXXX
gwSterling (45)XXXXXXXXXXXX
gwMonerisUSA (52)XXXX
gwBambora (53)XXXX
gwVerifi (54)XXXXXXXXXXXX
gwLitle (63)XXXXXXXX
gwHSBC (66)XXXXXXXXXXXXXX
gwBluePay (67)XXXXXXXXXX
gwBarclay (69)XXXXXXX
gwPayTrace (70)XXXXXXXXXXX
gwTransNationalBankcard (74)XXXXXXXXXXXX
gwDataCash (77)XXXXXXXXX
gwFirstDataE4 (80)XXXXXXXXXXX
gwPayscape (83)XXXXXXXXXXXX
gwAuthorizeNetCIM (85)XXXXXX
gw5thDimension (86)XXXX
gwPaymentWorkSuite (88)XXXXXXXXX
gwPSIGateXML (89)XXXX
gwPayeezy (94)XXXXXXXXXXX
gwAmericanPaymentSolutions (105)XXXXXXXXXXXX

Property List


The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

LineItemCountThe number of records in the Item arrays.
ItemCommodityCodeCode indicating the type of goods or services sold.
ItemDescriptionDescription of the item.
ItemDiscountAmountAmount of the discount for each line item (if any).
ItemDiscountRateRate of the discount for each line item (if any).
ItemNameName of the item.
ItemProductCodeProduct code of the item purchased.
ItemQuantityQuantity of items in this Line Item.
ItemTaxableSpecifies whether the items in this Line Item are taxable.
ItemTaxAmountTax on this individual item.
ItemTaxRateTax rate used to calculate the TaxAmount .
ItemTaxTypeType of tax charged in TaxAmount .
ItemTotalTotal cost of this line item.
ItemUnitCostCost of each individual item.
ItemUnitsUnit of measure for this Line Item.
SpecialFieldCountThe number of records in the SpecialField arrays.
SpecialFieldNameName of special configuration property to submit in this transaction.
SpecialFieldValueValue of special configuration property to submit in this transaction.

Method List


The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

AddSpecialFieldAdds a special field name and the corresponding value.
ConfigSets or retrieves a configuration setting.
GetAggregateReturns an aggregate containing level 3 details for a transaction.

Event List


The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

ErrorInformation about errors during data delivery.

Configuration Settings


The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.

EscapeXMLAutomatically escape the data in the aggregate.
BuildInfoInformation about the product's build.
CodePageThe system code page used for Unicode to Multibyte translations.
LicenseInfoInformation about the current license.
ProcessIdleEventsWhether the class uses its internal event loop to process events when the main thread is idle.
SelectWaitMillisThe length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.
UseInternalSecurityAPITells the class whether or not to use the system security libraries or an internal implementation.

Copyright (c) 2021 /n software inc. - All rights reserved.
E-Payment Integrator 2020 PHP Edition - Version 20.0 [Build 7941]