ICharge Class
Properties Methods Events Config Settings Errors
The ICharge class is used to authorize credit card transactions with any of the supported Internet Payment Gateways.
Syntax
class inpay.ICharge
Remarks
The ICharge class allows you to use multiple Internet Payment Gateways through one interface and one class. This allows for easy migration from one gateway to another, as well as quick integration into applications or web services.
The ICharge class allows your website to securely perform credit card transactions without the need to redirect to a third-party site. All transactions are accomplished through a secure HTTPS Post to any supported gateway. The secure response is received and then stored in the class's response properties. Any web site on a standard HTTP server or any stand-alone application can process transactions without the need for a secure server or third-party intervention.
The first thing you must do is select one of the many gateways supported by the ICharge class, and set up an account with that gateway vendor. Once you have an account set up with a valid (or test) login Id and password, you can use the ICharge class.
To begin, set the gateway property to the gateway you wish to use. If this gateway supports an alternate URL to send test transactions to, set the gateway_url at this time.
Next, set the merchant_login (and for some gateways the merchant_password). These are supplied by your gateway vendor when you set up an account.
Now you are ready to process transactions. For each transaction, you must set the card_number, card_exp_month, card_exp_year, and transaction_amount properties. Most gateways will also require additional properties, such as customer_address, customer_first_name, customer_last_name, invoice_number, etc. Any additional required properties are listed in the gateway property description.
Once these properties are set, you may run validity checks on the card data with the avs_only method, or simply authorize the transaction with the sale method. If your gateway supports it, you may also Void transactions that have not yet gone to settlement with the void_transaction method. Transactions that have already been settled may be refunded with the credit method. Please note that some gateways use the credit method for both voids and credits. See the transaction methods for more information.
The following gateways are supported by the ICharge class:
| Gateway | Home page |
| No Gateway (0) | n/a |
| Authorize.Net AIM (1) | http://www.authorize.net |
| eProcessing Transparent Database Engine (2) | http://www.eProcessingNetwork.com |
| Intellipay ExpertLink (3) | http://www.intellipay.com |
| iTransact RediCharge HTML (4) | http://www.itransact.com |
| NetBilling DirectMode (5) | http://www.netbilling.com |
| PayFlow Pro (6) | https://www.paypal.com/webapps/mpp/payflow-payment-gateway |
| USA ePay CGI Transaction Gateway (7) | http://www.usaepay.com |
| Plug 'n Pay (8) | http://www.plugnpay.com |
| Planet Payment iPay (9) | http://planetpayment.com/ |
| MPCS (10) | http://merchantcommerce.net/ |
| RTWare (11) | http://www.rtware.net/ |
| ECX (12) | http://www.ecx.com |
| Bank of America (Global Gateway e4) (13) | http://bankofamerica.com/merchantservices |
| Innovative Gateway (PHP) (14) | http://www.innovativegateway.com |
| Merchant Anywhere (Transaction Central Classic) (15) | http://www.merchantanywhere.com/ |
| SkipJack (16) | http://www.skipjack.com |
| 3 Delta Systems (3DSI) EC-Linx (18) | http://www.3dsi.com |
| TrustCommerce API (19) | http://www.trustcommerce.com |
| PSIGate HTML (20) | http://www.psigate.com |
| PayFuse XML (ClearCommerce Engine) (21) | http://www.firstnationalmerchants.com/ |
| PayFlow Link (22) | https://www.paypal.com/webapps/mpp/payflow-payment-gateway |
| Chase Paymentech Orbital Gateway (23) | https://merchantservices.chase.com/ |
| LinkPoint (24) | http://www.linkpoint.com |
| Moneris eSelect Plus Canada (25) | http://www.moneris.com |
| uSight Gateway Post-Auth (26) | This gateway is no longer in service. |
| Fast Transact VeloCT (Direct Mode) (27) | http://www.fasttransact.com/ |
| NetworkMerchants Direct-Post API (28) | http://www.nmi.com/ |
| Ingenico DirectLink / Ogone (29) | https://www.ingenico.be/ |
| TransFirst Transaction Central Classic (formerly PRIGate) (30) | http://www.transfirst.com |
| Merchant Partners (Transaction Engine) (31) | http://www.merchantpartners.com/ |
| CyberCash (32) | https://www.paypal.com/cybercash |
| First Data Global Gateway (Linkpoint) (33) | http://www.firstdata.com |
| YourPay (Linkpoint) (34) | http://www.yourpay.com |
| ACH Payments AGI (35) | http://www.ach-payments.com |
| Forte AGI / Payments Gateway AGI(36) | https://www.forte.net/ |
| Cyber Source SOAP API (37) | http://www.cybersource.com |
| eWay XML API (Australia) (38) | http://www.eway.com.au/ |
| goEmerchant XML (39) | http://www.goemerchant.com/ |
| TransFirst eLink (40) | http://www.transfirst.com |
| Chase Merchant Services (Linkpoint) (41) | http://www.chase.com |
| Thompson Merchant Services NexCommerce (iTransact mode) (42) | http://www.thompsonmerchant.com |
| WorldPay Select Junior Invisible (43) | http://www.worldpay.com |
| TransFirst Transaction Central Classic (44) | http://www.transfirst.com. (This is different from TransFirst eLink, supported above. The TransactionCentral gateway is also used by MerchantAnywhere and PRIGate) |
| Sterling SPOT XML API (HTTPS POST) (45) | http://www.sterlingpayment.com |
| PayJunction Trinity Gateway (46) | http://www.payjunction.com |
| SECPay (United Kingdom) API Solution(47) | http://www.secpay.com |
| Payment Express PXPost (48) | http://www.paymentexpress.com |
| Elavon/NOVA/My Virtual Merchant (49) | https://support.convergepay.com/s/ |
| Sage Payment Solutions (Bankcard HTTPS Post protocol) (50) | http://www.sagepayments.com |
| SecurePay (Script API/COM Object Interface) (51) | http://securepay.com |
| Moneris eSelect Plus USA (52) | http://www.moneris.com |
| Bambora / Beanstream Process Transaction API (53) | https://www.bambora.com/en/ca/ |
| Verifi Direct-Post API (54) | http://www.verifi.com |
| SagePay Direct (Previously Protx) (55) | https://www.opayo.uk/ |
| Merchant E-Solutions Payment Gateway (Trident API) (56) | http://merchante-solutions.com/ |
| PayLeap Web Services API (57) | http://www.payleap.com |
| PayPoint.net (Previously SECPay) API Solution (58) | http://paypoint.net |
| Worldpay XML (Direct/Invisible) (59) | http://www.worldpay.com |
| ProPay Merchant Services API (60) | http://www.propay.com |
| Intuit QuickBooks Merchant Services (QBMS) (61) | This gateway is no longer in service. It has been replaced by Quickbooks Payments (113). |
| Heartland POS Gateway (62) | http://www.heartlandpaymentsystems.com/ |
| Litle / Vantiv Online Gateway (63) | http://www.litle.com/ |
| BrainTree DirectPost (Server-to-Server Orange) Gateway (64) | http://www.braintreepaymentsolutions.com/ |
| JetPay Gateway (65) | http://www.jetpay.com/ |
| HSBC XML API (ClearCommerce Engine) (66) | https://www.business.hsbc.uk/en-gb/payments/business-card |
| BluePay 2.0 Post (67) | http://www.bluepay.com |
| Adyen API Payments (68) | http://www.adyen.com |
| Barclay ePDQ (DirectLink) (69) | http://www.barclaycard.co.uk/business/ |
| PayTrace Payment Gateway (70) | https://www.paytrace.net/ |
| YKC Gateway (71) | http://www.ykc-bos.co.jp/ |
| OmniFund HTTP API / GoToBilling(73) | http://omnifund.com/ |
| TransNational Bankcard (74) | http://www.tnbci.com/ |
| Netbanx (75) | http://www.netbanx.com/ |
| MIT (76) | http://www.centrodepagos.com.mx |
| DataCash (77) | http://www.datacash.com/ |
| ACH Federal (78) | http://www.achfederal.com/ |
| Global Iris (HSBC) (79) | https://www.globalpaymentsinc.com/en-gb |
| First Data Global Gateway E4 (80) | http://www.firstdata.com |
| First Atlantic Commerce (81) | http://www.firstatlanticcommerce.com/ |
| Bluefin (82) | http://www.bluefin.com/ |
| Payscape (83) | http://www.payscape.com |
| Pay Direct (Link2Gov) (84) | https://www.fisglobal.com/solutions/other/government/ |
| Authorize.NET CIM (85) | http://www.authorize.net |
| 5th Dimension Logistics (86) | http://www.5thdl.com/ |
| WorldPay US Link Gateway (87) | https://www.worldpay.com/en-us/index |
| 3DSI Payment WorkSuite (88) | http://www.3dsi.com/ |
| PSIGate XML (89) | http://www.psigate.com |
| First Data PayPoint (90) | https://www.firstdata.com/en_us/products/financial_institutions.html |
| ExPay Gateway (91) | http://www.expay.asia |
| Payvision Gateway (92) | http://www.payvision.com/ |
| Converge (formerly MyVirtualMerchant) (93) | https://support.convergepay.com/s/ |
| Payeezy Gateway (formerly First Data E4) (94) | https://developer.payeezy.com/ |
| Monetra Gateway (95) | http://www.monetra.com |
| Authorize.NET XML (96) | http://www.authorize.net/ |
| PhoeniXGate Gateway (97) | http://www.phoenixmanagednetworks.com/ |
| Repay Gateway (98) | https://www.repay.com/ |
| Global Payroll Gateway (99) | https://www.gpgway.com/ |
| PayWiser Gateway (100) | https://paywiser.eu/ |
| Veritas Gateway (101) | http://www.veritaspay.com/ |
| Stripe Gateway (102) | http://www.stripe.com/ |
| KartePay Gateway (103) | https://www.kartepay.com/ |
| BlueSnap Gateway (104) | https://home.bluesnap.com/ |
| American Payment Solutions (105) | https://www.apspayments.com/ |
| BASYS Gateway (106) | https://basyspro.com/ |
| Worldpay Online (107) | https://www.worldpay.com |
| Square (108) | https://www.squareup.com |
| Priority Payment Systems (109) | https://prioritypaymentsystems.com |
| Nuvei / GlobalOnePay (110) | https://nuvei.com/en-us/ |
| CardPointe (111) | https://cardconnect.com/cardpointe |
| Metrobank (112) | https://www.metrobankcard.com/ |
| Quickbooks Payments (113) | https://quickbooks.intuit.com/payments/ |
| Shift4 (114) | https://www.shift4.com/ |
| Square Payments (115) | https://squareup.com/us/en |
| Heartland Portico Gateway (116) | http://www.heartlandpaymentsystems.com/ |
| PayTrace Payment Gateway JSON (117) | https://www.paytrace.net/ |
Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
| auth_code | Authorization code from a previous transaction. |
| card_aggregate | This property allows you to get or set an XML aggregate built from all of the Card properties. |
| card_type | Type of credit card being used in this transaction. |
| card_cvv_data | Three digit security code on back of card (optional). |
| card_cvv_presence | Indicates the presence of the card verification value. |
| card_exp_month | Expiration month of the credit card specified in Number . |
| card_exp_year | Expiration year of the credit card specified in Number . |
| card_is_encrypted | Determines whether data set to the Number property is validated. |
| card_number | Customer's credit card number for the transaction. |
| customer_address | Customer's street address. |
| customer_address2 | A specific detail on the customer's shipping address (such as building, suite, apartment, floor number etc. |
| customer_aggregate | This property allows you to get or set an XML aggregate built from all of the Customer properties. |
| customer_city | Customer's city. |
| customer_country | Customer's country. |
| customer_email | Customer's email address. |
| customer_fax | Customer's fax number. |
| customer_first_name | Customer's first name. |
| customer_full_name | Customer's full name. |
| customer_id | Merchant-generated customer Id. |
| customer_last_name | Customer's last name. |
| customer_phone | Customer's phone number. |
| customer_state | Customer's state. |
| customer_zip | Customer's zip code (or postal code if outside of the USA). |
| gateway | Gateway to process transactions with. |
| gateway_url | Default URL for a specific Gateway . |
| invoice_number | Merchant-generated invoice number. |
| level_2_aggregate | The level 2 aggregate containing the data to be sent in the request. |
| level_3_aggregate | The level 3 aggregate containing the data to be sent in the request. |
| merchant_login | Merchant's Gateway login. |
| merchant_password | Merchant's Gateway password. |
| proxy_auth_scheme | This property is used to tell the class which type of authorization to perform when connecting to the proxy. |
| proxy_auto_detect | This property tells the class whether or not to automatically detect and use proxy system settings, if available. |
| proxy_password | This property contains a password if authentication is to be used for the proxy. |
| proxy_port | This property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80). |
| proxy_server | If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified. |
| proxy_ssl | This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy. |
| proxy_user | This property contains a user name, if authentication is to be used for the proxy. |
| response_approval_code | Contains an authorization code when a transaction has been approved. |
| response_approved | Indicates the status of the last transaction. |
| response_approved_amount | The amount approved for the transaction, this is the amount actually charged to the credit card. |
| response_avs_result | Contains the Address Verification System result code. |
| response_code | Indicates the status of the authorization request. |
| response_cvv_result | Contains the returned CVV2 result code if it was requested. |
| response_data | The entire response returned from the gateway processor. |
| response_error_code | Additional error code returned by some gateways. |
| response_error_text | Additional error description returned by some gateways. |
| response_invoice_number | Invoice number submitted in authorization request (if applicable). |
| response_processor_code | Response code from the underlying processor. |
| response_text | Text information that describes each response code. |
| response_transaction_id | Contains the Visa Transaction Identifier or MasterCard Reference Number. |
| shipping_address | Customer's shipping street address. |
| shipping_address2 | A specific detail on the customer's shipping address (such as building, suite, apartment, floor number etc. |
| shipping_city | Customer's shipping city. |
| shipping_country | Customer's shipping country. |
| shipping_email | Customer's email address. |
| shipping_first_name | Customer's first name. |
| shipping_last_name | Customer's last name. |
| shipping_phone | Customer's phone number. |
| shipping_state | Customer's shipping state. |
| shipping_zip | Customer's shipping zip code (or postal code if outside of the USA). |
| special_field_count | The number of records in the SpecialField arrays. |
| special_field_name | Name of special configuration property to submit in this transaction. |
| special_field_value | Value of special configuration property to submit in this transaction. |
| ssl_accept_server_cert_encoded | This is the certificate (PEM/base64 encoded). |
| ssl_cert_encoded | This is the certificate (PEM/base64 encoded). |
| ssl_cert_store | This is the name of the certificate store for the client certificate. |
| ssl_cert_store_password | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
| ssl_cert_store_type | This is the type of certificate store for this certificate. |
| ssl_cert_subject | This is the subject of the certificate used for client authentication. |
| ssl_provider | This specifies the SSL/TLS implementation to use. |
| ssl_server_cert_encoded | This is the certificate (PEM/base64 encoded). |
| test_mode | Turns test mode on and off for transactions sent to the current Gateway . |
| timeout | A timeout for the class. |
| transaction_amount | Purchase amount for an authorization transaction. |
| transaction_desc | Description of goods purchased. |
| transaction_id | Merchant-generated transaction Id used for all transactions. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
| add_special_field | Adds a special field name and the corresponding value. |
| auth_only | Initiates an authorization-only request transaction. |
| avs_only | Used to check the validity of the card without authorizing funds. |
| capture | Captures a previously authorized transaction. |
| config | Sets or retrieves a configuration setting. |
| credit | Credits a customer's card. |
| do_events | Processes events from the internal message queue. |
| force | Used when authorization cannot be obtained online. |
| get_response_var | Parses additional information out of the response. |
| interrupt | Interrupts the current action. |
| refund | Refunds a previously captured transaction. |
| reset | Clears all properties to their default values. |
| reset_special_fields | Resets all special fields to the default settings. |
| sale | Initiates an Sale transaction (authorization and capture). |
| void_transaction | Voids a previously authorized 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.
| on_error | Information about errors during data delivery. |
| on_ssl_server_authentication | Fired after the server presents its certificate to the client. |
| on_ssl_status | Shows the progress of the secure connection. |
Config Settings
The following is a list of config settings for the class with short descriptions. Click on the links for further details.
| 3DSAuthenticationStatus | Indicates whether a transaction qualifies as a ThreeDSecure (3DS) authenticated transaction. |
| 3DSCAVV | Cardholder Authentication Verification Value from a 3D Secure authentication. |
| 3DSDSTransactionId | Directory server transaction Id from a 3D Secure authentication. |
| 3DSECI | Electronic Commerce Indicator. |
| 3DSEnrollmentStatus | Indicates whether 3D Secure authentication is available for the cardholder. |
| 3DSXID | TransactionId from a 3D Secure authentication. |
| AdyenShopperInteraction | Specifies the sales channel the shopper gives their card details through. |
| AllowPartialAuths | Specifies whether partial authorizations are allowed. |
| AmountFormat | Used to set the input format for TransactionAmount. |
| ApplePayData | The Base-64 encoded data containing the encrypted payment data from Apple for use when performing Apple Pay transactions. |
| APSRequestType | Specifies the request type to use for the American Payment Solutions gateway. |
| AuthNetBillToCompany | The company that should be included with the customer's information for the Authorize.NET XML gateway. |
| AuthNetCIMPaymentProfileId | The Payment Profile ID assigned by Authorize.NET CIM gateway. |
| AuthNetCIMProfileId | The Profile ID assigned by Authorize.NET CIM gateway. |
| AuthNetCIMProfileResponse | Profile creation response. |
| AuthNetCIMShippingAddressId | The Shipping Address ID assigned by Authorize.NET CIM gateway. |
| AuthNetCreateCIMProfile | Whether to create a CIM Profile. |
| AuthNetCryptogram | Tokenized credit card cryptogram. |
| AuthNetCustomerType | Specifies the customer type for the Authorize.NET XML gateway. |
| AuthNetOpaqueDescriptor | An Authorize.Net opaque data descriptor. |
| AuthNetOpaqueValue | An Authorize.Net opaque data value. |
| AuthNetShipToCompany | The name of the company associated with the customer's shipping address. |
| AuthNetSplitTenderId | Authorize.Net assigned id for partially authorized transactions. |
| AuthNetTokenizedCard | The credit card token. |
| BamboraPasscode | The API passcode used for authentication with Bambora. |
| BankName | Name of the card issuer. |
| BarclayKeepTransactionOpen | Determines whether to perform a maintenance transaction that keeps the transaction open for further processing with the Barclay and Ingenico gateways. |
| BarclayPartialRefund | Determines whether to send a partial or full refund transaction with the Barclay and Ingenico gateways. |
| BASYSCardInfoKey | BASYS Gateway Credit Card Profile Id. |
| BASYSProcessRecurringCredit | Determines whether to process the transaction via Credit Card Profile Id. |
| BASYSProcessTokenCredit | Determines whether to process the transaction using a Credit Card Token. |
| BASYSToken | BASYS Gateway Credit Card Token. |
| BASYSTokenMode | Indicates the type of token that is being used for the transaction. |
| BASYSVoidMode | Indicates whether to perform a Void or Reversal. |
| BluefinReversal | Determines which transaction type will be use for VoidTransaction with the Bluefin gateway. |
| BluePayMasterId | Used to reference a previous transaction in BluePay. |
| BluePayUpdate | Used to perform an Update transaction for BluePay. |
| BlueSnapEnterpriseUdfs | User-Defined Fields (UDFs) to send with a BlueSnap Sale or AuthOnly request. |
| BlueSnapGetToken | Retrieves a new hosted payment fields token (pfToken) from BlueSnap. |
| BlueSnapRetrieveTransaction | Retrieves a BlueSnap transaction. |
| BlueSnapTransactionMetaData | Transaction metadata to send with a BlueSnap Sale or AuthOnly request. |
| CardholderPresentCode | Specifies the way in which transaction took place. |
| CardIssueNumber | Special Issue Number used for Switch and Solo cards. |
| CardLast4Digits | The last 4 digits of a credit card. |
| CardPointeEncryptionHandler | The encryption handler to use when requesting a token from CardPointe. |
| CardPointeGetToken | Retrieves an account token from CardPointe. |
| CardStartMonth | Used for some international cards. |
| CardStartYear | Used for some international cards. |
| CardToken | The credit card token. |
| CAVVResponse | Contains CAVV response value returned by the gateway. |
| COFPermission | Indicates if the customer gave permission to make a Card On File transaction. |
| ConvenienceFee | The total convenience fee charged for a transaction. |
| ConvergeTokenMode | Used to request a token from the Converge gateway. |
| CurrencyCode | Currency code for the currency of the transaction. |
| CurrencyExponent | Currency exponent to be used in conjunction with the Currency code of the transaction. |
| CustomerProfileId | Used to send a customer profile Id to a gateway. |
| CyberSourceAuthToken | The request token from a previous authorization for the CyberSource gateway. |
| CyberSourceProfileId | The Id of a Customer's Profile stored within the CyberSource gateway. |
| CyberSourceVoidMode | Indicates whether to perform a Void or Reversal. |
| CyberSourceXMLEscape | Determines whether to XML escape the CyberSource gateway request field values. |
| DataCash3DSCardholderRegistered | Indicates whether the cardholder was registered for 3D Secure for the DataCash gateway. |
| DataCashAuthOnlyFinality | Indicates whether an AuthOnly transaction should be treated as final for the DataCash gateway. |
| DataCashExtendedPolicyAggregate | Used to specify an XML aggregate for Extended Policies within the DataCash gateway. |
| DynamicDescriptor | A merchant defined transaction description which appears on the customer's credit card statement. |
| EscapeXML | Automatically escape data within XML tags. |
| ExPayGetMethods | Used to send a GetMethods request to the ExPay gateway. |
| ExPayGetStatus | Used to send a GetStatus request to the ExPay gateway. |
| ExPayPaymentId | The payment Id used to retrieve a transaction status for the ExPay gateway. |
| ExPayServiceId | The Id of the service to use to perform an authorization for the ExPay gateway. |
| FDMSCurrentBalance | Contains the current card balance value returned in a response for the First Data E4, Payeezy, and Bank Of America gateways. |
| FDMSGiftCardTransactionType | Specifies the transaction type to perform on a gift card for the First Data E4, Payeezy, and Bank Of America gateways. |
| FDMSKeyId | The Key Id that corresponds to the HMAC Key for the First Data E4, Payeezy, and Bank Of America gateways. |
| FDMSProcessGiftCard | Specifies whether the card being processed is a gift card for the First Data E4, Payeezy, and Bank Of America gateways. |
| FDMSTransArmorToken | The Transarmor token that replaces a card number and used for transaction processing. |
| FDMSWalletProviderId | Specifies the transaction type to perform on a gift card for the First Data E4, Payeezy, and Bank Of America gateways. |
| GlobalIrisRefundPassword | The Refund password for the Global Iris gateway. |
| GlobalPayrollCreateToken | Sends a create token request to the Global Payroll gateway. |
| GlobalPayrollToken | The token value for a corresponding card when using the Global Payroll gateway. |
| GoEMerchantUseGatewayId | Indicates whether to send a password or gateway Id for the GoEMerchant gateway. |
| HashAlgorithm | Algorithm used for hashing. |
| HashSecret | Security key used to generate a hash for gateways supporting such functionality. |
| HeartlandDeveloperId | Optional DeveloperId field used by the Heartland gateway. |
| HeartlandDeviceId | DeviceId field required by the Heartland gateway. |
| HeartlandLicenseId | LicenseId field required by the Heartland gateway. |
| HeartlandReversalAmount | The settlement amount to be used when performing a reversal for the Heartland gateway. |
| HeartlandSecretAPIKey | Specifies the secret key to be used for authentication with Heartland. |
| HeartlandShipDay | Ship day field required by the Heartland gateway e-commerce/direct marketing transactions. |
| HeartlandShipMonth | Ship month field required by the Heartland gateway e-commerce/direct marketing transactions. |
| HeartlandSiteId | SiteId field required by the Heartland gateway. |
| HeartlandSiteTrace | Optional transaction identifier for the Heartland gateway. |
| HeartlandTokenMapping | The type of token to return when using Tokenization with the Heartland gateway. |
| HeartlandTokenValue | Used to retrieve or specify a Heartland token value. |
| HeartlandVersionNumber | Optional VersionNumber field used by the Heartland gateway. |
| LitleAdvancedFraudChecksId | Used to specify the Id for use in the AdvancedFraudChecks element for the Litle gateway. |
| LitleCustomBillingAggregate | Used to specify an XML aggregate for Custom Billing support within the Litle gateway. |
| MerchantAlias | An additional merchant property used to specify an alias for the merchant. |
| MerchantCode | A gateway-supplied merchant number, code, or Id. |
| MerchantESolutionsAccountDataSource | Specifies the source of a customer's data in an authorization request to Merchant e-Solutions. |
| MerchantESolutionsCardOnFile | Tells Merchant e-Solutions that you will be storing card information. |
| MerchantESolutionsMerchantInitiated | Tells Merchant e-Solutions that you are performing a Merchant Initiated Transaction. |
| MerchantESolutionsMotoECommerceInd | Used to tell Merchant e-Solutions if a transaction is Mail Order, Telephone Order, or E-Commerce. |
| MerchantESolutionsToken | Holds a token representing card information stored by Merchant e-Solutions. |
| MerchantESolutionsTokenizeCard | When set, will request a tokenized card from Merchant e-Solutions. |
| MerchantPartnersLast4Digits | The last 4 digits of the card number for a transaction processed via the MerchantPartners gateway. |
| MerchantPartnersProfileId | The profile Id to be used to process a transaction via the MerchantPartners or WorldPay Link gateways. |
| MetrobankLocale | Sets the locale for a 3-party request to Metrobank. |
| MetrobankReturnURL | Sets the URL where a user will be redirected after a 3-party request to Metrobank. |
| MetrobankThreePartyRequest | Indicates that the class should return data for a 3-party request to Metrobank. |
| MetrobankThreePartyResponse | Used to manually parse a response after a 3-Party request to Metrobank. |
| MetrobankVoidType | Used to type of transaction should be voided in a request to Metrobank. |
| MITAESSeedId | The Seed Id used to perform AES encryption for the MIT gateway. |
| MITBranchId | Branch reference number for the MIT gateway. |
| MITCompanyId | Company reference number for the MIT gateway. |
| MITCountry | Country of operation for the MIT gateway. |
| MITEncryptionAlgorithm | The Encryption Algorithm to use with the MIT gateway. |
| MITEncryptionKey | The Encryption Key to use with the MIT gateway. |
| MITFlag | For the MIT framework - Used to indicate that a transaction is merchant initiated. |
| MITPriorTransId | For the MIT framework - Used to specify a prior transaction id to be referenced in a merchant initiated transaction. |
| MITRecurring | Specifies whether to perform a recurring transaction request for the MIT gateway. |
| MITTPOperation | The operation type for the MIT gateway. |
| MITType | For the MIT framework - Indicates the type of transaction being requested in a Merchant-Initiated Transaction (MIT). |
| MonerisNVPAPI | Indicates whether to use the NVP API for the gwMoneris and gwMonerisUSA gateway. |
| MyVirtualMerchantTransactionType | Used to override the transaction type to send in a transaction for the MyVirtualMerchant and Converge gateways. |
| MyVirtualMerchantUserId | The MyVirtualMerchant user Id as configured on VirtualMerchant. |
| NetbanxAccountNumber | Account Number for the Netbanx gateway. |
| NetBillingVersion | The Version to be sent in the User-Agent heading of a NetBilling gateway request. |
| OrbitalAuthReversal | Indicates whether to perform an authorization reversal when calling VoidTransaction for the Orbital gateway. |
| OrbitalConnectionPassword | Orbital Connection Password field used by the Orbital gateway. |
| OrbitalConnectionUsername | Orbital Connection Username field used by the Orbital gateway. |
| OrbitalCustomerProfileFromOrderInd | Customer Profile Number generation Options for the Orbital gateway. |
| OrbitalCustomerProfileId | The Id for a customer profile in the Orbital gateway. |
| OrbitalCustomerProfileOrderOverrideInd | Indicator to specify how the CustomerId is leveraged to populate other data sets for the Orbital gateway. |
| OrbitalDigitalTokenCryptogram | Holds the cryptogram when making a CDPT request with Orbital. |
| OrbitalDPANIndicator | Indicates the type of a CDPT authorization with Orbital. |
| OrbitalTxRefIdx | Indentifies the unique classes of transactions that have been adjusted more than one time for the Orbital gateway. |
| OrbitalVoidAdjustedAmount | Specifies the amount to void from a previous authoization for the Orbital gateway. |
| PayDirectConvenienceFee | The total convenience fee charged when using the PayDirect gateway. |
| PayDirectMerchantAmount | The MerchantAmount used by the PayDirect gateway. |
| PayDirectSettleMerchantCode | The Settle Merchant Code required for authorization when using the PayDirect gateway. |
| PayerIP | The IP address of the payer. |
| PayFlowProInquiry | Submits an Inquiry transaction to the PayFlowPro gateway. |
| PayFlowProToken | Used specify a token to be used instead of card data for the Payflow Pro gateway. |
| PayFlowProUpload | Submits an Upload transaction to the PayFlowPro gateway. |
| PayJunctionUpdateAmount | Indicates whether the capture method should send an update amount request when using the PayJunction gateway. |
| PaymentWorkSuiteClientCode | The 3DSI assigned client code sent in a request to the PaymentWorksuite gateway. |
| PaymentWorkSuiteLocationCode | The 3DSI assigned location code sent in a request to the PaymentWorksuite gateway. |
| PaymentWorkSuiteMerchantCode | The 3DSI assigned merchant code sent in a request to the PaymentWorksuite gateway. |
| PayPointFreedomAPI | Indicates whether to use the Freedom API for the gwPayPoint and gwSECPay gateways. |
| PayTraceAddPurchaseCardData | Sends a Level3 request for the PayTrace gateway. |
| PayTraceIntegratorId | Used to specify the Integrator Id value assigned by the PayTrace gateway. |
| PayTraceJSONCardToken | The token value for a corresponding card. |
| PayTraceJSONEncryptionKey | The Encryption Key to use with the PayTraceJSON gateway. |
| PayTraceJSONGetClientKeyToken | Retrieves a new Client Key (PROTECT AUTH TOKEN) from PayTrace. |
| PayvisionTransactionGuid | The GUID obtained with an authorization for the Payvision gateway. |
| PayWiserCaptureReferenceId | The capture reference id returned by PayWiser after doing a Sale transaction. |
| PayWiserCardToken | The token value for a corresponding card when using the PayWiser gateway. |
| PayWiserEMerchantPay | Determines whether to process the transaction via E-Merchant Pay Acquiring Bank. |
| PayWiserReserveReferenceId | The reserve reference id returned by PayWiser after doing a Sale transaction. |
| PayWiserTokenizeCard | Whether to generate a Token Reference Id. |
| PayWiserTokenReferenceId | The token reference id for a corresponding card when using the PayWiser gateway. |
| PhoeniXGateCardInfoKey | PhoeniXGate Gateway Credit Card Profile Id. |
| PhoeniXGateProcessRecurringCredit | Determines whether to process the transaction via Credit Card Profile Id. |
| PhoeniXGateProcessTokenCredit | Determines whether to process the transaction using a Credit Card Token. |
| PhoeniXGateToken | PhoeniXGate Gateway Credit Card Token. |
| PhoeniXGateTokenMode | Indicates the type of token that is being used for the transaction. |
| PhoeniXGateVoidMode | Indicates whether to perform a Void or Reversal. |
| PKPaymentToken | Used to send an Apple Pay PKPaymentToken to the gateway. |
| PPSPaymentToken | A Priority Payment Systems payment token. |
| QBMSMobile | Whether or not this transaction is being sent from a mobile device. |
| QBPaymentsMobile | Whether or not this transaction is being sent from a mobile device. |
| RawRequest | Returns the data that was sent to the gateway. |
| RawResponse | Returns the data that was received from the gateway. |
| RecurringIndicator | Marks a request as a recurring transaction. |
| RepayCardInfoKey | Repay Gateway Credit Card Profile Id. |
| RepayProcessRecurringCredit | Determines whether to process the transaction via Credit Card Profile Id. |
| RepayProcessTokenCredit | Determines whether to process the transaction using a Credit Card Token. |
| RepayToken | Repay Gateway Credit Card Token. |
| RepayTokenMode | Indicates the type of token that is being used for the transaction. |
| RepayVoidMode | Indicates whether to perform a Void or Reversal. |
| ResponseCardNumber | The card number as returned in the response from the gateway. |
| ResponseCardType | The card type as returned in the response from the gateway. |
| SagePayCreateToken | Sends a create token request to the SagePay gateway. |
| SagePayRemoveToken | Sends a remove token request to the SagePay gateway. |
| SagePayRepeat | Performs a Repeat transaction for the SagePay gateway. |
| SagePayRequestToken | Specifies whether to request a token when performing an Auth or Sale when using the SagePay gateway. |
| SagePayStoreToken | Specifies whether to store a token when using the SagePay gateway. |
| SagePayToken | The token value for a corresponding card when using the SagePay gateway. |
| SagePayUseAbort | Indicates whether to use Abort or Void for void transactions. |
| Shift4AuthToken | Specifies the Auth Token when making an Access Token request to the Shift4 gateway. |
| Shift4ClientGuid | Specifies the Client Guid when making an Access Token request to the Shift4 gateway. |
| Shift4GetAccessToken | Performs an Access Token Exchange request with the Shift4 gateway. |
| Shift4InterfaceName | Specifies the name of the interface for the Shift4 gateway. |
| Shift4InterfaceVersion | Specifies the version of the interface for the Shift4 gateway. |
| SquareAdditionalRecipients | Additional recipients data to send with a Square Sale or AuthOnly request. |
| SquareApplicationFee | Allows you to specify an application fee as part of the transaction. |
| SquareCustomerCardId | The Id of the card saved to a customer profile. |
| SquareIdempotencyKey | Value that uniquely identifies a Square Sale, AuthOnly, or Refund request. |
| SquareLocationId | Square location Id to make the transaction request against. |
| SquareOrderId | Square Order Id to associate with a Square Sale or AuthOnly request. |
| SquareTenderId | Square Tender Id associated with a Square transaction. |
| StoreCardOnFile | For the Stored Credentials framework - Used to indicate that the merchant will be storing the customer's card on file (COF). |
| StripeApplicationFee | A fee in cents that will be applied to the charge. |
| StripeDestinationAccount | Id of an existing, connected Stripe account. |
| StripeDestinationAmount | The amount to transfer to the destination account. |
| StripeOnBehalfOf | The Stripe account Id that these funds are intended for. |
| StripeRefundApplicationFee | Whether the application fee should be refunded when refunding the charge. |
| StripeRefundReason | Reason for the refund. |
| StripeRefundReverseTransfer | Whether the transfer should be reversed when refunding the charge. |
| StripeShippingCarrier | The delivery service that shipped a physical product. |
| StripeShippingTrackingNumber | The tracking number for a physical product. |
| StripeTransferGroup | Identifies the transaction as part of a group. |
| StripeVersion | Determines which version of the Stripe API should be used. |
| SurchargeAmount | Used to specify the amount of the surcharge for the transaction. |
| TerminalId | Terminal Id value sent in the transaction. |
| TipAmount | Used to specify the amount of the tip for the transaction. |
| USAEPayPerformVoidRelease | Specifies whether to perform a void or void:release transaction. |
| UseCardOnFile | For the Stored Credentials framework - Used to indicate that the merchant is using stored card on file (COF) information for the request. |
| UserId | Used to specify an Id for the API user. |
| VeritasBankName | Name of the card issuer. |
| VeritasEncryptionKey | Encryption key used to encrypt credit card information. |
| VeritasEncryptionKey | Encryption key used to encrypt credit card information. |
| VeritasToken | Veritas token. |
| VeritasVoidRefundReasonId | Veritas gateway void reason. |
| WorldpayOnlineToken | Worldpay Online token. |
| WorldpayOnlineTokenAction | Used to generate, update, or delete a Worldpay Online token. |
| XChildrenCount | The number of child elements of the current element. |
| XChildrenName[x] | The name of the child element. |
| XChildrenXText[x] | The inner text of the child element. |
| XElement | The name of the current element. |
| XPath | Provides a way to point to a specific element in the returned XML or JSON response. |
| XText | The text of the current element. |
| AcceptEncoding | Used to tell the server which types of content encodings the client supports. |
| AllowHTTPCompression | This property enables HTTP compression for receiving data. |
| AllowHTTPFallback | Whether HTTP/2 connections are permitted to fallback to HTTP/1.1. |
| Append | Whether to append data to LocalFile. |
| Authorization | The Authorization string to be sent to the server. |
| BytesTransferred | Contains the number of bytes transferred in the response data. |
| ChunkSize | Specifies the chunk size in bytes when using chunked encoding. |
| CompressHTTPRequest | Set to true to compress the body of a PUT or POST request. |
| EncodeURL | If set to True the URL will be encoded by the class. |
| FollowRedirects | Determines what happens when the server issues a redirect. |
| GetOn302Redirect | If set to True the class will perform a GET on the new location. |
| HTTP2HeadersWithoutIndexing | HTTP2 headers that should not update the dynamic header table with incremental indexing. |
| HTTPVersion | The version of HTTP used by the class. |
| IfModifiedSince | A date determining the maximum age of the desired document. |
| KeepAlive | Determines whether the HTTP connection is closed after completion of the request. |
| KerberosSPN | The Service Principal Name for the Kerberos Domain Controller. |
| LogLevel | The level of detail that is logged. |
| MaxRedirectAttempts | Limits the number of redirects that are followed in a request. |
| NegotiatedHTTPVersion | The negotiated HTTP version. |
| OtherHeaders | Other headers as determined by the user (optional). |
| ProxyAuthorization | The authorization string to be sent to the proxy server. |
| ProxyAuthScheme | The authorization scheme to be used for the proxy. |
| ProxyPassword | A password if authentication is to be used for the proxy. |
| ProxyPort | Port for the proxy server (default 80). |
| ProxyServer | Name or IP address of a proxy server (optional). |
| ProxyUser | A user name if authentication is to be used for the proxy. |
| SentHeaders | The full set of headers as sent by the client. |
| StatusLine | The first line of the last response from the server. |
| TransferredData | The contents of the last response from the server. |
| TransferredDataLimit | The maximum number of incoming bytes to be stored by the class. |
| TransferredHeaders | The full set of headers as received from the server. |
| TransferredRequest | The full request as sent by the client. |
| UseChunkedEncoding | Enables or Disables HTTP chunked encoding for transfers. |
| UseIDNs | Whether to encode hostnames to internationalized domain names. |
| UsePlatformHTTPClient | Whether or not to use the platform HTTP client. |
| UseProxyAutoConfigURL | Whether to use a Proxy auto-config file when attempting a connection. |
| UserAgent | Information about the user agent (browser). |
| ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
| FirewallAutoDetect | Tells the class whether or not to automatically detect and use firewall system settings, if available. |
| FirewallHost | Name or IP address of firewall (optional). |
| FirewallPassword | Password to be used if authentication is to be used when connecting through the firewall. |
| FirewallPort | The TCP port for the FirewallHost;. |
| FirewallType | Determines the type of firewall to connect through. |
| FirewallUser | A user name if authentication is to be used connecting through a firewall. |
| KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
| KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
| Linger | When set to True, connections are terminated gracefully. |
| LingerTime | Time in seconds to have the connection linger. |
| LocalHost | The name of the local host through which connections are initiated or accepted. |
| LocalPort | The port in the local host where the class binds. |
| MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
| MaxTransferRate | The transfer rate limit in bytes per second. |
| ProxyExceptionsList | A semicolon separated list of hosts and IPs to bypass when using a proxy. |
| TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
| TcpNoDelay | Whether or not to delay when sending packets. |
| UseIPv6 | Whether to use IPv6. |
| LogSSLPackets | Controls whether SSL packets are logged when using the internal security API. |
| OpenSSLCADir | The path to a directory containing CA certificates. |
| OpenSSLCAFile | Name of the file containing the list of CA's trusted by your application. |
| OpenSSLCipherList | A string that controls the ciphers to be used by SSL. |
| OpenSSLPrngSeedData | The data to seed the pseudo random number generator (PRNG). |
| ReuseSSLSession | Determines if the SSL session is reused. |
| SSLCACertFilePaths | The paths to CA certificate files on Unix/Linux. |
| SSLCACerts | A newline separated list of CA certificate to use during SSL client authentication. |
| SSLCheckCRL | Whether to check the Certificate Revocation List for the server certificate. |
| SSLCheckOCSP | Whether to use OCSP to check the status of the server certificate. |
| SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
| SSLEnabledCipherSuites | The cipher suite to be used in an SSL negotiation. |
| SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
| SSLEnableRenegotiation | Whether the renegotiation_info SSL extension is supported. |
| SSLIncludeCertChain | Whether the entire certificate chain is included in the SSLServerAuthentication event. |
| SSLKeyLogFile | The location of a file where per-session secrets are written for debugging purposes. |
| SSLNegotiatedCipher | Returns the negotiated ciphersuite. |
| SSLNegotiatedCipherStrength | Returns the negotiated ciphersuite strength. |
| SSLNegotiatedCipherSuite | Returns the negotiated ciphersuite. |
| SSLNegotiatedKeyExchange | Returns the negotiated key exchange algorithm. |
| SSLNegotiatedKeyExchangeStrength | Returns the negotiated key exchange algorithm strength. |
| SSLNegotiatedVersion | Returns the negotiated protocol version. |
| SSLSecurityFlags | Flags that control certificate verification. |
| SSLServerCACerts | A newline separated list of CA certificate to use during SSL server certificate validation. |
| TLS12SignatureAlgorithms | Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal. |
| TLS12SupportedGroups | The supported groups for ECC. |
| TLS13KeyShareGroups | The groups for which to pregenerate key shares. |
| TLS13SignatureAlgorithms | The allowed certificate signature algorithms. |
| TLS13SupportedGroups | The supported groups for (EC)DHE key exchange. |
| AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
| FirewallData | Used to send extra data to the firewall. |
| InBufferSize | The size in bytes of the incoming queue of the socket. |
| OutBufferSize | The size in bytes of the outgoing queue of the socket. |
| BuildInfo | Information about the product's build. |
| CodePage | The system code page used for Unicode to Multibyte translations. |
| LicenseInfo | Information about the current license. |
| MaskSensitive | Whether sensitive data is masked in log messages. |
| ProcessIdleEvents | Whether the class uses its internal event loop to process events when the main thread is idle. |
| SelectWaitMillis | The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process. |
| UseInternalSecurityAPI | Tells the class whether or not to use the system security libraries or an internal implementation. |
auth_code Property
Authorization code from a previous transaction.
Syntax
def get_auth_code() -> str: ... def set_auth_code(value: str) -> None: ...
auth_code = property(get_auth_code, set_auth_code)
Default Value
""
Remarks
Some gateways require the merchant to include the response_approval_code from the original transaction in credit, void_transaction, and capture transactions. You may send the original approval code in this auth_code property. The gateways which require this are listed below:
- gwIntellipay (3)
- gwBankOfAmerica (13)
- gwInnovative (14)
- gwACHPAyments (35)
- gwForte (36)
- gwSagePay (50)
- gwDataCash (77)
- gwFirstDataE4 (80)
card_aggregate Property
This property allows you to get or set an XML aggregate built from all of the Card properties.
Syntax
def get_card_aggregate() -> str: ... def set_card_aggregate(value: str) -> None: ...
card_aggregate = property(get_card_aggregate, set_card_aggregate)
Default Value
""
Remarks
This property allows you to get or set an XML aggregate built from all of the Card properties.
"EPCardType" is the root element. The Card properties make up the tags under the root, but
without the beginning "Card". For instance:
<EPCardType>
<Number>4444333322221111</Number>
<CVV2Data>996</CVV2Data>
<CVVIndicator>cvPresent</CVVIndicator>
<ExpMonth>12</ExpMonth>
<ExpYear>2010</ExpYear>
<Type>ctVisa</Type>
</EPCardType>
card_type Property
Type of credit card being used in this transaction.
Syntax
def get_card_type() -> int: ... def set_card_type(value: int) -> None: ...
card_type = property(get_card_type, set_card_type)
Default Value
0
Remarks
Type of credit card being used in this transaction. This property contains the customer's credit card type. This is automatically computed after the card_number is set, but it can also be changed manually. A list of valid card types is included below.
| ctUnknown (0) | Invalid or unknown prefix, card type not known. |
| ctVisa (1) | Visa or Delta Card. |
| ctMasterCard (2) | MasterCard. |
| ctAMEX (3) | American Express Card. |
| ctDiscover (4) | Discover Card. |
| ctDiners (5) | Diners Club or Carte Blanche Card. |
| ctJCB (6) | JCB Card. |
| ctVisaElectron (7) | Visa Electron Card (runs as a Visa for most gateways) |
| ctMaestro (8) | Maestro Card |
| ctLaser (10) | Laser Card (Ireland) |
card_cvv_data Property
Three digit security code on back of card (optional).
Syntax
def get_card_cvv_data() -> str: ... def set_card_cvv_data(value: str) -> None: ...
card_cvv_data = property(get_card_cvv_data, set_card_cvv_data)
Default Value
""
Remarks
Three digit security code on back of card (optional).
This alphanumeric property contains the three digit Visa "Card Verification Value" (CVV), MasterCard "Card Verification Code" (CVC), or four-digit American Express "Card Identification Number" (CID). This value appears as additional characters embossed on the card signature line following the credit card account number on the back of the credit card. This is an optional property which can be used to determine if the customer is actually in possession of the credit card.
Even if the card_cvv_data is incorrect, the transaction may still be authorized. It is up to the merchant to examine the ResponseCVVResult property and decide whether to honor the transaction or not.
Note: When set to a non-empty value, card_cvv_presence will be automatically set to cvpProvided. If set to empty string (""), card_cvv_presence will be automatically set to cvpNotProvided.
card_cvv_presence Property
Indicates the presence of the card verification value.
Syntax
def get_card_cvv_presence() -> int: ... def set_card_cvv_presence(value: int) -> None: ...
card_cvv_presence = property(get_card_cvv_presence, set_card_cvv_presence)
Default Value
0
Remarks
Indicates the presence of the card verification value.
This property is used to indicate the presence of card_cvv_data.
The class will automatically set this value to cvpProvided when a card_cvv_data value is specified. You can explicitly specify the card_cvv_presence indicator by setting this property.
Available values are:
- cvpNotProvided (0)
- cvpProvided (1)
- cvpIllegible (2)
- cvpNotOnCard (3)
card_exp_month Property
Expiration month of the credit card specified in Number .
Syntax
def get_card_exp_month() -> int: ... def set_card_exp_month(value: int) -> None: ...
card_exp_month = property(get_card_exp_month, set_card_exp_month)
Default Value
1
Remarks
Expiration month of the credit card specified in card_number.
This property contains the expiration date of the customer's credit card, and must be in the range 1 - 12.
card_exp_year Property
Expiration year of the credit card specified in Number .
Syntax
def get_card_exp_year() -> int: ... def set_card_exp_year(value: int) -> None: ...
card_exp_year = property(get_card_exp_year, set_card_exp_year)
Default Value
2000
Remarks
Expiration year of the credit card specified in card_number.
This property contains the expiration date of the customer's credit card. This property must be in the range 0 - 99, or 2000 - 2099. Any date before the year 2000 or after 2099 cannot be specified.
card_is_encrypted Property
Determines whether data set to the Number property is validated.
Syntax
def get_card_is_encrypted() -> bool: ... def set_card_is_encrypted(value: bool) -> None: ...
card_is_encrypted = property(get_card_is_encrypted, set_card_is_encrypted)
Default Value
FALSE
Remarks
Determines whether data set to the card_number property is validated.
By default, when the card_number field is set, the value will be validated and normalized. For instance, "4444-33332222 1111" will be normalized as "4444333322221111". However, any other non-numerical data entered will cause an exception to be thrown. It may be useful in some gateways to send other data in the card_number field, and this can be accomplished by setting IsEncrypted to true. However, please note that in doing so automatic calculation of the card_type may be affected, and the card number will not be verified.
card_number Property
Customer's credit card number for the transaction.
Syntax
def get_card_number() -> str: ... def set_card_number(value: str) -> None: ...
card_number = property(get_card_number, set_card_number)
Default Value
""
Remarks
Customer's credit card number for the transaction.
If you're sending the transaction with card_magnetic_stripe data, this property should be left empty.
customer_address Property
Customer's street address.
Syntax
def get_customer_address() -> str: ... def set_customer_address(value: str) -> None: ...
customer_address = property(get_customer_address, set_customer_address)
Default Value
""
Remarks
Customer's street address. This property is used as part of the Address Verification Service (AVS) and contains the customer's street address as it appears on their monthly statement. Only the street number, street name, and apartment number are required in This property. City, state, and zip code are set in the customer_city, customer_state, and customer_zip properties.
The length of this property varies by gateway. If the customer's address is very long, it is admissible to include only the street number in This property.
NOTE: For the Moneris gateway, this property should contain only the customer's street number. The street name should be added via the add_special_field method. For example:
class.CustomerAddress = "123"
class.AddSpecialField("avs_street_name", "Nowhere Ln")
customer_address2 Property
A specific detail on the customer's shipping address (such as building, suite, apartment, floor number etc.
Syntax
def get_customer_address2() -> str: ... def set_customer_address2(value: str) -> None: ...
customer_address2 = property(get_customer_address2, set_customer_address2)
Default Value
""
Remarks
A specific detail on the customer's shipping address (such as building, suite, apartment, floor number etc.).
customer_aggregate Property
This property allows you to get or set an XML aggregate built from all of the Customer properties.
Syntax
def get_customer_aggregate() -> str: ... def set_customer_aggregate(value: str) -> None: ...
customer_aggregate = property(get_customer_aggregate, set_customer_aggregate)
Default Value
""
Remarks
This property allows you to get or set an XML aggregate built from all of the Customer properties.
"EPCustomer" is the root element. The Customer properties make up the tags under the root, but
without the beginning "Customer". For instance:
<EPCustomer>
<Address>123 Nowhere Ln.</Address>
<Address2>Apt 3B.</Address2>
<City>Beverly Hills</City>
...
</EPCustomer>
customer_city Property
Customer's city.
Syntax
def get_customer_city() -> str: ... def set_customer_city(value: str) -> None: ...
customer_city = property(get_customer_city, set_customer_city)
Default Value
""
Remarks
Customer's city. This property is used as part of the Address Verification Service (AVS) and contains the customer's city as it appears on their monthly statement. Other AVS properties include customer_address, customer_state, and customer_zip.
customer_country Property
Customer's country.
Syntax
def get_customer_country() -> str: ... def set_customer_country(value: str) -> None: ...
customer_country = property(get_customer_country, set_customer_country)
Default Value
""
Remarks
Customer's country. This property contains the country in which the customer is located. Most gateways use a two-letter country code, specified in ISO-3166.
Note: If using this property with the PayFuse gateway, this property should contain the ISO-3166 numeric code instead of the standard two-letter code. For example, the ISO code for the US is "840".
customer_email Property
Customer's email address.
Syntax
def get_customer_email() -> str: ... def set_customer_email(value: str) -> None: ...
customer_email = property(get_customer_email, set_customer_email)
Default Value
""
Remarks
Customer's email address. This optional property contains the customer's email address.
customer_fax Property
Customer's fax number.
Syntax
def get_customer_fax() -> str: ... def set_customer_fax(value: str) -> None: ...
customer_fax = property(get_customer_fax, set_customer_fax)
Default Value
""
Remarks
Customer's fax number. This optional property contains the customer's fax number.
customer_first_name Property
Customer's first name.
Syntax
def get_customer_first_name() -> str: ... def set_customer_first_name(value: str) -> None: ...
customer_first_name = property(get_customer_first_name, set_customer_first_name)
Default Value
""
Remarks
Customer's first name. This property contains the customer's first name.
customer_full_name Property
Customer's full name.
Syntax
def get_customer_full_name() -> str: ... def set_customer_full_name(value: str) -> None: ...
customer_full_name = property(get_customer_full_name, set_customer_full_name)
Default Value
""
Remarks
Customer's full name. This property contains the customer's full name as it appears on the credit card or bank account. Many gateways use this property in addition to, or instead of, the customer_first_name and customer_last_name properties. If a gateway requires a customer_full_name and the property is empty, customer_full_name will be constructed using the contents of customer_first_name and customer_last_name.
customer_id Property
Merchant-generated customer Id.
Syntax
def get_customer_id() -> str: ... def set_customer_id(value: str) -> None: ...
customer_id = property(get_customer_id, set_customer_id)
Default Value
""
Remarks
Merchant-generated customer Id. This property contains a merchant-generated customer identification number. This number should be unique for each different customer that places an order with the merchant.
customer_last_name Property
Customer's last name.
Syntax
def get_customer_last_name() -> str: ... def set_customer_last_name(value: str) -> None: ...
customer_last_name = property(get_customer_last_name, set_customer_last_name)
Default Value
""
Remarks
Customer's last name. This property contains the customer's last name as it appears on their credit card.
customer_phone Property
Customer's phone number.
Syntax
def get_customer_phone() -> str: ... def set_customer_phone(value: str) -> None: ...
customer_phone = property(get_customer_phone, set_customer_phone)
Default Value
""
Remarks
Customer's phone number. This optional property contains the customer's phone number.
customer_state Property
Customer's state.
Syntax
def get_customer_state() -> str: ... def set_customer_state(value: str) -> None: ...
customer_state = property(get_customer_state, set_customer_state)
Default Value
""
Remarks
Customer's state. This property is used as part of the Address Verification Service (AVS) and contains the two character postal abbreviation of the customer's state as it appears on their monthly statement. Other AVS properties include customer_address, customer_city, and customer_zip.
customer_zip Property
Customer's zip code (or postal code if outside of the USA).
Syntax
def get_customer_zip() -> str: ... def set_customer_zip(value: str) -> None: ...
customer_zip = property(get_customer_zip, set_customer_zip)
Default Value
""
Remarks
Customer's zip code (or postal code if outside of the USA). This property is used as part of the Address Verification Service (AVS), and contains the customer's zip code as it appears on their monthly statement. Other AVS properties include customer_address, customer_city, and customer_state.
gateway Property
Gateway to process transactions with.
Syntax
def get_gateway() -> int: ... def set_gateway(value: int) -> None: ...
gateway = property(get_gateway, set_gateway)
Default Value
0
Remarks
This property is used to select the gateway with which transactions will be processed. Setting the gateway property will also fill the gateway_url with the URL to the gateway's processing server, and will also fill the special_field_name and special_field_value properties with default names and values for the selected gateway. These are special configuration values that should usually not be changed. The following table shows the currently supported gateways, as well as the corporate home page for each.
| Gateway | Home page |
| No Gateway (0) | n/a |
| Authorize.Net AIM (1) | http://www.authorize.net |
| eProcessing Transparent Database Engine (2) | http://www.eProcessingNetwork.com |
| Intellipay ExpertLink (3) | http://www.intellipay.com |
| iTransact RediCharge HTML (4) | http://www.itransact.com |
| NetBilling DirectMode (5) | http://www.netbilling.com |
| PayFlow Pro (6) | https://www.paypal.com/webapps/mpp/payflow-payment-gateway |
| USA ePay CGI Transaction Gateway (7) | http://www.usaepay.com |
| Plug 'n Pay (8) | http://www.plugnpay.com |
| Planet Payment iPay (9) | http://planetpayment.com/ |
| MPCS (10) | http://merchantcommerce.net/ |
| RTWare (11) | http://www.rtware.net/ |
| ECX (12) | http://www.ecx.com |
| Bank of America (Global Gateway e4) (13) | http://bankofamerica.com/merchantservices |
| Innovative Gateway (PHP) (14) | http://www.innovativegateway.com |
| Merchant Anywhere (Transaction Central Classic) (15) | http://www.merchantanywhere.com/ |
| SkipJack (16) | http://www.skipjack.com |
| 3 Delta Systems (3DSI) EC-Linx (18) | http://www.3dsi.com |
| TrustCommerce API (19) | http://www.trustcommerce.com |
| PSIGate HTML (20) | http://www.psigate.com |
| PayFuse XML (ClearCommerce Engine) (21) | http://www.firstnationalmerchants.com/ |
| PayFlow Link (22) | https://www.paypal.com/webapps/mpp/payflow-payment-gateway |
| Chase Paymentech Orbital Gateway (23) | https://merchantservices.chase.com/ |
| LinkPoint (24) | http://www.linkpoint.com |
| Moneris eSelect Plus Canada (25) | http://www.moneris.com |
| uSight Gateway Post-Auth (26) | This gateway is no longer in service. |
| Fast Transact VeloCT (Direct Mode) (27) | http://www.fasttransact.com/ |
| NetworkMerchants Direct-Post API (28) | http://www.nmi.com/ |
| Ingenico DirectLink / Ogone (29) | https://www.ingenico.be/ |
| TransFirst Transaction Central Classic (formerly PRIGate) (30) | http://www.transfirst.com |
| Merchant Partners (Transaction Engine) (31) | http://www.merchantpartners.com/ |
| CyberCash (32) | https://www.paypal.com/cybercash |
| First Data Global Gateway (Linkpoint) (33) | http://www.firstdata.com |
| YourPay (Linkpoint) (34) | http://www.yourpay.com |
| ACH Payments AGI (35) | http://www.ach-payments.com |
| Forte AGI / Payments Gateway AGI(36) | https://www.forte.net/ |
| Cyber Source SOAP API (37) | http://www.cybersource.com |
| eWay XML API (Australia) (38) | http://www.eway.com.au/ |
| goEmerchant XML (39) | http://www.goemerchant.com/ |
| TransFirst eLink (40) | http://www.transfirst.com |
| Chase Merchant Services (Linkpoint) (41) | http://www.chase.com |
| Thompson Merchant Services NexCommerce (iTransact mode) (42) | http://www.thompsonmerchant.com |
| WorldPay Select Junior Invisible (43) | http://www.worldpay.com |
| TransFirst Transaction Central Classic (44) | http://www.transfirst.com. (This is different from TransFirst eLink, supported above. The TransactionCentral gateway is also used by MerchantAnywhere and PRIGate) |
| Sterling SPOT XML API (HTTPS POST) (45) | http://www.sterlingpayment.com |
| PayJunction Trinity Gateway (46) | http://www.payjunction.com |
| SECPay (United Kingdom) API Solution(47) | http://www.secpay.com |
| Payment Express PXPost (48) | http://www.paymentexpress.com |
| Elavon/NOVA/My Virtual Merchant (49) | https://support.convergepay.com/s/ |
| Sage Payment Solutions (Bankcard HTTPS Post protocol) (50) | http://www.sagepayments.com |
| SecurePay (Script API/COM Object Interface) (51) | http://securepay.com |
| Moneris eSelect Plus USA (52) | http://www.moneris.com |
| Bambora / Beanstream Process Transaction API (53) | https://www.bambora.com/en/ca/ |
| Verifi Direct-Post API (54) | http://www.verifi.com |
| SagePay Direct (Previously Protx) (55) | https://www.opayo.uk/ |
| Merchant E-Solutions Payment Gateway (Trident API) (56) | http://merchante-solutions.com/ |
| PayLeap Web Services API (57) | http://www.payleap.com |
| PayPoint.net (Previously SECPay) API Solution (58) | http://paypoint.net |
| Worldpay XML (Direct/Invisible) (59) | http://www.worldpay.com |
| ProPay Merchant Services API (60) | http://www.propay.com |
| Intuit QuickBooks Merchant Services (QBMS) (61) | This gateway is no longer in service. It has been replaced by Quickbooks Payments (113). |
| Heartland POS Gateway (62) | http://www.heartlandpaymentsystems.com/ |
| Litle / Vantiv Online Gateway (63) | http://www.litle.com/ |
| BrainTree DirectPost (Server-to-Server Orange) Gateway (64) | http://www.braintreepaymentsolutions.com/ |
| JetPay Gateway (65) | http://www.jetpay.com/ |
| HSBC XML API (ClearCommerce Engine) (66) | https://www.business.hsbc.uk/en-gb/payments/business-card |
| BluePay 2.0 Post (67) | http://www.bluepay.com |
| Adyen API Payments (68) | http://www.adyen.com |
| Barclay ePDQ (DirectLink) (69) | http://www.barclaycard.co.uk/business/ |
| PayTrace Payment Gateway (70) | https://www.paytrace.net/ |
| YKC Gateway (71) | http://www.ykc-bos.co.jp/ |
| OmniFund HTTP API / GoToBilling(73) | http://omnifund.com/ |
| TransNational Bankcard (74) | http://www.tnbci.com/ |
| Netbanx (75) | http://www.netbanx.com/ |
| MIT (76) | http://www.centrodepagos.com.mx |
| DataCash (77) | http://www.datacash.com/ |
| ACH Federal (78) | http://www.achfederal.com/ |
| Global Iris (HSBC) (79) | https://www.globalpaymentsinc.com/en-gb |
| First Data Global Gateway E4 (80) | http://www.firstdata.com |
| First Atlantic Commerce (81) | http://www.firstatlanticcommerce.com/ |
| Bluefin (82) | http://www.bluefin.com/ |
| Payscape (83) | http://www.payscape.com |
| Pay Direct (Link2Gov) (84) | https://www.fisglobal.com/solutions/other/government/ |
| Authorize.NET CIM (85) | http://www.authorize.net |
| 5th Dimension Logistics (86) | http://www.5thdl.com/ |
| WorldPay US Link Gateway (87) | https://www.worldpay.com/en-us/index |
| 3DSI Payment WorkSuite (88) | http://www.3dsi.com/ |
| PSIGate XML (89) | http://www.psigate.com |
| First Data PayPoint (90) | https://www.firstdata.com/en_us/products/financial_institutions.html |
| ExPay Gateway (91) | http://www.expay.asia |
| Payvision Gateway (92) | http://www.payvision.com/ |
| Converge (formerly MyVirtualMerchant) (93) | https://support.convergepay.com/s/ |
| Payeezy Gateway (formerly First Data E4) (94) | https://developer.payeezy.com/ |
| Monetra Gateway (95) | http://www.monetra.com |
| Authorize.NET XML (96) | http://www.authorize.net/ |
| PhoeniXGate Gateway (97) | http://www.phoenixmanagednetworks.com/ |
| Repay Gateway (98) | https://www.repay.com/ |
| Global Payroll Gateway (99) | https://www.gpgway.com/ |
| PayWiser Gateway (100) | https://paywiser.eu/ |
| Veritas Gateway (101) | http://www.veritaspay.com/ |
| Stripe Gateway (102) | http://www.stripe.com/ |
| KartePay Gateway (103) | https://www.kartepay.com/ |
| BlueSnap Gateway (104) | https://home.bluesnap.com/ |
| American Payment Solutions (105) | https://www.apspayments.com/ |
| BASYS Gateway (106) | https://basyspro.com/ |
| Worldpay Online (107) | https://www.worldpay.com |
| Square (108) | https://www.squareup.com |
| Priority Payment Systems (109) | https://prioritypaymentsystems.com |
| Nuvei / GlobalOnePay (110) | https://nuvei.com/en-us/ |
| CardPointe (111) | https://cardconnect.com/cardpointe |
| Metrobank (112) | https://www.metrobankcard.com/ |
| Quickbooks Payments (113) | https://quickbooks.intuit.com/payments/ |
| Shift4 (114) | https://www.shift4.com/ |
| Square Payments (115) | https://squareup.com/us/en |
| Heartland Portico Gateway (116) | http://www.heartlandpaymentsystems.com/ |
| PayTrace Payment Gateway JSON (117) | https://www.paytrace.net/ |
gateway_url Property
Default URL for a specific Gateway .
Syntax
def get_gateway_url() -> str: ... def set_gateway_url(value: str) -> None: ...
gateway_url = property(get_gateway_url, set_gateway_url)
Default Value
""
Remarks
This property is used to change the default URL for a specific gateway. This is useful for specifying a different URL for testing purposes, or to support additional gateway processors that share a protocol format (such as additional Authorize.net compatible gateways). Please note that the proper "http://" or "https://" formatting must be observed. See "Testing Information" in the Table of Contents for a list of test URLs.
invoice_number Property
Merchant-generated invoice number.
Syntax
def get_invoice_number() -> str: ... def set_invoice_number(value: str) -> None: ...
invoice_number = property(get_invoice_number, set_invoice_number)
Default Value
""
Remarks
This field contains a merchant-generated invoice number. This number should be unique for each transaction. This property is optional for most gateways, but it is recommended that the merchant use an invoice number to keep track of transactions. See the gateway property to determine if this is a required or optional field for the gateway you are using.
level_2_aggregate Property
The level 2 aggregate containing the data to be sent in the request.
Syntax
def get_level_2_aggregate() -> str: ... def set_level_2_aggregate(value: str) -> None: ...
level_2_aggregate = property(get_level_2_aggregate, set_level_2_aggregate)
Default Value
""
Remarks
This property is used to specify the level 2 aggregate obtained from Level2 class. When specified, the class will parse the aggregate and send the specified values within the transaction request to process the transaction as a level 2 transaction.
level_3_aggregate Property
The level 3 aggregate containing the data to be sent in the request.
Syntax
def get_level_3_aggregate() -> str: ... def set_level_3_aggregate(value: str) -> None: ...
level_3_aggregate = property(get_level_3_aggregate, set_level_3_aggregate)
Default Value
""
Remarks
This property is used to specify the level 3 aggregate obtained from Level3 class. When specified, the class will parse the aggregate and send the specified values within the transaction request to process the transaction as a level 3 transaction.
merchant_login Property
Merchant's Gateway login.
Syntax
def get_merchant_login() -> str: ... def set_merchant_login(value: str) -> None: ...
merchant_login = property(get_merchant_login, set_merchant_login)
Default Value
""
Remarks
This is the login Id supplied by the gateway you signed up with to process credit card transactions.
merchant_password Property
Merchant's Gateway password.
Syntax
def get_merchant_password() -> str: ... def set_merchant_password(value: str) -> None: ...
merchant_password = property(get_merchant_password, set_merchant_password)
Default Value
""
Remarks
This is the password supplied by the gateway you signed up with to process credit card transactions. Some gateways require passwords only for Credit or Void transactions, some require it for all transactions, and some do not require this field at all.
proxy_auth_scheme Property
This property is used to tell the class which type of authorization to perform when connecting to the proxy.
Syntax
def get_proxy_auth_scheme() -> int: ... def set_proxy_auth_scheme(value: int) -> None: ...
proxy_auth_scheme = property(get_proxy_auth_scheme, set_proxy_auth_scheme)
Default Value
0
Remarks
This property is used to tell the class which type of authorization to perform when connecting to the proxy. This is used only when the proxy_user and proxy_password properties are set.
proxy_auth_scheme should be set to authNone (3) when no authentication is expected.
By default, proxy_auth_scheme is authBasic (0), and if the proxy_user and proxy_password properties are set, the component will attempt basic authentication.
If proxy_auth_scheme is set to authDigest (1), digest authentication will be attempted instead.
If proxy_auth_scheme is set to authProprietary (2), then the authorization token will not be generated by the class. Look at the configuration file for the class being used to find more information about manually setting this token.
If proxy_auth_scheme is set to authNtlm (4), NTLM authentication will be used.
For security reasons, setting this property will clear the values of proxy_user and proxy_password.
proxy_auto_detect Property
This property tells the class whether or not to automatically detect and use proxy system settings, if available.
Syntax
def get_proxy_auto_detect() -> bool: ... def set_proxy_auto_detect(value: bool) -> None: ...
proxy_auto_detect = property(get_proxy_auto_detect, set_proxy_auto_detect)
Default Value
FALSE
Remarks
This property tells the class whether or not to automatically detect and use proxy system settings, if available. The default value is False.
proxy_password Property
This property contains a password if authentication is to be used for the proxy.
Syntax
def get_proxy_password() -> str: ... def set_proxy_password(value: str) -> None: ...
proxy_password = property(get_proxy_password, set_proxy_password)
Default Value
""
Remarks
This property contains a password if authentication is to be used for the proxy.
If proxy_auth_scheme is set to Basic Authentication, the proxy_user and proxy_password are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].
If proxy_auth_scheme is set to Digest Authentication, the proxy_user and proxy_password properties are used to respond to the Digest Authentication challenge from the server.
If proxy_auth_scheme is set to NTLM Authentication, the proxy_user and proxy_password properties are used to authenticate through NTLM negotiation.
proxy_port Property
This property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80).
Syntax
def get_proxy_port() -> int: ... def set_proxy_port(value: int) -> None: ...
proxy_port = property(get_proxy_port, set_proxy_port)
Default Value
80
Remarks
This property contains the Transmission Control Protocol (TCP) port for the proxy proxy_server (default 80). See the description of the proxy_server property for details.
proxy_server Property
If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
Syntax
def get_proxy_server() -> str: ... def set_proxy_server(value: str) -> None: ...
proxy_server = property(get_proxy_server, set_proxy_server)
Default Value
""
Remarks
If a proxy proxy_server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
If the proxy_server property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the proxy_server property is set to the corresponding address. If the search is not successful, an error is returned.
proxy_ssl Property
This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy.
Syntax
def get_proxy_ssl() -> int: ... def set_proxy_ssl(value: int) -> None: ...
proxy_ssl = property(get_proxy_ssl, set_proxy_ssl)
Default Value
0
Remarks
This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:
| psAutomatic (0) | Default setting. If the url is an https URL, the class will use the psTunnel option. If the url is an http URL, the class will use the psNever option. |
| psAlways (1) | The connection is always SSL enabled. |
| psNever (2) | The connection is not SSL enabled. |
| psTunnel (3) | The connection is made through a tunneling (HTTP) proxy. |
proxy_user Property
This property contains a user name, if authentication is to be used for the proxy.
Syntax
def get_proxy_user() -> str: ... def set_proxy_user(value: str) -> None: ...
proxy_user = property(get_proxy_user, set_proxy_user)
Default Value
""
Remarks
This property contains a user name, if authentication is to be used for the proxy.
If proxy_auth_scheme is set to Basic Authentication, the proxy_user and proxy_password are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].
If proxy_auth_scheme is set to Digest Authentication, the proxy_user and proxy_password properties are used to respond to the Digest Authentication challenge from the server.
If proxy_auth_scheme is set to NTLM Authentication, the proxy_user and proxy_password properties are used to authenticate through NTLM negotiation.
response_approval_code Property
Contains an authorization code when a transaction has been approved.
Syntax
def get_response_approval_code() -> str: ...
response_approval_code = property(get_response_approval_code, None)
Default Value
""
Remarks
Contains an authorization code when a transaction has been approved. This property contains an authorization code when a transaction has been approved. If the response_code returned indicates that the transaction is not approved, then the contents of this property should be ignored.
This property is read-only.
response_approved Property
Indicates the status of the last transaction.
Syntax
def get_response_approved() -> bool: ...
response_approved = property(get_response_approved, None)
Default Value
FALSE
Remarks
Indicates the status of the last transaction. This property will be True if the last transaction was approved. However, you should not rely solely on the value contained in this property. After every transaction, the response_code should be inspected and evaluated according to the specifications of the Gateway in use. A list of response codes for each gateway is listed in the table of contents. However, it is recommended that the developer acquire the current list from the Gateway which is being used.
This property is read-only.
response_approved_amount Property
The amount approved for the transaction, this is the amount actually charged to the credit card.
Syntax
def get_response_approved_amount() -> str: ...
response_approved_amount = property(get_response_approved_amount, None)
Default Value
""
Remarks
The amount approved for the transaction, this is the amount actually charged to the credit card.
This property is primarily used when gateways allow partial authorizations and AllowPartialAuths is 'True'. Thus this property is not used by all gateways and should not alone be used to determine if a transaction was successful (such as in the case that this property is not populated).
This property is read-only.
response_avs_result Property
Contains the Address Verification System result code.
Syntax
def get_response_avs_result() -> str: ...
response_avs_result = property(get_response_avs_result, None)
Default Value
""
Remarks
Contains the Address Verification System result code. This one character property contains the Address Verification Service (AVS) result code. An AVS result code can provide additional information concerning the authentication of a particular transaction for which cardholder address verification was requested. An AVS result code of "0" will be returned in the response message when no address verification has been requested. The value returned should be stored for later retrieval, as it may be required when voiding or refunding a transaction. Valid AVS response codes are listed below, and are identical across all Gateway (note that some gateways do not return an AVS response).
| response_avs_result | Description |
| A | Address matches, Zip does not. |
| E | AVS error. |
| G | Non-U.S. issuing bank does not support AVS. |
| N | No match on Address or CustomerZip. |
| P | AVS not applicable for this transaction. |
| R | Retry - Issuer system unavailable. |
| S | Service not supported by issuer. |
| U | Address information is unavailable. |
| W | Nine digit Zip matches, Address does not. |
| X | Exact AVS match, nine digit Zip. |
| Y | Exact AVS match, five digit Zip. |
| Z | Five digit Zip matches, Address does not. |
Note: Some gateways use their own response codes instead of those in the above table; those response codes are detailed below for such gateways.
Adyen
For Adyen, this property will contain the following possible values:
| 0 | Unknown |
| 1 | Address matches, postal code doesn't |
| 2 | Neither postal code nor address match |
| 3 | AVS unavailable |
| 4 | AVS not supported for this card type |
| 5 | No AVS data provided |
| 6 | Postal code matches, address doesn't match |
| 7 | Both postal code and address match |
| 8 | Address not checked, postal code unknown |
| 9 | Address matches, postal code unknown |
| 10 | Address doesn't match, postal code unknown |
| 11 | Postal code not checked, address unknown |
| 12 | Address matches, postal code not checked |
| 13 | Address doesn't match, postal code not checked |
| 14 | Postal code matches, address unknown |
| 15 | Postal code matches, address not checked |
| 16 | Postal code doesn't match, address unknown |
| 17 | Postal code doesn't match, address not checked |
| 18 | Neither postal code nor address were checked |
American Payment Solutions
For American Payment Solutions, this property will contain the following possible values:
| X | Exact match, 9-character numeric ZIP |
| Y, D, or M | Exact match, 5-character numeric ZIP |
| 2 or 6 | Exact match, 5-character numeric ZIP, customer name |
| A or B | Address match only |
| 3 or 7 | Address, customer name match only |
| W | 9-character numeric ZIP match only |
| Z, P, or L | 5-character ZIP match only |
| 1 or 5 | 5-character ZIP, customer name match only |
| N or C | No address or ZIP match only |
| 4 or 8 | No address or ZIP or customer name match only |
| U | Address unavailable |
| G or I | Non-U.S. issuer does not participate |
| R | Issuer system unavailable |
| E | Not a mail/phone order |
| S | Service not supported |
| 0, O, or B | AVS not available |
Barclay
For Barclay, the property will contain the following possible values:
| YY | Address and zip code or postal code match |
| YN | Address matches only |
| NY | Zip code or postal code matches |
| NN | Neither address nor zip code or postal code matches; address is not parsable |
| UU | Address information is unavailable, service is unavailable, or Error; Unknown |
| Blank | No AVS performed |
BlueSnap
For BlueSnap, the property will contain a 3-character string (if AVS checks were done), which contains the AVS checks for the following properties:
| 1st Character | Name AVS check |
| 2nd Character | Address AVS check |
| 3rd Character | Postal/Zip Code AVS check |
The possible values for each result character are:
| M | Matches |
| N | Does not match |
| U | Could not be verified |
HSBC
For HSBC, the property will contain the following possible values:
| YY | Address and zip code or postal code match |
| YN | Address matches only |
| NY | Zip code or postal code matches |
| NN | Neither address nor zip code or postal code matches; address is not parsable |
| UU | Address information is unavailable, service is unavailable, or Error; Unknown |
| FF | Issuer does not participate in AVS |
| Blank | No AVS performed |
PayTrace / PayTraceJSON
For PayTrace / PayTraceJSON, the property will contain the following possible values:
| Full Exact Match | |
| Address Match Only | |
| Zip Match Only | |
| No Match | |
| Address Unavailable | |
| Non-US Issuer does not participate | |
| Issuer System Unavailable | |
| Not a Mail/Phone Order | |
| Service Not Supported |
QBMS
For the QBMS gateway, the response_avs_result property will contain the result for the street address, a comma, and then the result for the zip code. The values returned are "Pass", "Fail", and "NotAvailable". Therefore, an response_avs_result of "Fail,Pass" means that the street address failed validation, but the zip code passed.
DataCash
For DataCash, the property will contain the following possible values (of which correspond to both AVS and CVV checks):
| NO DATA MATCHES | |
| ADDRESS MATCH ONLY | |
| SECURITY CODE MATCH ONLY | |
| ALL MATCH | |
| DATA NOT CHECKED |
Stripe
For Stripe, the property will contain the following possible values:
| Pass | The first address line or zip code provided is correct. |
| Fail | The first address line or zip code provided is incorrect. |
| Unavailable | The customer's bank did not check the first address line or zip code provided. |
| Unchecked | The first address line or zip code was provided but has not yet been checked. |
Worldpay
For Worldpay, the property will contain a 4-character string, which contains the AVS checks for the following properties:
| 1st Character | Card Verification Value (CVV) check |
| 2nd Character | Postal/Zip Code AVS check |
| 3rd Character | Address AVS check |
| 4th Character | Country Comparison check |
The possible values for each result character are:
| 0 | Not Supported. |
| 1 | Not Checked. |
| 2 | Matched. |
| 4 | No Match. |
| 8 | Partial Match. |
Worldpay Online
For Worldpay Online, the property will contain one of the following:
| Value | Description |
| APPROVED | The supplied street and postal code details fully matched the payment provider's records |
| PARTIAL APPROVED | One of the supplied street or postal code details did not match the payment provider's records |
| NOT SENT TO ACQUIRER | Problem with acquirer - possibly no AVS support |
| NO RESPONSE FROM ACQUIRER | Problem with acquirer - possibly no AVS support |
| NOT CHECKED BY ACQUIRER | The acquirer did not check the address details |
| NOT SUPPLIED BY SHOPPER | Missing, incomplete or invalid address details in the order prevented the address from being checked |
| FAILED | Both street and postal code details did not match the payment provider's records |
This property is read-only.
response_code Property
Indicates the status of the authorization request.
Syntax
def get_response_code() -> str: ...
response_code = property(get_response_code, None)
Default Value
""
Remarks
Indicates the status of the authorization request. This property contains the actual response code as returned by the Gateway. Unlike the response_approved property, this response_code property may provide more details about why a transaction was declined. Therefore, it is recommended that developers check the response_code as well as the response_approved property. The Point of Sale system should evaluate this response code and NOT the response_text to determine nature of a response message. The current (at the time of this release) response codes for the supported Gateways are listed in the table of contents to your left.
This property is read-only.
response_cvv_result Property
Contains the returned CVV2 result code if it was requested.
Syntax
def get_response_cvv_result() -> str: ...
response_cvv_result = property(get_response_cvv_result, None)
Default Value
""
Remarks
Contains the returned CVV2 result code if it was requested. This property contains the host returned CVV2 result code (if CVV data was sent in the request). The following is a list of current result codes:
| M | CVV2 Match. |
| N | CVV2 No Match. |
| P | Not Processed. |
| S | Merchant has indicated that CVV2 is not present on card. |
| U | Issuer not certified and/or has not provided Visa encryption keys. |
Note: Some gateways use their own response codes instead of those in the above table; those response codes are detailed below for such gateways.
HSBC
For HSBC, the property will contain:
| 0 | Card type does not support CVM |
| 1 | CVM match |
| 2 | CVM did not match issuer value |
| 3 | CVM was not processed |
| 4 | CVM should be on the card but cardholder indicated otherwise |
| 5 | CVM not supported by issuer |
| 6 | Not valid |
| 7 | No response from server |
Adyen
For Adyen, the property will contain:
| 0 | Unknown |
| 1 | Matches |
| 2 | Does not match |
| 3 | Not checked |
| 4 | No CVC/CVV provided, but was required |
| 5 | Issuer not certified for CVC/CVV |
| 6 | No CVC/CVV provided |
Barclay
For Barclay, the property will contain:
| 0,1 | CVM was not processed |
| 2 | CVM match |
| 4 | CVM does not match issuer value |
| Unknown | CVM invalid or missing |
| Blank | No response from server |
BlueSnap
For BlueSnap, the property will contain:
| MA | Match |
| NC | Issuer is not certified for CVV2/CVC2/CID |
| ND | Check was not done |
| NM | No match |
| NP | CVV2/CVC2/CID should be on the card but is not present |
| NR | CVV check not requested |
DataCash
For DataCash, the property will contain the following possible values (of which correspond to both AVS and CVV checks):
| NO DATA MATCHES | |
| ADDRESS MATCH ONLY | |
| SECURITY CODE MATCH ONLY | |
| ALL MATCH | |
| DATA NOT CHECKED |
Stripe
For Stripe, the property will contain the following possible values:
| Pass | The CVC provided is correct. |
| Fail | The CVC provided is incorrect. |
| Unavailable | The customer's bank did not check the CVC provided. |
| Unchecked | The CVC was provided but has not yet been checked. |
Worldpay Online
For Worldpay Online, the property will contain one of the following:
| Value | Description |
| APPROVED | The supplied CVC details matched the payment provider's records |
| NOT SENT TO ACQUIRER | Problem with acquirer - possibly no CVC support |
| NO RESPONSE FROM ACQUIRER | Problem with acquirer - possibly no CVC support |
| NOT CHECKED BY ACQUIRER | The acquirer did not check the CVC details |
| NOT SUPPLIED BY SHOPPER | Missing, or invalid CVC in the payment details prevented the CVC from being checked |
| FAILED | The supplied CVC did not match the payment provider's records |
This property is read-only.
response_data Property
The entire response returned from the gateway processor.
Syntax
def get_response_data() -> str: ...
response_data = property(get_response_data, None)
Default Value
""
Remarks
The entire response returned from the gateway processor. This property contains the entire response returned from the gateway processor. You may use this to parse additional information that is not returned in the standard response properties.
This property is read-only.
response_error_code Property
Additional error code returned by some gateways.
Syntax
def get_response_error_code() -> str: ...
response_error_code = property(get_response_error_code, None)
Default Value
""
Remarks
Additional error code returned by some gateways. If a gateway returns it, this property will contain an additional code that may explain why the transaction was declined. You may also wish to inspect response_error_text for a human-readable description of this response_error_code.
This property is read-only.
response_error_text Property
Additional error description returned by some gateways.
Syntax
def get_response_error_text() -> str: ...
response_error_text = property(get_response_error_text, None)
Default Value
""
Remarks
Additional error description returned by some gateways. If a gateway returns it, this property will contain a human-readable description of the error which occurred (if any). You may also wish to inspect response_error_code for an accompanying code which may be parsed and used by your application.
This property is read-only.
response_invoice_number Property
Invoice number submitted in authorization request (if applicable).
Syntax
def get_response_invoice_number() -> str: ...
response_invoice_number = property(get_response_invoice_number, None)
Default Value
""
Remarks
Invoice number submitted in authorization request (if applicable). This property contains the Invoice Number submitted in the original transaction, echoed back by the Gateway host.
This property is read-only.
response_processor_code Property
Response code from the underlying processor.
Syntax
def get_response_processor_code() -> str: ...
response_processor_code = property(get_response_processor_code, None)
Default Value
""
Remarks
Response code from the underlying processor. Often times a Gateway will return a response_code that indicates only whether the transaction is approved or declined. Many of these also include a secondary code that provides more details as to why the transaction was declined.
Note, for the PayFlowPro gateway this property will contain a "1" if the transaction was a duplicate, a "-1" if duplicate checking service is unavailable, and will be blank for a successfully authorized transaction.
This property is read-only.
response_text Property
Text information that describes each response code.
Syntax
def get_response_text() -> str: ...
response_text = property(get_response_text, None)
Default Value
""
Remarks
Text information that describes each response code. This property contains a response or display text message. This message can be used by the terminal to display the authorization result. The display text must not be used to determine the nature of a response message. A Gateway may translate the response according to the language indicated in the merchant account setup (if applicable).
This property is read-only.
response_transaction_id Property
Contains the Visa Transaction Identifier or MasterCard Reference Number.
Syntax
def get_response_transaction_id() -> str: ...
response_transaction_id = property(get_response_transaction_id, None)
Default Value
""
Remarks
Contains the Visa Transaction Identifier or MasterCard Reference Number. This property contains a transaction identifier or reference number. The Point of Sale (POS) device should not attempt to interpret the meaning of any data appearing in this property. Data returned in this property (if any) should be recorded and used to submit a modification of this transaction at a later time (such as voiding the transaction or capturing an authorization-only transaction, if applicable).
This property is read-only.
shipping_address Property
Customer's shipping street address.
Syntax
def get_shipping_address() -> str: ... def set_shipping_address(value: str) -> None: ...
shipping_address = property(get_shipping_address, set_shipping_address)
Default Value
""
Remarks
Customer's shipping street address.
shipping_address2 Property
A specific detail on the customer's shipping address (such as building, suite, apartment, floor number etc.
Syntax
def get_shipping_address2() -> str: ... def set_shipping_address2(value: str) -> None: ...
shipping_address2 = property(get_shipping_address2, set_shipping_address2)
Default Value
""
Remarks
A specific detail on the customer's shipping address (such as building, suite, apartment, floor number etc.).
shipping_city Property
Customer's shipping city.
Syntax
def get_shipping_city() -> str: ... def set_shipping_city(value: str) -> None: ...
shipping_city = property(get_shipping_city, set_shipping_city)
Default Value
""
Remarks
Customer's shipping city.
shipping_country Property
Customer's shipping country.
Syntax
def get_shipping_country() -> str: ... def set_shipping_country(value: str) -> None: ...
shipping_country = property(get_shipping_country, set_shipping_country)
Default Value
""
Remarks
Customer's shipping country. This property contains the country in which the customer is located. Most gateways use a two-letter country code, specified in ISO-3166.
shipping_email Property
Customer's email address.
Syntax
def get_shipping_email() -> str: ... def set_shipping_email(value: str) -> None: ...
shipping_email = property(get_shipping_email, set_shipping_email)
Default Value
""
Remarks
Customer's email address.
shipping_first_name Property
Customer's first name.
Syntax
def get_shipping_first_name() -> str: ... def set_shipping_first_name(value: str) -> None: ...
shipping_first_name = property(get_shipping_first_name, set_shipping_first_name)
Default Value
""
Remarks
Customer's first name.
shipping_last_name Property
Customer's last name.
Syntax
def get_shipping_last_name() -> str: ... def set_shipping_last_name(value: str) -> None: ...
shipping_last_name = property(get_shipping_last_name, set_shipping_last_name)
Default Value
""
Remarks
Customer's last name.
shipping_phone Property
Customer's phone number.
Syntax
def get_shipping_phone() -> str: ... def set_shipping_phone(value: str) -> None: ...
shipping_phone = property(get_shipping_phone, set_shipping_phone)
Default Value
""
Remarks
Customer's phone number.
shipping_state Property
Customer's shipping state.
Syntax
def get_shipping_state() -> str: ... def set_shipping_state(value: str) -> None: ...
shipping_state = property(get_shipping_state, set_shipping_state)
Default Value
""
Remarks
Customer's shipping state.
shipping_zip Property
Customer's shipping zip code (or postal code if outside of the USA).
Syntax
def get_shipping_zip() -> str: ... def set_shipping_zip(value: str) -> None: ...
shipping_zip = property(get_shipping_zip, set_shipping_zip)
Default Value
""
Remarks
Customer's shipping zip code (or postal code if outside of the USA).
special_field_count Property
The number of records in the SpecialField arrays.
Syntax
def get_special_field_count() -> int: ... def set_special_field_count(value: int) -> None: ...
special_field_count = property(get_special_field_count, set_special_field_count)
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at special_field_count - 1.special_field_name Property
Name of special configuration property to submit in this transaction.
Syntax
def get_special_field_name(field_index: int) -> str: ... def set_special_field_name(field_index: int, value: str) -> None: ...
Default Value
""
Remarks
Name of special configuration field to submit in this transaction. The special_field_name and special_field_value properties can be used to send special gateway configuration and transaction properties for each transaction. These properties can also be used to extend the functionality of this class by submitting additional information to the gateway.
This property is not applicable for the LinkPoint, FirstData, YourPay, PayFuse, or Orbital gateways.
The field_index parameter specifies the index of the item in the array. The size of the array is controlled by the special_field_count property.
special_field_value Property
Value of special configuration property to submit in this transaction.
Syntax
def get_special_field_value(field_index: int) -> str: ... def set_special_field_value(field_index: int, value: str) -> None: ...
Default Value
""
Remarks
Value of special configuration field to submit in this transaction. The special_field_name and special_field_value properties can be used to send special gateway configuration and transaction properties for each transaction. These properties can also be used to extend the functionality of this class by submitting additional information to the gateway.
Note: This property is not applicable for the LinkPoint, FirstData, YourPay, PayFuse, or Orbital gateways.
The field_index parameter specifies the index of the item in the array. The size of the array is controlled by the special_field_count property.
ssl_accept_server_cert_encoded Property
This is the certificate (PEM/base64 encoded).
Syntax
def get_ssl_accept_server_cert_encoded() -> bytes: ... def set_ssl_accept_server_cert_encoded(value: bytes) -> None: ...
ssl_accept_server_cert_encoded = property(get_ssl_accept_server_cert_encoded, set_ssl_accept_server_cert_encoded)
Default Value
""
Remarks
This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The ssl_accept_server_cert_store and ssl_accept_server_cert_subject properties also may be used to specify a certificate.
When ssl_accept_server_cert_encoded is set, a search is initiated in the current ssl_accept_server_cert_store for the private key of the certificate. If the key is found, ssl_accept_server_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssl_accept_server_cert_subject is set to an empty string.
ssl_cert_encoded Property
This is the certificate (PEM/base64 encoded).
Syntax
def get_ssl_cert_encoded() -> bytes: ... def set_ssl_cert_encoded(value: bytes) -> None: ...
ssl_cert_encoded = property(get_ssl_cert_encoded, set_ssl_cert_encoded)
Default Value
""
Remarks
This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The ssl_cert_store and ssl_cert_subject properties also may be used to specify a certificate.
When ssl_cert_encoded is set, a search is initiated in the current ssl_cert_store for the private key of the certificate. If the key is found, ssl_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssl_cert_subject is set to an empty string.
ssl_cert_store Property
This is the name of the certificate store for the client certificate.
Syntax
def get_ssl_cert_store() -> bytes: ... def set_ssl_cert_store(value: bytes) -> None: ...
ssl_cert_store = property(get_ssl_cert_store, set_ssl_cert_store)
Default Value
"MY"
Remarks
This is the name of the certificate store for the client certificate.
The ssl_cert_store_type property denotes the type of the certificate store specified by ssl_cert_store. If the store is password protected, specify the password in ssl_cert_store_password.
ssl_cert_store is used in conjunction with the ssl_cert_subject property to specify client certificates. If ssl_cert_store has a value, and ssl_cert_subject or ssl_cert_encoded is set, a search for a certificate is initiated. Please see the ssl_cert_subject property for details.
Designations of certificate stores are platform-dependent.
The following are designations of the most common User and Machine certificate stores in Windows:
| MY | A certificate store holding personal certificates with their associated private keys. |
| CA | Certifying authority certificates. |
| ROOT | Root certificates. |
When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).
ssl_cert_store_password Property
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Syntax
def get_ssl_cert_store_password() -> str: ... def set_ssl_cert_store_password(value: str) -> None: ...
ssl_cert_store_password = property(get_ssl_cert_store_password, set_ssl_cert_store_password)
Default Value
""
Remarks
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
ssl_cert_store_type Property
This is the type of certificate store for this certificate.
Syntax
def get_ssl_cert_store_type() -> int: ... def set_ssl_cert_store_type(value: int) -> None: ...
ssl_cert_store_type = property(get_ssl_cert_store_type, set_ssl_cert_store_type)
Default Value
0
Remarks
This is the type of certificate store for this certificate.
The class supports both public and private keys in a variety of formats. When the cstAuto value is used the class will automatically determine the type. This property can take one of the following values:
| 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note: this store type is not available in Java. |
| 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. Note: this store type is not available in Java. |
| 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS12) file containing certificates. |
| 3 (cstPFXBlob) | The certificate store is a string (binary or base64-encoded) representing a certificate store in PFX (PKCS12) format. |
| 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. Note: this store type is only available in Java. |
| 5 (cstJKSBlob) | The certificate store is a string (binary or base64-encoded) representing a certificate store in Java Key Store (JKS) format. Note: this store type is only available in Java. |
| 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
| 7 (cstPEMKeyBlob) | The certificate store is a string (binary or base64-encoded) that contains a private key and an optional certificate. |
| 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
| 9 (cstPublicKeyBlob) | The certificate store is a string (binary or base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
| 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or base64-encoded) that contains an SSH-style public key. |
| 11 (cstP7BFile) | The certificate store is the name of a PKCS7 file containing certificates. |
| 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS7 format. |
| 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
| 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
| 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
| 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
| 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
| 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
| 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
| 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). Note: this store type is only available in Java and .NET. |
| 22 (cstBCFKSBlob) | The certificate store is a string (binary or base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. Note: this store type is only available in Java and .NET. |
| 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS11 interface.
To use a security key the necessary data must first be collected using the CertMgr class. The list_store_certificates method may be called after setting cert_store_type to cstPKCS11, cert_store_password to the PIN, and cert_store to the full path of the PKCS11 dll. The certificate information returned in the on_cert_list event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the ssl_cert_store and set ssl_cert_store_password to the PIN. Code Example: SSH Authentication with Security Key
|
| 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |
ssl_cert_subject Property
This is the subject of the certificate used for client authentication.
Syntax
def get_ssl_cert_subject() -> str: ... def set_ssl_cert_subject(value: str) -> None: ...
ssl_cert_subject = property(get_ssl_cert_subject, set_ssl_cert_subject)
Default Value
""
Remarks
This is the subject of the certificate used for client authentication.
This property must be set after all other certificate properites are set. When this property is set, a search is performed in the current certificate store certificate with matching subject.
If a matching certificate is found, the property is set to the full subject of the matching certificate.
If an exact match is not found, the store is searched for subjects containing the value of the property.
If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks a random certificate in the certificate store.
The certificate subject is a comma separated list of distinguished name fields and values. For instance "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are displayed below.
| Field | Meaning |
| CN | Common Name. This is commonly a host name like www.server.com. |
| O | Organization |
| OU | Organizational Unit |
| L | Locality |
| S | State |
| C | Country |
| E | Email Address |
If a field value contains a comma it must be quoted.
ssl_provider Property
This specifies the SSL/TLS implementation to use.
Syntax
def get_ssl_provider() -> int: ... def set_ssl_provider(value: int) -> None: ...
ssl_provider = property(get_ssl_provider, set_ssl_provider)
Default Value
0
Remarks
This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic) the class will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.
Possible values are:
| 0 (sslpAutomatic - default) | Automatically selects the appropriate implementation. |
| 1 (sslpPlatform) | Uses the platform/system implementation. |
| 2 (sslpInternal) | Uses the internal implementation. |
In most cases using the default value (Automatic) is recommended. The class will select a provider depending on the current platform.
When Automatic is selected, on Windows the class will use the platform implementation. On Linux/macOS the class will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used on all platforms.
ssl_server_cert_encoded Property
This is the certificate (PEM/base64 encoded).
Syntax
def get_ssl_server_cert_encoded() -> bytes: ...
ssl_server_cert_encoded = property(get_ssl_server_cert_encoded, None)
Default Value
""
Remarks
This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The ssl_server_cert_store and ssl_server_cert_subject properties also may be used to specify a certificate.
When ssl_server_cert_encoded is set, a search is initiated in the current ssl_server_cert_store for the private key of the certificate. If the key is found, ssl_server_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssl_server_cert_subject is set to an empty string.
This property is read-only.
test_mode Property
Turns test mode on and off for transactions sent to the current Gateway .
Syntax
def get_test_mode() -> bool: ... def set_test_mode(value: bool) -> None: ...
test_mode = property(get_test_mode, set_test_mode)
Default Value
FALSE
Remarks
You can use this property to set a test mode flag that will be sent in an authorization request. Not all gateways support test modes. If you set the test_mode property to True and the current gateway does not support it, the class will fails with an error.
timeout Property
A timeout for the class.
Syntax
def get_timeout() -> int: ... def set_timeout(value: int) -> None: ...
timeout = property(get_timeout, set_timeout)
Default Value
30
Remarks
If timeout is set to a positive value, and an operation cannot be completed immediately, the class will retry the operation for a maximum of timeout seconds.
The default value for timeout is 30 (seconds).
transaction_amount Property
Purchase amount for an authorization transaction.
Syntax
def get_transaction_amount() -> str: ... def set_transaction_amount(value: str) -> None: ...
transaction_amount = property(get_transaction_amount, set_transaction_amount)
Default Value
""
Remarks
This field contains the transaction amount to be authorized. Gateways may have differing requirements for how the TransactionAmount should be formatted, so refer to the ICharge Gateway Setup page for details on the gateway you are using.
transaction_desc Property
Description of goods purchased.
Syntax
def get_transaction_desc() -> str: ... def set_transaction_desc(value: str) -> None: ...
transaction_desc = property(get_transaction_desc, set_transaction_desc)
Default Value
""
Remarks
This field contains a description of the goods or services being purchased. Please see the "ICharge Gateway Setup and Required Properties" page to determine if this is a required or optional field for the gateway you are using.
transaction_id Property
Merchant-generated transaction Id used for all transactions.
Syntax
def get_transaction_id() -> str: ... def set_transaction_id(value: str) -> None: ...
transaction_id = property(get_transaction_id, set_transaction_id)
Default Value
""
Remarks
This property is used to send a merchant-generated transaction id to the gateway, if the gateway supports that feature.
add_special_field Method
Adds a special field name and the corresponding value.
Syntax
def add_special_field(name: str, value: str) -> None: ...
Remarks
Please refer to the special_field_name and special_field_value properties for more information on form variables and how they are managed.
auth_only Method
Initiates an authorization-only request transaction.
Syntax
def auth_only() -> None: ...
Remarks
This method sends an authorization-only request to the specified gateway. This transaction is not added to the current open batch, and must be completed later with the capture method (you may use the sale method if you wish to authorize and capture in one step).
Note: If the gateway does not support this method, the class will fails with an error.
avs_only Method
Used to check the validity of the card without authorizing funds.
Syntax
def avs_only() -> None: ...
Remarks
This method can be used if you wish to perform fraud (AVS and CVV) checks on a card, but don't actually wish to charge the customer. This is useful for pre-ordering an item that has not yet been released or is currently back- ordered. The card information is validated by the merchant, and when the item is later in stock and ships to the customer, an sale transaction can be performed.
Note: If the gateway does not support this method, the class will fails with an error.
capture Method
Captures a previously authorized transaction.
Syntax
def capture(transaction_id: str, capture_amount: str) -> None: ...
Remarks
This method captures a transaction that has been previously authorized with the auth_only method. The TransactionId parameter indicates to the gateway which transaction is to be captured, and should contain the response_transaction_id from the original transaction. The CaptureAmount parameter is the value to be captured from the customer's credit card, and can be different from the authorized amount.
Please see the gateway information in the table of contents to determine if your gateway supports Capture transactions.
The LinkPoint and PSIGateXML gateways require you send the response_invoice_number rather than the response_transaction_id.
The SecurePay gateway does not require the TransactionId for captures. Instead, you must send the response_approval_code returned from the original response in the auth_code property.
The MyVirtualMerchant and Converge gateways do not require the TransactionId for captures. Instead, you must send the response_approval_code returned from the original response in the auth_code property. Note that there is a new capture transaction type available for these gateways. To use the new transaction type, set the MyVirtualMerchantTransactionType to "CCCOMPLETE" and call capture like normal. When using this transaction type, TransactionId is required and response_approval_code is not applicable.
config Method
Sets or retrieves a configuration setting.
Syntax
def config(configuration_string: str) -> str: ...
Remarks
config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.
These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the config method.
To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).
To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.
credit Method
Credits a customer's card.
Syntax
def credit() -> None: ...
Remarks
This method credits a customer's card specified via card. This type of transaction is NOT based on previous transaction. Some gateways refer to these as "Open" or "Blind" Credits.
transaction_amount is used to specify the amount you wish to return to the customer's card.
Please see the gateway information in the table of contents to determine if your gateway supports Credit transactions.
do_events Method
Processes events from the internal message queue.
Syntax
def do_events() -> None: ...
Remarks
When do_events is called, the class processes any available events. If no events are available, it waits for a preset period of time, and then returns.
force Method
Used when authorization cannot be obtained online.
Syntax
def force(voice_auth_code: str) -> None: ...
Remarks
This method is used when the response to a sale or auth_only request indicates that voice authorization is required. The merchant then telephones the call center and receives a voice authorization code. Calling the force method with this code in the VoiceAuthCode parameter will complete the transaction.
Note: If the gateway does not support this method, the class will fails with an error.
get_response_var Method
Parses additional information out of the response.
Syntax
def get_response_var(name: str) -> str: ...
Remarks
Due to the fact that this class supports so many gateways, only the most commonly used response variables are parsed into the response properties. Any additional response information contained within the response_data may be retrieved with this get_response_var method. There are three formats for the response_data returned by the gateways this class supports: Name/value pairs, delimited list, or XML. The value you pass in the Name parameter changes based on these formats, as detailed below:
If the response_data property contains name/value pairs, pass the name in the Name parameter and this method will return the value. For instance, if response_data contains "ResponseCode=00&FraudScore=53&ApprovalCode=123456&...", calling GetResponseVar("FraudScore") will return "53".
However, if response_data contains a delimited list, pass the index of the field you wish to receive. For instance, if response_data contains "00|53|123456|...", calling GetResponseVar("1") will return "53".
Finally, if response_data contains XML, pass the xpath to the value you wish to receive. For instance, if response_data contains "<Response><Code>00</Code><FraudScore>53</FraudScore><ApprovalCode>123456</ApprovalCode></Response>", calling GetResponseVar("/Response/FraudScore") will return "53".
interrupt Method
Interrupts the current action.
Syntax
def interrupt() -> None: ...
Remarks
This method interrupts any processing that the class is currently executing.
refund Method
Refunds a previously captured transaction.
Syntax
def refund(transaction_id: str, refund_amount: str) -> None: ...
Remarks
This method refunds a transaction that has already been captured, or settled. If the transaction is still outstanding use the void_transaction method instead. The TransactionId parameter indicates to the gateway which transaction is to be refunded, and should contain the response_transaction_id from the original transaction. The RefundAmount parameter is the value to be refunded back to the customer, and can be all or part of the original transaction_amount
Please see the gateway information in the table of contents to determine if your gateway supports Refund transactions.
The gw3DSI gateway requires the following additional fields for Refund transactions:
class.AddSpecialField "UserId", "my 3DSI-assigned UserId" '(Different than merchant_login)
class.MerchantPassword = "my 3DSI-assigned Pwd"
The LinkPoint and PSIGateXML gateways require you send the response_invoice_number rather than the response_transaction_id.
reset Method
Clears all properties to their default values.
Syntax
def reset() -> None: ...
Remarks
This method clears all properties to their default values and returns the component to its default state.
reset_special_fields Method
Resets all special fields to the default settings.
Syntax
def reset_special_fields() -> None: ...
Remarks
This function resets all special gateway configuration fields to the default settings for the specified gateway.
Please refer to the special_field_name and special_field_value properties for more information on form variables and how they are managed.
sale Method
Initiates an Sale transaction (authorization and capture).
Syntax
def sale() -> None: ...
Remarks
Sends a basic sale transaction to the gateway. This transaction decrements the cardholder's open-to-buy funds for the transaction_amount, and the transaction is automatically added to the current open batch.
void_transaction Method
Voids a previously authorized transaction.
Syntax
def void_transaction(transaction_id: str) -> None: ...
Remarks
This method voids a transaction that has been previously authorized, but which has not yet gone to settlement, or been "captured". The TransactionId parameter indicates to the gateway which transaction is to be voided, and should contain the response_transaction_id from the original transaction.
Please see the gateway information in the table of contents to determine if your gateway supports Void transactions.
To cancel a transaction which has already been captured, use the credit method.
The LinkPoint gateway requires you send the response_invoice_number rather than the response_transaction_id.
For the PSIGateXML gateway, send the response_transaction_id as normal.
For the Heartland gateway, a reversal transaction will be sent when a transaction_amount is specified. Otherwise a void transaction will be sent.
on_error Event
Information about errors during data delivery.
Syntax
class IChargeErrorEventParams(object): @property def error_code() -> int: ... @property def description() -> str: ... # In class ICharge: @property def on_error() -> Callable[[IChargeErrorEventParams], None]: ... @on_error.setter def on_error(event_hook: Callable[[IChargeErrorEventParams], None]) -> None: ...
Remarks
The on_error event is fired in case of exceptional conditions during message processing.
ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.
on_ssl_server_authentication Event
Fired after the server presents its certificate to the client.
Syntax
class IChargeSSLServerAuthenticationEventParams(object): @property def cert_encoded() -> bytes: ... @property def cert_subject() -> str: ... @property def cert_issuer() -> str: ... @property def status() -> str: ... @property def accept() -> bool: ... @accept.setter def accept(value) -> None: ... # In class ICharge: @property def on_ssl_server_authentication() -> Callable[[IChargeSSLServerAuthenticationEventParams], None]: ... @on_ssl_server_authentication.setter def on_ssl_server_authentication(event_hook: Callable[[IChargeSSLServerAuthenticationEventParams], None]) -> None: ...
Remarks
This event is where the client can decide whether to continue with the connection process or not. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether to continue or not.
When Accept is False, Status shows why the verification failed (otherwise, Status contains the string "OK"). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.
on_ssl_status Event
Shows the progress of the secure connection.
Syntax
class IChargeSSLStatusEventParams(object): @property def message() -> str: ... # In class ICharge: @property def on_ssl_status() -> Callable[[IChargeSSLStatusEventParams], None]: ... @on_ssl_status.setter def on_ssl_status(event_hook: Callable[[IChargeSSLStatusEventParams], None]) -> None: ...
Remarks
The event is fired for informational and logging purposes only. Used to track the progress of the connection.
ICharge Config Settings
The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the config method.iCharge Config Settings | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
3DSAuthenticationStatus:
Indicates whether a transaction qualifies as a ThreeDSecure (3DS) authenticated transaction.This setting is used to pass the 3D Secure authentication status on to the transaction server. This component may
be used in conjunction with the ThreeDSecure component or with any other 3D Secure MPI implementation. Other values
necessary for passing 3D Secure data include 3DSCAVV, 3DSXID and 3DSECI.
This setting is only valid for E-Commerce transactions. Applicable values are:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 3DSCAVV: Cardholder Authentication Verification Value from a 3D Secure authentication.This setting is used to pass 3D Secure CAVV data on to the transaction server. This field must be formatted as a 28-byte Base-64 encoded value. This component may be used in conjunction with the ThreeDSecure component or with any other 3D Secure MPI implementation. Other values necessary for passing 3D Secure data include 3DSXID and 3DSECI. This setting is only valid for E-Commerce transactions. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 3DSDSTransactionId: Directory server transaction Id from a 3D Secure authentication.This setting is used to pass the directory server transaction Id to the gateway for 3DS 2.0. This component may be used in conjunction with the ThreeDSecure component or with any other 3D Secure MPI implementation. This setting is only valid for E-Commerce transactions. This setting is currently only supported when the gateway property is set to gwNetbanx. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 3DSECI: Electronic Commerce Indicator.This contains a 1-character transaction indicator identifying the type of transaction being authorized. Supported values vary between gateways, so please consult gateway documentation for more information. Note: Other values necessary for passing 3D Secure data are 3DSXID and 3DSCAVV. This setting is only valid for E-Commerce transactions. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 3DSEnrollmentStatus: Indicates whether 3D Secure authentication is available for the cardholder.This setting is used to pass the cardholder's 3D Secure enrollment status to the gateway for 3D Secure 1.0.2. This component may be used in conjunction with the ThreeDSecure component or with any other 3D Secure MPI implementation. This setting is only valid for E-Commerce transactions. This setting is currently only supported when the gateway property is set to gwNetbanx. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 3DSXID: TransactionId from a 3D Secure authentication.This setting is used to pass the 3D Secure TransactionId (XID) data on to the gateway. This setting must be formatted as a 20-byte plaintext value, or a 28-byte Base-64 encoded value. This component may be used in conjunction with the ThreeDSecure component or with any other 3D Secure MPI implementation. For example: Other settings necessary for passing 3D Secure data are 3DSCAVV and 3DSECI. This setting is only valid for E-Commerce transactions. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| AdyenShopperInteraction:
Specifies the sales channel the shopper gives their card details through.This configuration setting is used to specify the sales channel the shopper gives their card details through and whether the shopper is a returning customer. Default value is 0.
Available values are:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| AllowPartialAuths: Specifies whether partial authorizations are allowed.When set to 'True', partial authorizations will be allowed and must be handled accordingly. A partial authorization occurs when a customer's available funds for a specific card can only meet a portion of the total transaction_amount. Therefore a second means of payment must be used to pay for the remaining amount. When such a case occurs, the partially approved amount will be made available via response_approved_amount. When set to 'False', if a customer's card does not have funds the available to account for the entire transaction_amount the transaction will be declined. The default value is 'True'. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
AmountFormat:
Used to set the input format for TransactionAmount.This configuration setting can be used to specify a single input format for the transaction_amount
property. When set to a value other than 0, the class will automatically convert the amount from
the specified format to the format expected by the gateway. Valid values are:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ApplePayData:
The Base-64 encoded data containing the encrypted payment data from Apple for use when performing Apple Pay transactions.This setting specifies the Base-64 encoded data containing the encrypted payment data
received from Apple. The encrypted payment data must be retrieved in a separate process by communicating with the Apple Passbook app.
Once the encrypted payment data is received from Apple set this configuration setting, which takes the place of card, and perform either an auth_only or
sale transaction to process the payment.
This setting is applicable to the following gateways:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| APSRequestType:
Specifies the request type to use for the American Payment Solutions gateway.This config is used to specify the type of request which will occur when the sale method is called. By default it is set to Normal (0), in which case the class will send a normal transaction sale request.
The other options are used to instruct the class to send the appropriate type of request needed to query, create, update, or delete a customer vault record when sale is called. Possible values for this setting are:
Please see the gateway setup information for American Payment Solutions for more details on how to use the ICharge class to work with customer vault records. Refer to American Payment Solutions' documentation for more information about the customer vault in general. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| AuthNetBillToCompany:
The company that should be included with the customer's information for the Authorize.NET XML gateway.This configuration setting is used to specify the company in the billing information for the customer.
Note that this is only valid when the gateway property is set to gwAuthorizeNetXML. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| AuthNetCIMPaymentProfileId: The Payment Profile ID assigned by Authorize.NET CIM gateway.This config is used to specify the ID of a payment profile to be used to perform a transaction. A payment profile is tied to a AuthNetCIMProfileId and is used to identify the payment option to charge. With the Authorize.NET CIM gateway, transactions are performed using profiles to access customer information stored on their Customer Information Manager (CIM) instead of sending raw card and billing data with the transaction. Therefore this property is required. Note: The RecurringBilling class can be used to manage payment profiles. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| AuthNetCIMProfileId: The Profile ID assigned by Authorize.NET CIM gateway.This config is used to specify the ID of a profile to be used to perform a transaction. A profile is used to identify the customer initiating the transaction. With the Authorize.NET CIM gateway, transactions are performed using profiles to access customer information stored on their Customer Information Manager (CIM) instead of sending raw customer data with the transaction. Therefore this property is required. Note: The RecurringBilling class can be used to manage profiles. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
AuthNetCIMProfileResponse:
Profile creation response.When requesting a CIM profile to be created by setting the AuthNetCreateCIMProfile configuration setting to True, this configuration setting will contain the response. For Example:
icharge.Config("AuthNetCreateCIMProfile=True");
icharge.Sale();
Console.WriteLine(icharge.Config("AuthNetCIMProfileResponse"));
Note that this is read-only and only valid when gateway property is set to gwAuthorizeNetXML. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| AuthNetCIMShippingAddressId: The Shipping Address ID assigned by Authorize.NET CIM gateway.This config is used to specify the ID of a shipping address profile to be used to perform a transaction. A shipping address profile is tied to a AuthNetCIMProfileId and is used to identify the shipping location of the item purchased in the current transaction. With the Authorize.NET CIM gateway, transactions are performed using profiles to access shipping information stored on their Customer Information Manager (CIM) instead of sending raw shipping data with the transaction. This property is optional. If an shipping address ID is not specified, shipping information will not be included with the transaction. Note: The RecurringBilling class can be used to manage shipping address profiles. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
AuthNetCreateCIMProfile:
Whether to create a CIM Profile.Whether to create a CIM profile for the customer during a sale or auth_only transaction. By default this configuration setting is set to False. When set to True, the response for the profile creation will be returned in the AuthNetCIMProfileResponse configuration setting. For Example:
icharge.Config("AuthNetCreateCIMProfile=True");
icharge.Sale();
Console.WriteLine(icharge.Config("AuthNetCIMProfileResponse"));
Note that this is only valid when the gateway property is set to gwAuthorizeNetXML. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| AuthNetCryptogram:
Tokenized credit card cryptogram.This configuration setting is used to specify the value of the cryptogram received from the token provider. This configuration setting is required when AuthNetTokenizedCard configuration setting is set.
Note that this is only valid when calling sale method and the gateway property is set to gwAuthorizeNetXML. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| AuthNetCustomerType:
Specifies the customer type for the Authorize.NET XML gateway.This configuration setting is used to specify the customer type to send during a request to the Authorize.NET XML gateway. Default value is 0.
Available values are:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| AuthNetOpaqueDescriptor:
An Authorize.Net opaque data descriptor.This setting can be set to an Authorize.Net opaque data descriptor in order to use it in place of explicit card or bank account information. AuthNetOpaqueValue must also be set.
This setting is only valid with the gwAuthorizeNetXML and gwAuthorizeNetCIM gateways, it cannot be used with the gwAuthorizeNet gateway. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| AuthNetOpaqueValue:
An Authorize.Net opaque data value.This setting can be set to an Authorize.Net opaque data value in order to use it in place of explicit card or bank account information. AuthNetOpaqueDescriptor must also be set.
This setting is only valid with the gwAuthorizeNetXML and gwAuthorizeNetCIM gateways, it cannot be used with the gwAuthorizeNet gateway. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| AuthNetShipToCompany: The name of the company associated with the customer's shipping address.This configuration setting can be used to set the company associated with the shipping address of the customer. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| AuthNetSplitTenderId: Authorize.Net assigned id for partially authorized transactions.When AllowPartialAuths configuration setting is set to true and there are not enough funds to cover the full transaction amount set using the transaction_amount property, Authorize.NET will return a Split Tender Id that can be later used, to link to the original partially authorized transaction, to charge the full amount, void, or capture. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| AuthNetTokenizedCard:
The credit card token.This configuration setting is used to specify the credit card token to perform a Sale transaction.
Note that this is only valid when calling sale method and the gateway property is set to gwAuthorizeNetXML. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| BamboraPasscode: The API passcode used for authentication with Bambora.This configuration setting is used to set the API passcode when using the passcode option for authentication with Bambora. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
BankName:
Name of the card issuer.This configuration setting is required for some merchants when calling the sale method, and must be set to the name of the card issuer. For example:
icharge.Config("BankName=Wells Fargo");
icharge.Sale();
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
BarclayKeepTransactionOpen:
Determines whether to perform a maintenance transaction that keeps the transaction open for further processing with the Barclay and Ingenico gateways.By default (value of 'False'), all maintenance transactions (such as capture, refund, and void_transaction) will close the transaction after the
operation is performed. When set to 'True', the operation will be performed and the transaction will be left open for further processing. This config
works in conjunction with the following methods:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| BarclayPartialRefund: Determines whether to send a partial or full refund transaction with the Barclay and Ingenico gateways.By default (value of 'False'), the refund method will send a partial or full refund which closes the transaction. When this setting is set to 'True', a partial refund transaction will be sent and the transaction will be left open for another potential refund. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| BASYSCardInfoKey:
BASYS Gateway Credit Card Profile Id.If BASYSProcessRecurringCredit is set to True this must be set to the credit card profile id value assigned to the payment method when it was added to the system.
Note: BASYSCardInfoKey can be obtained via the RecurringBilling class. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
BASYSProcessRecurringCredit:
Determines whether to process the transaction via Credit Card Profile Id.Determines whether to process the transaction via customer's Credit Card profile. By default this configuration setting is set to False. If set to True, BASYSCardInfoKey and MerchantCode configuration settings must also be set. For instance:
icharge.Config("MerchantCode=YourBASYSMerchantKey");
icharge.Config("BASYSProcessRecurringCredit=True");
icharge.Config("BASYSCardInfoKey=YourBASYSCardInfoKey");
icharge.TransactionAmount = "1.00";
icharge.Sale();
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
BASYSProcessTokenCredit:
Determines whether to process the transaction using a Credit Card Token.Determines whether to process the transaction using a Credit Card Token provided by BASYS Gateway. By default this configuration setting is set to False. If set to True, BASYSTokenMode and BASYSToken must also be set. For Instance:
icharge.Config("BASYSProcessTokenCredit=True");
icharge.Config("BASYSToken=YourToken");
icharge.TransactionAmount = "1.00";
icharge.Sale();
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| BASYSToken:
BASYS Gateway Credit Card Token.
If BASYSProcessTokenCredit is set to True, this must be set to the token value assigned to the payment method when it was added to the system.
Note: BASYSToken can be obtained via the RecurringBilling class. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| BASYSTokenMode:
Indicates the type of token that is being used for the transaction.Indicates the type of token that is being used for the transaction. If BASYSProcessTokenCredit is set to True this must be set to one of the following values.
Possible values:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| BASYSVoidMode:
Indicates whether to perform a Void or Reversal.If BASYSVoidMode is set to "0" (default), void_transaction sends a void to undo an unsettled transaction. If BASYSVoidMode is set to "1" (Reversal), this ensures the transaction is unsettled and also removes the authorization from the issuing bank.
Possible values:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| BluefinReversal: Determines which transaction type will be use for VoidTransaction with the Bluefin gateway.By default, when VoidTransaction is called with gwBluefin selected the request will use the REFUND transaction type, which is used to void an unsettled Sale transaction. Set this configuration setting to True to use the REVERSAL transaction type instead, which will void an uncaptured authorization. Note that the REVERSAL transaction type may or may not be allowed depending on the payment processor for the account. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| BluePayMasterId: Used to reference a previous transaction in BluePay.This setting takes a previous transaction's response_transaction_id. For any parameters that are not set, BluePay will use values from the referenced transaction. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| BluePayUpdate: Used to perform an Update transaction for BluePay.When set to true, the component will update a prevous transaction when the sale method is called. BluePayMasterId must be set to the response_transaction_id of the previous request, and the transaction can only be updated before it has been settled by BluePay. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
BlueSnapEnterpriseUdfs:
User-Defined Fields (UDFs) to send with a BlueSnap Sale or AuthOnly request.This setting can be set to a JSON object like the following one in order to send Enterprise UDFs when calling sale or auth_only:
{"udf": [
{
"udfValue": "aaa",
"udfName": "ENT_UDF1"
},
{
"udfValue": "bbb",
"udfName": "ENT_UDF2"
}
]}
Note: Content set using this setting will be used as the value of the transactionFraudInfo.enterpriseUdfs JSON field in
the request body; it is not validated or manipulated first, it is used "as-is".
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| BlueSnapGetToken: Retrieves a new hosted payment fields token (pfToken) from BlueSnap.Each time this setting is queried, it will retrieve a new pfToken from BlueSnap. This token can then be passed to BlueSnap's hosted payment fields libraries, and then later passed in the transaction request using the special field pfToken or securityCodePfToken. Refer to BlueSnap's documentation for more information about hosted payment fields. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| BlueSnapRetrieveTransaction: Retrieves a BlueSnap transaction.Setting this to a card transaction ID (or querying it with the transaction_id property set) will cause the class to retrieve the associated transaction and populate its fields accordingly. Please refer to the BlueSnap section of the "ICharge Gateway Setup and Required Properties" page for more information on how the class's fields map to BlueSnap's fields. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
BlueSnapTransactionMetaData:
Transaction metadata to send with a BlueSnap Sale or AuthOnly request.This setting can be set to a JSON object like the following one in order to send Enterprise UDFs when calling sale or auth_only:
{"metaData": [
{
"metaValue": 20,
"metaKey": "stateTaxAmount",
"metaDescription": "State Tax Amount"
},
{
"metaValue": 20,
"metaKey": "cityTaxAmount",
"metaDescription": "City Tax Amount"
},
{
"metaValue": 10,
"metaKey": "shippingAmount",
"metaDescription": "Shipping Amount"
}
]}
Note: Content set using this setting will be used as the value of the transactionMetaData JSON field in the request body;
it is not validated or manipulated first, it is used "as-is".
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| CardholderPresentCode:
Specifies the way in which transaction took place.This config allows you to specify the way in which the transaction took place. This config
is applicable to the Barclay, HSBC, and PayFuse gateways.
Applicable values are:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| CardIssueNumber: Special Issue Number used for Switch and Solo cards.This field is used for the gateways the support International card types. Supported gateways include: Adyen, Barclay, CyberSource, FastTransact, HSBC, NetBanx, NetBilling, Orbital, PayFuse, PaymentExpress, PayPoint, PlugNPay, SagePay, SECPay, and WorldPayXML. Switch, Solo, and some Maestro cards have a 1 or 2 digit Issue number printed on the front of the card, directly following the card number. If that issue number is present, it should be set with this config setting. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| CardLast4Digits: The last 4 digits of a credit card.This configuration setting is used to specify the last 4 digits of the credit card in certain scenarios. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| CardPointeEncryptionHandler: The encryption handler to use when requesting a token from CardPointe.This configuration setting is used to specify the encryption handler when requesting a token from CardPointe (gwCardPointe). This should be set to "RSA" if using a private key provided by CardPointe to encrypt the account value before sending. If the account value in the token request is not encrypted, this setting is not necessary. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| CardPointeGetToken: Retrieves an account token from CardPointe.This configuration setting is used to request a token from CardPointe (gwCardPointe). If CardToken is set, it will be used for the account in the request. If not, card_number will be used instead. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| CardStartMonth: Used for some international cards.If there is a Start Date present on the card, set the month here and the year in CardStartYear. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| CardStartYear: Used for some international cards.If there is a Start Date on present on the card, set the year here and the month in CardStartMonth. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| CardToken:
The credit card token.This configuration setting is used to specify the credit card token (sometimes called a "nonce") to perform a transaction.
Note that this is only valid when the gateway property is set to gwConverge, gwMoneris, gwNuvei, gwSquare, gwSquarePayments, gwStripe, or gwQBPayments. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| CAVVResponse: Contains CAVV response value returned by the gateway.This property will contain the CAVV response value to the authorization and will be populated along with response. Values vary between gateways, so please consult gateway documentation for more information. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| COFPermission: Indicates if the customer gave permission to make a Card On File transaction.When true, this setting indicates that the customer gave the merchant permission to perform a Card On File (COF) transaction. Currently only used by CardPointe (gwCardPointe). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ConvenienceFee: The total convenience fee charged for a transaction.This field is used to specify the total convenience fee charged for the transaction. This field is applicable to the FirstDataPayPoint and Litle / Vantiv gateway. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ConvergeTokenMode:
Used to request a token from the Converge gateway.This configuration setting is used to request a token when making a request to gwConverge. If this is set to 1 or 2 before calling sale or auth_only, Converge will return a token in the response, which will be available through the CardToken configuration setting.
Possible values for this setting are:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| CurrencyCode:
Currency code for the currency of the transaction.This config is used to specify the currency code to be used in the transaction.
Default values and codes vary based on the gateway. This config will be populated
with the default value for the gateway when gateway is set.
For more information on these currency code values, please refer to the ISO 4217 standard as well as the gateway specification. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| CurrencyExponent: Currency exponent to be used in conjunction with the Currency code of the transaction.If not set, "2" is sent by default. Currently only supported in the Orbital and WorldPayXML gateways. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| CustomerProfileId:
Used to send a customer profile Id to a gateway.This configuration setting is used to specify a customer profile Id when performing a transaction.
Note that this is only valid when the gateway property is set to gwCardPointe. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| CyberSourceAuthToken: The request token from a previous authorization for the CyberSource gateway.This config is used to specify a request token for authorization update transactions (such as captures, credits, voids, and reversals). This is only applicable when using the Atos interface. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| CyberSourceProfileId: The Id of a Customer's Profile stored within the CyberSource gateway.This config allows you to specify a customer Profile Id to process a transaction using the customer's information stored within CyberSource's systems (this is known as Payment Tokenization). When specified, the ProfileId will be sent instead of the card data (when performing an auth_only or sale) and thus the stored card in the customer's profile will be charged. Additionally you can credit a card on a customer's profile by specifying a Profile Id and a TransactionId of "" (empty string). Please note that the component does NOT support creating, modifying, or deleting customer profiles. These will need to be created using the RecurringBilling component or by other means such as within CyberSource's Business Center. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| CyberSourceVoidMode: Indicates whether to perform a Void or Reversal.If CyberSourceVoidMode is set to "Void" (default), void_transaction sends a void transaction to cancel a capture or credit request. Note a transaction can only be voided if CyberSource has not already submitted the capture or credit request to the processor (this is usually done once a day). If CyberSourceVoidMode is set to "Reverse", a full authorization reversal transaction is sent to reverse a previous authorization (i.e. after performing an auth_only transaction). Note in a reversal, it is required that transaction_amount be set to the full amount authorized (as you cannot partially reverse an authorization). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| CyberSourceXMLEscape: Determines whether to XML escape the CyberSource gateway request field values.If this setting is set to "True", the request field values will be XML escaped prior to being sent to the CyberSource gateway. If this setting is set to "False" (default), the class does not perform any XML escaping and the values are sent exactly as specified. The default value is "False". | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DataCash3DSCardholderRegistered:
Indicates whether the cardholder was registered for 3D Secure for the DataCash gateway.This config is used when sending 3D Secure data to the DataCash gateway. It indicates whether the cardholder was
registered for 3D Secure and the PARes or VERes status. Available values are:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| DataCashAuthOnlyFinality: Indicates whether an AuthOnly transaction should be treated as final for the DataCash gateway.This config is used to specify whether an AuthOnly transaction should be treated as final. If the final settlement amount is not known, this config should be set to 'False' to indicate that the settlement amount will likely be changed prior to settlement. When set to 'True' or '' (empty string) (default value) the transaction will be treated as final. Note that with '' (empty string) the transaction will be treated as final unless the merchant configuration has been set up or there is a risk of reversal. MasterCard Europe and Maestro have created this mandate to improve the management of cardholder 'open to buy' limits. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| DataCashExtendedPolicyAggregate:
Used to specify an XML aggregate for Extended Policies within the DataCash gateway.The specified aggregate will be contained within the "ExtendedPolicy" element of the request.
The three available policies (elements) that can be specified are: "cv2_policy", "postcode_policy", and "address_policy". Each of these elements have five available attributes, "notprovided", "notchecked", "matched", "notmatched", "partialmatch", of which have the following available values: "accept" and "reject". Below is a sample XML aggregate:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| DynamicDescriptor:
A merchant defined transaction description which appears on the customer's credit card statement.This field is used to specify a dynamic descriptor (sometimes called a soft descriptor) for the transaction.
Typically this value is used to specify transaction specific details which will be displayed on the customer's
credit card statement.
The following gateways currently support this functionality: Heartland. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| EscapeXML: Automatically escape data within XML tags.When set to true, this config will cause the component to automatically escape the XML data in the request. The default value is false. This is currently only supported in the Authorize.Net XML gateway. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ExPayGetMethods: Used to send a GetMethods request to the ExPay gateway.This is an action config that will send a GetMethods request to the ExPay gateway. Method information returned in the response can be parsed via the get_response_var method or the X*** configuration settings. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ExPayGetStatus: Used to send a GetStatus request to the ExPay gateway.This is an action config that will send a GetStatus request to the ExPay gateway. transaction_id or ExPayPaymentId is required (specifying both will result in an error). Status information returned in the response can be parsed via the get_response_var method or the X*** configuration settings. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ExPayPaymentId: The payment Id used to retrieve a transaction status for the ExPay gateway.This config is used to specify a payment Id to retrieve a transaction status for via ExPayGetStatus. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ExPayServiceId: The Id of the service to use to perform an authorization for the ExPay gateway.This config is used to specify the Id of the service (retrieved via a ExPayGetMethods call) and is required to perform an authorization via an auth_only call. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| FDMSCurrentBalance: Contains the current card balance value returned in a response for the First Data E4, Payeezy, and Bank Of America gateways.When returned in the response, this field will be populated with the current balance on the card used to process the transaction. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| FDMSGiftCardTransactionType:
Specifies the transaction type to perform on a gift card for the First Data E4, Payeezy, and Bank Of America gateways.This field is used to specify the gift card transaction type you wish to perform. All gift card transactions are performed
by setting the type via this config and calling the sale method. When the transaction type is set to '0', the sale,
void_transaction and refund methods can be called to perform their respective transactions. Note to process a gift card
transaction, FDMSProcessGiftCard must be set to 'True'.
Applicable values are:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| FDMSKeyId: The Key Id that corresponds to the HMAC Key for the First Data E4, Payeezy, and Bank Of America gateways.This config is used to specify the Key Id, obtained from FDMS, that corresponds to the HMAC Key (specified via HashSecret) and is sent within the Authorization header of the request. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| FDMSProcessGiftCard: Specifies whether the card being processed is a gift card for the First Data E4, Payeezy, and Bank Of America gateways.When set to 'True', the current transaction will be run as a gift card transaction. The default value 'False', will perform a regular credit card transaction. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| FDMSTransArmorToken: The Transarmor token that replaces a card number and used for transaction processing.This config is used to both retrieve and specify a Transarmor Token for the First Data E4, Payeezy, and Bank Of America gateways. If your account is configured for Transarmor tokens, a token will be created by the server and returned via this config when performing a transaction using a card data. Additionally, you can set this config to a previously retrieved token value and the token will be sent in the request rather than the card data. This increases security as raw card data is no longer needed. Note when sending an FDMSTransArmorToken value, the CardType, card_exp_month, and card_exp_year are required. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| FDMSWalletProviderId:
Specifies the transaction type to perform on a gift card for the First Data E4, Payeezy, and Bank Of America gateways.This field is used to specify a wallet provider when using a digital wallet like Apple Pay or Android Pay. By default this field is not sent,
and no wallet provider is used.
Applicable values are:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| GlobalIrisRefundPassword: The Refund password for the Global Iris gateway.This config is used to specify the refund password provided to you by Global Iris. When a refund is performed, the component will use the specified password to generate and send a 'refundhash' in the request. This value is required when performing a refund transaction. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| GlobalPayrollCreateToken: Sends a create token request to the Global Payroll gateway.This is an action config which when called will send a create token request to the Global Payroll gateway. A successful response will contain the GlobalPayrollToken for the specified card_number. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| GlobalPayrollToken: The token value for a corresponding card when using the Global Payroll gateway.This field is used to retrieve or specify a token value. This field will be populated after a call to GlobalPayrollCreateToken This field should be specified prior to performing a transaction using a token value instead of card. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| GoEMerchantUseGatewayId: Indicates whether to send a password or gateway Id for the GoEMerchant gateway.By default, the password property is sent as the "password" field in all requests. If the GoEMerchantUseGatewayId configuration setting is set to True, the class will instead treat the password as the "gateway_id" field in all requests. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
HashAlgorithm:
Algorithm used for hashing.Certain gateways allow the request to be hashed as an additional authentication mechanism. This configuration setting controls which algorithm is used for hashing. Valid values are:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| HashSecret:
Security key used to generate a hash for gateways supporting such functionality.Some gateways allow for the generation of a hash for added security. The following gateways
support this config.
Authorize.Net: The newest version of the protocol includes an optional Hash Secret, which may be used to verify that a server response is actually from an Authorize.Net server. The hash secret is concatenated with the merchant_login, response_transaction_id, and transaction_amount. This value is then hashed with the MD5 algorithm and compared to the value returned by the server. If they do not match, the class fails with an error. If the AIMHashSecret is left blank, this check will not be performed. The Server's Hash Secret may be set using the Authorize.Net online merchant interface, located at https://secure.authorize.net/. Bank of America: This value will be the HMAC Key generated for you by the gateway. This value is required and an exception will be thrown if not specified. BarClay and Ingenico: This value is optional and when specified 'SHASIGN' parameter will be computed and sent. Bambora/Beanstream: If hash validation is required then set this to your hash key. HashAlgorithm will also need to be set accordingly. Nuvei: This value is required in all transactions. The value is unique to each terminal and can be set through the online interface at "https://testpayments.nuvei.com/merchant/selfcare/". USAePay: This value is optional and when a 'Pin' value is specified, the 'UMhash' parameter will be computed and sent. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| HeartlandDeveloperId: Optional DeveloperId field used by the Heartland gateway.If HeartlandDeveloperId is set, the HeartlandVersionNumber should also be set. If set, this field must be exactly 6 characters in length. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| HeartlandDeviceId: DeviceId field required by the Heartland gateway.This is issued by Heartland during registration. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| HeartlandLicenseId: LicenseId field required by the Heartland gateway.This is issued by a Heartland Payment Systems Administrator during registration. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| HeartlandReversalAmount: The settlement amount to be used when performing a reversal for the Heartland gateway.The Heartland gateway supports reversals of credit card transactions. To perform a reversal, transaction_amount can be set and the void_transaction can be called. When performing a reversal, transaction_amount must be set to the original authorized amount of the transaction you are performing the reversal on. This field should then be set to the settlement amount of the transaction (or the final authorized amount after the reversal is performed). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| HeartlandSecretAPIKey: Specifies the secret key to be used for authentication with Heartland.If Heartland provides a secret key for use with their API, this property can be used to send it to the gateway. When this key is set, the HeartlandLicenseId, HeartlandSiteId, HeartlandDeviceId, merchant_login and merchant_password are not required, and will not be sent to the gateway. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| HeartlandShipDay: Ship day field required by the Heartland gateway e-commerce/direct marketing transactions.The ship day for the Heartland transaction. Valid values are 1 - 31. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| HeartlandShipMonth: Ship month field required by the Heartland gateway e-commerce/direct marketing transactions.The ship month for the Heartland transaction. Valid values are 1 - 12. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| HeartlandSiteId: SiteId field required by the Heartland gateway.This is issued by Heartland during registration. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| HeartlandSiteTrace: Optional transaction identifier for the Heartland gateway.Heartland supplies an additional way to trace the transaction, beyond the InvoiceNumber and TransactionId. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| HeartlandTokenMapping:
The type of token to return when using Tokenization with the Heartland gateway.The field is used to specify the type of token that should be returned when using the Heartland gateway. By setting
this field to a value other than 0 (None), a Token will be requested and returned in the response via HeartlandTokenValue
(provided one can be generated). Please see the "ICharge Gateway Setup and Required Properties" page for more details about using tokenization,
as there are special merchant account configurations required.
The available mapping values are:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| HeartlandTokenValue: Used to retrieve or specify a Heartland token value.This field is used to retrieve a Heartland Token value when using Heartland Tokenization (which is accomplished by setting HeartlandTokenMapping to a value greater than 0). A token replaces the card number in all subsequent transactions thus increasing security. This field can also be used to specify a previously retrieved token value. When set, the specified token value will be sent in the request instead of the card number. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| HeartlandVersionNumber: Optional VersionNumber field used by the Heartland gateway.If HeartlandVersionNumber is set, the HeartlandDeveloperId should also be set. If set, this field must be exactly 4 characters in length. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
LitleAdvancedFraudChecksId:
Used to specify the Id for use in the AdvancedFraudChecks element for the Litle gateway.This field is used to specify the Id for the AdvancedFraudChecks element for the Litle gateway. Custom attributes
can also be included by using the add_special_field method with the name "CustomAttributeX", where X is a number
from 1 to 5. For example:
icharge.Config("LitleAdvancedFraudChecksId=ASDFG-AXXXXAB999");
icharge.AddSpecialField("CustomAttribute1", "One");
icharge.AddSpecialField("CustomAttribute2", "Two");
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| LitleCustomBillingAggregate:
Used to specify an XML aggregate for Custom Billing support within the Litle gateway.This field is used to specify an XML aggregate for Custom Billing support within the Litle gateway.
When specifying custom billing, you can use either the phone or url child.
Below is a sample XML aggregate for the phone child:
Below is a sample XML aggregate for the url child:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| MerchantAlias: An additional merchant property used to specify an alias for the merchant.The HSBC and PayFuse gateway both allow for a merchant alias to be specified (and in some cases it may be required). This field allows you to specify the alias. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| MerchantCode:
A gateway-supplied merchant number, code, or Id.For the CardPointe gateway, this configuration setting is required, and should contain your Merchant Id.
For the Litle gateway, this configuration setting is required, and should contain your Merchant Id. For the MIT gateway, this configuration setting is required, and should contain your Merchant Number (Contado). For the Priority Payment Systems gateway, this configuration setting is required, and should contain your Merchant Id. For the WorldPayXML gateway, this configuration setting is optional; it is only needed if you require that the "merchantCode" sent in the request be different from your merchant_login (e.g., when processing AMEX transactions, or when supporting multiple currencies). |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
MerchantESolutionsAccountDataSource:
Specifies the source of a customer's data in an authorization request to Merchant e-Solutions.This configuration setting is used to specify the source of a customer's data in an authorization request.
For a "Card on File" request when the merchant is using data that they stored themselves, this value should be set to "Y".
As per Merchant e-Solutions' documentation, valid values are:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| MerchantESolutionsCardOnFile: Tells Merchant e-Solutions that you will be storing card information.This configuration setting is used to inform Merchant e-Solutions that the merchant will be storing a customer's credit card data. For the initial request, after which the customer's data will be stored, this should be set to true. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| MerchantESolutionsMerchantInitiated: Tells Merchant e-Solutions that you are performing a Merchant Initiated Transaction.This configuration setting is used to inform Merchant e-Solutions that a transaction was initiated by the merchant and not by the cardholder. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
MerchantESolutionsMotoECommerceInd:
Used to tell Merchant e-Solutions if a transaction is Mail Order, Telephone Order, or E-Commerce.This configuration setting is used to tell Merchant e-Solutions if a given transaction is Mail Order, Telephone Order, E-Commerce, or in person.
As per Merchant e-Solutions' documentation, valid values are:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| MerchantESolutionsToken: Holds a token representing card information stored by Merchant e-Solutions.If this configuration setting contains a token during a request to MerchantESolutions, the token will be sent as part of the request. After a successful Sale, AuthOnly, or AVSOnly request with MerchantESolutionsTokenizeCard set, the token representing the card used in the request will be available by querying this configuration setting. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| MerchantESolutionsTokenizeCard: When set, will request a tokenized card from Merchant e-Solutions.This configuration setting is used to request a tokenized card from Merchant e-Solutions. If it is set to true during a successful Sale, AuthOnly, or AVSOnly request, the response will include a token representing the card used in the transaction. Note that a token will not be requested if a token is already set in MerchantESolutionsToken. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| MerchantPartnersLast4Digits: The last 4 digits of the card number for a transaction processed via the MerchantPartners gateway.The last 4 digits of the card number are required to process transactions using a stored profile Id (via MerchantPartnersProfileId) for the MerchantPartners or WorldPay Link gateways. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| MerchantPartnersProfileId: The profile Id to be used to process a transaction via the MerchantPartners or WorldPay Link gateways.This field is used to specify the Profile Id of a stored profile and is used to process a transaction instead of specifying the card data. A profile is created via the RecurringBilling component and the SubscriptionId response field is used to obtain the profile Id to be set in this field. MerchantPartnersLast4Digits is a required field when using a stored profile. Note this config is only applicable to sale and credit transactions processed via the MerchantPartners or WorldPay Link gateways. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| MetrobankLocale: Sets the locale for a 3-party request to Metrobank.This configuration setting is used when setting the Locale for a 3-party request with Metrobank. Controls the language that will appear on the payment page where the user is redirected. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| MetrobankReturnURL: Sets the URL where a user will be redirected after a 3-party request to Metrobank.This configuration setting is used when setting the URL where a user will be redirected after a 3-party request with Metrobank. There must be a server listening at that URL to receive the transaction response. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| MetrobankThreePartyRequest: Indicates that the component should return data for a 3-party request to Metrobank.When sending a 3-party request to Metrobank, this configuration setting should be used to skip sending the request and output it directly to the RawRequest configuration setting instead. It can then be included in the POST request through which the user is redirected. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| MetrobankThreePartyResponse: Used to manually parse a response after a 3-Party request to Metrobank.After sending a 3-party request to Metrobank and receiving the response, this configuration setting can be used to manually enter the response data into the ICharge component to parse the response. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
MetrobankVoidType:
Used to type of transaction should be voided in a request to Metrobank.Metrobank allows a merchant to void Purchase, Capture, or Refund transactions, but the request must indicate which type of transaction to void. Valid values are:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| MITAESSeedId: The Seed Id used to perform AES encryption for the MIT gateway.This field is used to specify the Seed Id used to perform AES encryption. This field is provided by MIT and is required when performing AES encryption. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| MITBranchId: Branch reference number for the MIT gateway.This field is used to specify the branch reference number for the MIT gateway (Required). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| MITCompanyId: Company reference number for the MIT gateway.This field is used to specify the company reference number for the MIT gateway (Required). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| MITCountry: Country of operation for the MIT gateway.This field is used to specify the country of operation for the MIT gateway (Required). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| MITEncryptionAlgorithm:
The Encryption Algorithm to use with the MIT gateway.This field is used to specify the encryption algorithm to use for the MIT gateway. Encryption will
only be performed if an encryption key is specified via MITEncryptionKey. Note when
perform AES (1) encryption, you must also set MITAESSeedId.
Applicable values are:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| MITEncryptionKey: The Encryption Key to use with the MIT gateway.This field is used to specify the encryption key for the MIT gateway. When set, the specified key will be used to perform the encryption specified via MITEncryptionAlgorithm. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| MITFlag: For the MIT framework - Used to indicate that a transaction is merchant initiated.When making a Merchant Initiated Transaction (MIT), this configuration setting should be set to true to indicate to the payment gateway that the transaction is merchant initiated. Used by the Orbital payment gateway. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| MITPriorTransId: For the MIT framework - Used to specify a prior transaction id to be referenced in a merchant initiated transaction.When making a Merchant Initiated Transaction (MIT), this configuration setting can be used to specify the transaction Id of a previously successful authorization. Used by the Orbital and CyberSource payment gateways. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| MITRecurring: Specifies whether to perform a recurring transaction request for the MIT gateway.When this field is set to 'True', the component will perform a recurring transaction request when sale is called. The fields required for a Recurring charge transaction are the same as a sale transaction. The default value is 'False'. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| MITTPOperation: The operation type for the MIT gateway.This field is used to specify the operation type for the MIT gateway (Required). This value will be provided to you by MIT. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| MITType: For the MIT framework - Indicates the type of transaction being requested in a Merchant-Initiated Transaction (MIT).When making a Merchant Initiated Transaction (MIT), this configuration setting is used to specify the type or reason for the merchant initiated transaction. The possible values and formats for this field vary by gateway, so check the gateway's documentation for the associated values and their meanings. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| MonerisNVPAPI: Indicates whether to use the NVP API for the gwMoneris and gwMonerisUSA gateway.The field is used to indicate whether to use the NVP API for either the gwMoneris or gwMonerisUSA gateway. When set to true, the NVP API will be used instead of the XML specification. Note that you must set gateway to either gwMoneris or gwMonerisUSA prior to setting this field. Additionally, if you decide to use the NVP API, this field must be set directly after setting gateway (as gateway_url will be updated). Note: The Response Method of the DirectPost configuration must be set to "Displayed as key/value pairs on our server" in the merchant admin console when using the NVP API. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
MyVirtualMerchantTransactionType:
Used to override the transaction type to send in a transaction for the MyVirtualMerchant and Converge gateways.This field is used to override the default transaction type for the MyVirtualMerchant gateway. By default, the
component will set the transaction type based on the method called. However this field can be set to override the
default value and is particularly useful for creating recurring or installment billing transactions. Below is
a list of some of the available transaction types. Note that these additional transaction types require special
fields to be added via add_special_field. Please consult the Virtual Merchant specifications for details about
the required fields.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| MyVirtualMerchantUserId: The MyVirtualMerchant user Id as configured on VirtualMerchant.This field is used to specify your MyVirtualMerchant user Id which is required (along with merchant_login and merchant_password) as part of the user authentication. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| NetbanxAccountNumber: Account Number for the Netbanx gateway.This field is used to specify an account number for the Netbanx gateway which is used in addition to the merchant_login and merchant_password properties. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| NetBillingVersion: The Version to be sent in the User-Agent heading of a NetBilling gateway request.The Version portion of the User-Agent HTTP header is required by NetBilling. The default value is "1". | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| OrbitalAuthReversal: Indicates whether to perform an authorization reversal when calling VoidTransaction for the Orbital gateway.This config is used to specify whether void_transaction should perform an authorization reversal or void transaction. When this config is set to 'True' and void_transaction is called, an authorization reversal transaction will be sent to reverse a previously authorized transaction. The default value is 'False' which sends a void transaction. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| OrbitalConnectionPassword: Orbital Connection Password field used by the Orbital gateway.If OrbitalConnectionPassword is set, the OrbitalConnectionUsername should also be set. This field is case-sensitive. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| OrbitalConnectionUsername: Orbital Connection Username field used by the Orbital gateway.If OrbitalConnectionUsername is set, the OrbitalConnectionPassword should also be set. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
OrbitalCustomerProfileFromOrderInd:
Customer Profile Number generation Options for the Orbital gateway.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| OrbitalCustomerProfileId: The Id for a customer profile in the Orbital gateway.This configuration setting can be used to specify a customer profile to use during a request to the Orbital gateway. Additionally, after a request in which OrbitalCustomerProfileFromOrderInd is set it will contain the customer profile Id returned in the response. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
OrbitalCustomerProfileOrderOverrideInd:
Indicator to specify how the CustomerId is leveraged to populate other data sets for the Orbital gateway.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| OrbitalDigitalTokenCryptogram: Holds the cryptogram when making a CDPT request with Orbital.When making a CDPT request with Orbital, this configuration setting can be used to specify the cryptogram corresponding to the CDPT token. The CDPT token itself should be supplied through the card's card_number field. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| OrbitalDPANIndicator: Indicates the type of a CDPT authorization with Orbital.The DPANIndicator is used to specify the type of authorization when making a CDPT request with Orbital. It should be set to "Y" for the original authorization and "S" for any subsequent related authorizations. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| OrbitalTxRefIdx: Indentifies the unique components of transactions that have been adjusted more than one time for the Orbital gateway.This field is used when performing a void_transaction to identify unique components of transactions adjusted more than one time. The default value ("NULL") should be submitted when voiding a transaction which has not been adjusted more than once or if the un-captured remainder of a split transaction (partial capture) should be voided. To void a specific partial capture, this field should be set to the value returned in the response for the partial capture. Note that this field will also be populated with the TxRefIdx value returned in a response. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| OrbitalVoidAdjustedAmount: Specifies the amount to void from a previous authoization for the Orbital gateway.This field is used to specify an amount to adjust a previous authorization when performing a void_transaction. Thus the specified amount will be voided (assuming that the amount is not greater than the transaction amount remaining) and the total amount minus the adjusted amount will be the new authorized amount. When a value is not specified, the full amount of will be voided. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| PayDirectConvenienceFee: The total convenience fee charged when using the PayDirect gateway.This field is used to specify the total convenience fee charged for the transaction when using the PayDirect gateway. This field is always required when using the PayDirect gateway. The sum of this field plus PayDirectMerchantAmount must always equal the value in transaction_amount. If no values are set for either of these two configs, the component will set PayDirectMerchantAmount to the value specified in transaction_amount and PayDirectConvenienceFee to "0.00". | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| PayDirectMerchantAmount: The MerchantAmount used by the PayDirect gateway.This field is used to specify the total amount of goods and services for the external client when using the PayDirect gateway. This field is always required when using the PayDirect gateway. The sum of this field plus PayDirectConvenienceFee must always equal the value in transaction_amount. If no values are set for either of these two configs, the component will set PayDirectMerchantAmount to the value specified in transaction_amount and PayDirectConvenienceFee to "0.00". | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| PayDirectSettleMerchantCode: The Settle Merchant Code required for authorization when using the PayDirect gateway.This field is used to set Settle Merchant Code assigned by Link2Gov for the Reconciliation of funds. This field is always required when using the PayDirect gateway. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| PayerIP: The IP address of the payer.This config is used to specify the IP address of the payer, which is required by some gateways. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| PayFlowProInquiry: Submits an Inquiry transaction to the PayFlowPro gateway.Set this config to the response_transaction_id from the transaction you wish to retrieve. You may also call PFPInquiry without setting it to anything. In this case the customer_id property is required, and the PayFlow Pro gateway will return the most recent transaction for the specified Id. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| PayFlowProToken:
Used specify a token to be used instead of card data for the Payflow Pro gateway.This field is used to specify a token value to perform additional authorizations (via sale or auth_only)
and Credits (via credit) without sending card data again. For the Payflow Pro gateway, token values
are the same as the response_transaction_id value returned from an authorization. Below is a code example
of how this config can be used (note the code starts after the initial Sale or AuthOnly transaction has been performed):
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| PayFlowProUpload: Submits an Upload transaction to the PayFlowPro gateway.This is an actionable config which when called will send an upload transaction to the Payflow Pro gateway. An upload transaction is used to store credit card information on the gateway server. Note that billing and shipping information can be saved as well. After a successful upload, response_transaction_id will contain the token value that corresponds to the credit card data stored. This token value can then be used to process transactions via PayFlowProToken. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| PayJunctionUpdateAmount: Indicates whether the capture method should send an update amount request when using the PayJunction gateway.This field allows you to specify whether capture will send an update amount or a capture request. By default, this value is 'False', which sends a capture request to mark an auth_only transaction for capture. This particular function does not allow you to alter the amount but instead just marks the authorized amount (from the auth_only transaction) for capture. When this field is set to 'True', the capture method will send an update amount request allowing you to alter the amount that will be captured. This method can be used after auth_only and sale transactions. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| PaymentWorkSuiteClientCode: The 3DSI assigned client code sent in a request to the PaymentWorksuite gateway.This field is used to specify the client code that is assigned by 3DSI. This code uniquely identifies your organization for the purpose of accessing and authenticating to the Payment WorkSuite. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| PaymentWorkSuiteLocationCode: The 3DSI assigned location code sent in a request to the PaymentWorksuite gateway.This field is used to specify the location code that uniquely identifies a specific location that is associated with the merchant identified by the specified PaymentWorkSuiteMerchantCode. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| PaymentWorkSuiteMerchantCode: The 3DSI assigned merchant code sent in a request to the PaymentWorksuite gateway.This field is used to specify the merchant code that uniquely identifies a specific merchant within the Payment WorkSuite. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| PayPointFreedomAPI: Indicates whether to use the Freedom API for the gwPayPoint and gwSECPay gateways.The field is used to indicate whether to use the Freedom API for either the gwPayPoint and gwSECPay gateway. When set to true, the Freedom API will be used instead of the XML Hosted specification. Note that you must set gateway to either gwPayPoint or gwSECPay prior to setting this field. Additionally, if you decide to use the Freedom API, this field must be set directly after setting gateway (as gateway_url will be updated). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PayTraceAddPurchaseCardData:
Sends a Level3 request for the PayTrace gateway.This config is used to add Purchase Card (Level2 and Level3) Data to an existing sale transaction for the PayTrace gateway.
The level_2_aggregate and level_3_aggregate fields can be set to specify the purchase card data you wish to add prior to
calling this config. A TransactionId, from the response of the original sale, is required to be specified when calling
this config; i.e.:
ICharge.Config("PayTraceAddPurchaseCardData=123456789");
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| PayTraceIntegratorId: Used to specify the Integrator Id value assigned by the PayTrace gateway.This value is assigned by PayTrace and is used for validation and tracking purposes. The default value is: "90000035NSFT". | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| PayTraceJSONCardToken:
The token value for a corresponding card.This field is used to specify card token value that you retrieved from Protect.js (see PayTrace documentation for details).
This field must be set prior to performing a transaction using a token value instead of a card.
Note that this is only valid when calling sale or auth_only methods and the gateway property is set to gwPayTraceJSON (117) |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| PayTraceJSONEncryptionKey:
The Encryption Key to use with the PayTraceJSON gateway.This field is used to specify the encryption key that you retrieved from Protect.js (see PayTrace documentation for details).
Note that this is only valid when calling sale or auth_only methods and the gateway property is set to gwPayTraceJSON (117) |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PayTraceJSONGetClientKeyToken:
Retrieves a new Client Key (PROTECT AUTH TOKEN) from PayTrace.This is an Action config. Getting this config will cause the class to obtain a Client Key (PROTECT AUTH TOKEN) from PayTrace.
The Client Key will be used to authorize your application to use Protect.js to retrieve Card Token (hpf token) and Encryption Key (enc key).
Please see PayTrace documentation for details. This key is valid for 20 minutes.
icharge = new Icharge();
icharge.Gateway = IchargeGateways.gwPayTraceJSON;
icharge.GatewayURL = "https://api.paytrace.com";
icharge.MerchantLogin = bearerToken;
string clientKeyToken = class.Config("PayTraceJSONGetClientKeyToken"); //use this key to obtain "hpf_token" and "enc_key" from Protect.js
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| PayvisionTransactionGuid: The GUID obtained with an authorization for the Payvision gateway.This config is used to retrieve the Transaction GUID returned in an authorization response for the Payvision gateway. This setting is also used to specify the Transaction GUID from a previous authorization, when performing a followup transaction (such as a capture, refund, or void_transaction). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| PayWiserCaptureReferenceId: The capture reference id returned by PayWiser after doing a Sale transaction.This configuration setting is populated after calling the sale method. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| PayWiserCardToken:
The token value for a corresponding card when using the PayWiser gateway.This field is used to specify a token value. This field should be specified prior to performing a transaction using a token value instead of card.
Note: PayWiserCardToken can be obtained via the RecurringBilling class by setting the PayWiserRequestType configuration setting to 1. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PayWiserEMerchantPay:
Determines whether to process the transaction via E-Merchant Pay Acquiring Bank.Determines whether to process the transaction via E-Merchant Pay Acquiring Bank. When this configuration setting is set to True, ThreeDSuccessURL and ThreeDFailURL fields must also be sent using the add_special_field method. For example:
icharge.Config("PayWiserEMerchantPay=True");
icharge.AddSpecialField("ThreeDSuccessURL", "SuccessURL");
icharge.AddSpecialField("ThreeDFailURL", "FailURL");
icharge.AuthOnly();
By default this configuration setting is set to False. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| PayWiserReserveReferenceId:
The reserve reference id returned by PayWiser after doing a Sale transaction.This configuration setting is populated after calling the sale method. The value returned by this configuration setting should be used when calling the refund method.
Note: If the auth_only method is called, the Reserve Reference Id can be obtained via the response property. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| PayWiserTokenizeCard:
Whether to generate a Token Reference Id.Whether to generate a Token Reference Id based on the Credit Card information. This configuration setting can only be set when calling the sale method.
By default this configuration setting is set to False. If set to True, a Token Reference Id will be returned in PayWiserTokenReferenceId configuration setting. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| PayWiserTokenReferenceId: The token reference id for a corresponding card when using the PayWiser gateway.This configuration setting is populated at the time the Token Reference Id is created by calling the sale method and setting PayWiserTokenizeCard configuration setting to True. This field should be specified prior to performing a transaction using a Token Reference Id instead of card. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| PhoeniXGateCardInfoKey:
PhoeniXGate Gateway Credit Card Profile Id.If PhoeniXGateProcessRecurringCredit is set to True this must be set to the credit card profile id value assigned to the payment method when it was added to the system.
Note: PhoeniXGateCardInfoKey can be obtained via the RecurringBilling class. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PhoeniXGateProcessRecurringCredit:
Determines whether to process the transaction via Credit Card Profile Id.Determines whether to process the transaction via customer's Credit Card profile. By default this configuration setting is set to False. If set to True, PhoeniXGateCardInfoKey and MerchantCode configuration settings must also be set. For instance:
icharge.Config("MerchantCode=YourPhoeniXGateMerchantKey");
icharge.Config("PhoeniXGateProcessRecurringCredit=True");
icharge.Config("PhoenixGateCardInfoKey=YourPhoeniXGateCardInfoKey");
icharge.TransactionAmount = "1.00";
icharge.Sale();
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PhoeniXGateProcessTokenCredit:
Determines whether to process the transaction using a Credit Card Token.Determines whether to process the transaction using a Credit Card Token provided by PhoeniXGate Gateway. By default this configuration setting is set to False. If set to True, PhoeniXGateTokenMode and PhoeniXGateToken must also be set. For Instance:
icharge.Config("PhoeniXGateProcessTokenCredit=True");
icharge.Config("PhoeniXGateToken=YourToken");
icharge.TransactionAmount = "1.00";
icharge.Sale();
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| PhoeniXGateToken:
PhoeniXGate Gateway Credit Card Token.
If PhoeniXGateProcessTokenCredit is set to True, this must be set to the token value assigned to the payment method when it was added to the system.
Note: PhoeniXGateToken can be obtained via the RecurringBilling class. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| PhoeniXGateTokenMode:
Indicates the type of token that is being used for the transaction.Indicates the type of token that is being used for the transaction. If PhoeniXGateProcessTokenCredit is set to True this must be set to one of the following values.
Possible values:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| PhoeniXGateVoidMode:
Indicates whether to perform a Void or Reversal.If PhoeniXGateVoidMode is set to "0" (default), void_transaction sends a void to undo an unsettled transaction. If PhoeniXGateVoidMode is set to "1" (Reversal), this ensures the transaction is unsettled and also removes the authorization from the issuing bank.
Possible values:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PKPaymentToken:
Used to send an Apple Pay PKPaymentToken to the gateway.This configuration setting is used to send an Apple Pay PKPaymentToken containing a user's credentials to a gateway. The setting should be set to the full JSON contents of the PKPaymentToken, like:
icharge.Config("PKPaymentToken={\"version\":\"EC_v1\",\"data\":\"...\",\"signature\":\"...\",\"header\":{\"applicationData\":\"...\",\"transactionId\":\"...\",\"ephemeralPublicKey\":\"...\",\"publicKeyHash\":\"...\"}}");
PKPaymentToken is currently only supported in gwLitle.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| PPSPaymentToken:
A Priority Payment Systems payment token.This configuration setting is used to hold a payment token for use with the Priority Payment Systems gateway. This setting is automatically populated after calling auth_only, sale, or credit for the Priority Payment Systems gateway.
For the Priority Payment Systems gateway, a payment token is used when calling capture to specify what previously-authorized transaction should be captured. This setting must be set before calling capture (the capture method's TransactionId parameter is ignored). (Note that Priority Payment Systems still uses a standard transaction Id for the void_transaction and refund methods, only the capture method uses a payment token instead.) |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| QBMSMobile: Whether or not this transaction is being sent from a mobile device.When using the QBMS gateway, this setting specified whether a transaction is being sent from a mobile device ("True") or not ("False"). The default value is "False". | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| QBPaymentsMobile: Whether or not this transaction is being sent from a mobile device.When using the QBPayments gateway, this setting specified whether a transaction is being sent from a mobile device ("True") or not ("False"). The default value is "False". | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
RawRequest:
Returns the data that was sent to the gateway.This may be queried after a call to any method that sends data to the gateway. This will return the request data that was sent to
the gateway which may be useful for troubleshooting purposes. For instance:
component.Sale()
MyString = component.Config("RawRequest")
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
RawResponse:
Returns the data that was received from the gateway.This may be queried after a call to any method that sends data to the gateway. This will return the response that was received to
the gateway which may be useful for troubleshooting purposes. For instance:
component.Sale()
MyString = component.Config("RawResponse")
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| RecurringIndicator: Marks a request as a recurring transaction.This configuration setting can be set to indicate that a request is a recurring transaction. For a list of supported values for a gateway, please see the "ICharge Gateway Setup and Required Properties" page. This configuration setting is used by the QBPayments gateway. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| RepayCardInfoKey:
Repay Gateway Credit Card Profile Id.If RepayProcessRecurringCredit is set to True this must be set to the credit card profile id value assigned to the payment method when it was added to the system.
Note: RepayCardInfoKey can be obtained via the RecurringBilling class. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
RepayProcessRecurringCredit:
Determines whether to process the transaction via Credit Card Profile Id.Determines whether to process the transaction via customer's Credit Card profile. By default this configuration setting is set to False. If set to True, RepayCardInfoKey and MerchantCode configuration settings must also be set. For instance:
icharge.Config("MerchantCode=YourRepayMerchantKey");
icharge.Config("RepayProcessRecurringCredit=True");
icharge.Config("RepayCardInfoKey=YourRepayCardInfoKey");
icharge.TransactionAmount = "1.00";
icharge.Sale();
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
RepayProcessTokenCredit:
Determines whether to process the transaction using a Credit Card Token.Determines whether to process the transaction using a Credit Card Token provided by Repay Gateway. By default this configuration setting is set to False. If set to True, RepayTokenMode and RepayToken must also be set. For Instance:
icharge.Config("RepayProcessTokenCredit=True");
icharge.Config("RepayToken=YourToken");
icharge.TransactionAmount = "1.00";
icharge.Sale();
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| RepayToken:
Repay Gateway Credit Card Token.
If RepayProcessTokenCredit is set to True, this must be set to the token value assigned to the payment method when it was added to the system.
Note: RepayToken can be obtained via the RecurringBilling class. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| RepayTokenMode:
Indicates the type of token that is being used for the transaction.Indicates the type of token that is being used for the transaction. If RepayProcessTokenCredit is set to True this must be set to one of the following values.
Possible values:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| RepayVoidMode:
Indicates whether to perform a Void or Reversal.If RepayVoidMode is set to "0" (default), void_transaction sends a void to undo an unsettled transaction. If RepayVoidMode is set to "1" (Reversal), this ensures the transaction is unsettled and also removes the authorization from the issuing bank.
Possible values:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ResponseCardNumber: The card number as returned in the response from the gateway. After a request to a gateway, this configuration setting will contain the card number from the gateway's response. This is currently only available when gateway is set to gwAuthorizeNetXML. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ResponseCardType: The card type as returned in the response from the gateway. After a request to a gateway, this configuration setting will contain the card type (Visa, Mastercard, etc.) from the gateway's response. This is currently only available when gateway is set to gwAuthorizeNetXML. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| SagePayCreateToken: Sends a create token request to the SagePay gateway.This is an action config which when called will send a create token request to the SagePay gateway. A successful response will contain the SagePayToken for the specified card_number. Note: when using this config you must set the "VPSProtocol" special_fields to "3.00". | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| SagePayRemoveToken: Sends a remove token request to the SagePay gateway.This is an action config which when called will send a remove token request to the SagePay gateway. The specified SagePayToken will be removed from the SagePay server. Note: when using this config you must set the "VPSProtocol" special_fields to "3.00". | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| SagePayRepeat:
Performs a Repeat transaction for the SagePay gateway.This is an action config which when called will perform a Repeat transaction for the SagePay gateway. The 'TransactionId'
from a previous authorization response, that you would like to repeat for the card associated with the transaction, must be
specified as a parameter. For example, a Repeat transaction using a TransactionId of 123 would be:
ICharge.Config("SagePayRepeat=123").
"RelatedSecurityKey" and "RelatedVendorTXCode" special fields are required for Repeats. These are parsed out of the original authorization response. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| SagePayRequestToken: Specifies whether to request a token when performing an Auth or Sale when using the SagePay gateway.This field allows you to specify whether to have SagePay generate a token and send it in the response. When set to 'True', a token will be returned in a sale or auth_only response and can be accessed via SagePayToken. Note: when using this config you must set the "VPSProtocol" special_fields to "3.00". The default value is 'False'. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| SagePayStoreToken: Specifies whether to store a token when using the SagePay gateway.This field allows you to specify whether to store a token and on the SagePay server. This field must be set to 'True' to have the token remain on the server after use. Otherwise, if set to 'False', the Token will be used to perform the requested transaction and then deleted from the server. Note: when using this config you must set the "VPSProtocol" special_fields to "3.00". The default value is 'False'. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| SagePayToken: The token value for a corresponding card when using the SagePay gateway.This field is used to retrieve or specify a token value. This field will be populated after a call to either SagePayCreateToken or SagePayRequestToken is set to 'True' and a sale or auth_only request is performed. This field can be specified prior to calling SagePayRemoveToken or performing a transaction using a token value instead of card. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| SagePayUseAbort:
Indicates whether to use Abort or Void for void transactions.The SagePay gateway (formerly Protx) has two different void transaction types. If SagePayUseAbort is set to false
(default), void transactions are sent with the VOID transaction type. If true, void transactions are sent with the
ABORT transaction type. Aborts are used for voiding auth-only transactions, and voids are used for voiding sale/capture
transactions.
The response_transaction_id from the original request must be passed as the parameter in the void_transaction method. In addition, the following Special Fields are required for both Abort and Void transactions:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Shift4AuthToken: Specifies the Auth Token when making an Access Token request to the Shift4 gateway.This configuration setting is used to specify the AuthToken to include when making an Access Token Exchange request to the Shift4 gateway. An access token is required for any other interaction with the gateway. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Shift4ClientGuid: Specifies the Client Guid when making an Access Token request to the Shift4 gateway.This configuration setting is used to specify the Client Guid to include when making an Access Token Exchange request to the Shift4 gateway. An access token is required for any other interaction with the gateway. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Shift4GetAccessToken: Performs an Access Token Exchange request with the Shift4 gateway.This is an action config which when called will perform an Access Token Exchange request with the Shift4 gateway. Before calling this config, the merchant_login property and the Shift4InterfaceName, Shift4InterfaceVersion, Shift4AuthToken, and Shift4ClientGuid configuration settings should be set. merchant_password will be set to the access token if the request is successful. Note that an AuthToken can only be exchanged for an access token once, so be sure to save the result of the request for future use. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Shift4InterfaceName: Specifies the name of the interface for the Shift4 gateway.Shift4 requires you to identify the interface that you are using to communicate with the API (i.e. your application). This configuration setting is used to specify the name of the interface. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Shift4InterfaceVersion: Specifies the version of the interface for the Shift4 gateway.Shift4 requires you to identify the interface that you are using to communicate with the API (i.e. your application). This configuration setting is used to specify the version of the interface. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SquareAdditionalRecipients:
Additional recipients data to send with a Square Sale or AuthOnly request.This setting can be set to a JSON array like the following one in order to send one or more additional recipients data objects when calling sale or auth_only:
[
{
"location_id": "057P5VYJ4A5X1",
"description": "Application fees",
"amount_money": {
"amount": 20,
"currency": "USD"
},
"receivable_id": "ISu5xwxJ5v0CMJTQq7RvqyMF"
}
]
Note: Content set using this setting will be used as the value of the additional_recipients JSON field in the request body; it is not validated or manipulated first, it is used "as-is". This configuration setting is only used by the Square Transactions API (gwSquare).
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| SquareApplicationFee: Allows you to specify an application fee as part of the transaction.This setting can be set to an amount that should be charged to the merchant as an application fee for making the transaction. This should a whole number in the smallest denomination of the selected currency, so for example if the currency is set to USD and this value is set to 100, there will be a $1 application fee. This configuration setting is only used by the Square Payments API (gwSquarePayments). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| SquareCustomerCardId:
The Id of the card saved to a customer profile.This configuration setting is used to specify the Id of a card-on-file associated with the Square customer profile specified by customer_id (which must be set, along with this configuration setting, to when making a sale or auth_only request against a card-on-file).
Note that if a card nonce has been specified using the CardToken configuration setting, this setting's value is ignored and the card nonce is sent instead (regardless of whether customer_id is set). This configuration setting is used by both the Square Transactions API (gwSquare) and the Square Payments API (gwSquarePayments). |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| SquareIdempotencyKey:
Value that uniquely identifies a Square Sale, AuthOnly, or Refund request.Square requires that each sale, auth_only, or refund request have an idempotency key sent with it.
Idempotency key values should uniquely represent a real sale, auth_only, or refund. Any sale, auth_only, or refund request made using a duplicate idempotency key is ignored by Square. This configuration setting is used by both the Square Transactions API (gwSquare) and the Square Payments API (gwSquarePayments). |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| SquareLocationId:
Square location Id to make the transaction request against.Square requires that all transaction requests be made against one of the "location Ids" associated with a merchant's account.
This configuration setting must be set prior to making any requests when gateway is set to gwSquare. This configuration setting is required by the Square Transactions API (gwSquare) and optional in the Square Payments API (gwSquarePayments). |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| SquareOrderId:
Square Order Id to associate with a Square Sale or AuthOnly request.This configuration setting can be used to specify a Square Order Id to associate with a sale or auth_only transaction request.
Note: Square will reject any transaction request that includes an Order Id if that transaction's amount does not match the associated Order's total amount. This configuration setting is used by both the Square Transactions API (gwSquare) and the Square Payments API (gwSquarePayments). |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| SquareTenderId:
Square Tender Id associated with a Square transaction.This configuration setting is used to specify a Square Tender Id. It is populated after a successful sale or auth_only request, and must be specified before making a refund request.
Important: In addition to a Tender Id, Square transactions also have a Transaction Id. Be sure to persist both Ids after making a sale or auth_only request, as both are required in order to make a refund request! This configuration setting is only used by the Square Transactions API (gwSquare). |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| StoreCardOnFile: For the Stored Credentials framework - Used to indicate that the merchant will be storing the customer's card on file (COF).For the Stored Credentials framework, this configuration setting should be set to true to indicate that the merchant will be storing the customer's card information. Permission should be obtained from the customer prior to storing card data. This configuration setting is used by the CyberSource gateway. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| StripeApplicationFee: A fee in cents that will be applied to the charge.A fee in cents that will be applied to the charge and transferred to the application owner's Stripe account. To use an application fee, the request must be made on behalf of another account, using StripeOnBehalfOf and StripeDestinationAccount configuration settings. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| StripeDestinationAccount: Id of an existing, connected Stripe account.Id of an existing, connected stripe account. This configuration setting is required when an application fee will be transferred to the application owner's Stripe account via StripeApplicationFee configuration settings. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| StripeDestinationAmount: The amount to transfer to the destination account.The amount to transfer to the destination account without creating an application fee. Cannot be combined with the StripeApplicationFee configuration setting. Must be equal to or lesser than the charge amount. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| StripeOnBehalfOf: The Stripe account Id that these funds are intended for.The Stripe account Id that funds are intended for. Automatically set if you are also setting the StripeApplicationFee configuration setting. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| StripeRefundApplicationFee:
Whether the application fee should be refunded when refunding the charge.Whether the application fee should be refunded when refunding the charge. If a full charge refund is given, the full application fee will be refunded. Else, the application fee will be refunded with an amount proportional to the amount of the charge refunded.
An application fee can only be refunded by the application that created the charge. This configuration setting is optional and can be set to either True or False.
Note that by default Stripe will not refund application fees. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| StripeRefundReason: Reason for the refund.Reason for the refund. Possible values are duplicate, fraudulent, and requested_by_customer. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| StripeRefundReverseTransfer:
Whether the transfer should be reversed when refunding the charge.Whether the transfer should be reversed when refunding the charge. The transfer will be reversed for the same amount being refunded (either the entire or partial amount).
A transfer can only be reversed by the application that created the charge. This configuration setting is optional and can be set to either True or False.
Note that by default Stripe will not refund application fees. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| StripeShippingCarrier: The delivery service that shipped a physical product.The delivery service that shipped a physical product, such as FedEx, UPS, USPS, etc. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| StripeShippingTrackingNumber: The tracking number for a physical product.The tracking number for a physical product, obtained from the delivery service. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| StripeTransferGroup: Identifies the transaction as part of a group.Identifies the transaction as part of a group. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| StripeVersion: Determines which version of the Stripe API should be used.When making a transaction with Stripe, this configuration setting tells Stripe which version of the API will be used. By default, Stripe will use the API version configured on the merchant's account. This setting should be the date of the version you want to use, such as "2019-09-09". | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| SurchargeAmount: Used to specify the amount of the surcharge for the transaction.This configuration setting is used when there is an additional fee included in the transaction to specify the amount of that fee. This field is used by the Shift4 gateway. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| TerminalId: Terminal Id value sent in the transaction.Many gateways allow/require an Id (terminal, developer, client, user, etc) sent in addition to the merchant_login and merchant_password. This config is supported for the following gateways: Adyen (required), BarClay (required), BluePay, Nuvei (required), Heartland, HSBC (required), Orbital, PayFuse (required), PaymentWorksuite, Planet Payment (required), SkipJack, and WorldPayXML (required). For Orbital, this config is optional but if not specified a value of '001' will be sent. For Heartland, this config is used for MasterCard's Card Accepter Terminal Id requirement. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| TipAmount: Used to specify the amount of the tip for the transaction.This configuration setting is used when there is a tip included in the transaction to specify the amount of the tip. This field is used by the Shift4 gateway. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| USAEPayPerformVoidRelease: Specifies whether to perform a void or void:release transaction.This field is used to specify whether you wish to perform a void or void:release transaction when void_transaction is called. When set to "True", the void:release transaction will be sent. The void:release transaction is the same as a void with the exception that the cardholders bank is notified immediately that they can release the funds. The regular void transaction, on the other hand, does not notify the cardholder bank until the batch closes. The default value is "False" (so a regular void transaction is sent). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| UseCardOnFile: For the Stored Credentials framework - Used to indicate that the merchant is using stored card on file (COF) information for the request.For the Stored Credentials framework, this configuration setting should be set to true to indicate that the merchant is using stored card information. This configuration setting is used by the CyberSource gateway. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| UserId: Used to specify an Id for the API user.This configuration setting is used to specify an Id for the user, if one is required. Used by the Barclay, Ingenico, Metrobank, and Shift4 gateways. For the Barclay and Ingenico gateways, this configuration setting should contain the name of your application (API) user. For Shift4 or Metrobank, this is the clerk or terminal operator. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
VeritasBankName:
Name of the card issuer.This configuration setting is required when calling the sale method and must be set to the name of the card issuer. For example:
icharge.Config("VeritasBankName=Bank of China");
icharge.Sale();
Note: The BankName setting can be used instead of this.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| VeritasEncryptionKey: Encryption key used to encrypt credit card information.This configuration setting must be set to the encryption key provided by the gateway. Encryption key used to encrypt credit card information.This configuration setting must be set to the encryption key provided by the gateway. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| VeritasEncryptionKey: Encryption key used to encrypt credit card information.This configuration setting must be set to the encryption key provided by the gateway. Encryption key used to encrypt credit card information.This configuration setting must be set to the encryption key provided by the gateway. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| VeritasToken: Veritas token.Veritas token is provided by the gateway when activating the merchant account. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| VeritasVoidRefundReasonId:
Veritas gateway void reason.Reason for voiding an authorized transaction for Veritas gateway. This configuration setting must be set when calling the void_transaction method.
Possible values:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| WorldpayOnlineToken: Worldpay Online token.Worldpay Online token used in place of payment information when making a transaction. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
WorldpayOnlineTokenAction:
Used to generate, update, or delete a Worldpay Online token.This configuration setting, when set, will cause the class either generate, update, or delete a Worldpay Online token. Valid values are:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| XChildrenCount:
The number of child elements of the current element.The number of child attributes of the current element. The XChildren configuration options will be indexed from 0 to XChildrenCount-1.
The current element is specified via the XPath configuration option. This configuration option is read-only. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| XChildrenName[x]:
The name of the child element.Provides the name of the x'th child element of the current element.
The current element is specified via the XPath configuration option. This configuration option is read-only. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| XChildrenXText[x]:
The inner text of the child element.Provides the inner text of the x'th child element of the current element.
The current element is specified via the XPath configuration option. This configuration option is read-only. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| XElement:
The name of the current element.The current element is specified via the XPath configuration option.
This configuration option is read-only. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
XPath:
Provides a way to point to a specific element in the returned XML or JSON response.XPath implements a subset of the XML and JSON XPath specification, allowing you to point to specific elements in the XML or JSON documents.
The path is a series of one or more element accessors separated by '/'. The path can be absolute (starting with '/') or relative to the current XPath location.
The following are possible values for an element accessor:
Example (Setting XPath for XML)
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| XText:
The text of the current element.The current element is specified in the XPath configuration option.
This configuration option is read-only. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
HTTP Config Settings | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| AcceptEncoding: Used to tell the server which types of content encodings the client supports.When AllowHTTPCompression is True, the class adds an Accept-Encoding header to the request being sent to the server. By default, this header's value is "gzip, deflate". This configuration setting allows you to change the value of the Accept-Encoding header. Note: The class only supports gzip and deflate decompression algorithms. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| AllowHTTPCompression:
This property enables HTTP compression for receiving data.This configuration setting enables HTTP compression for receiving data.
When set to True (default), the class will accept compressed data. It then will uncompress the data it has received. The class will handle data compressed by both gzip and deflate compression algorithms.
When True, the class adds an Accept-Encoding header to the outgoing request. The value for this header can be controlled by the AcceptEncoding configuration setting. The default value for this header is "gzip, deflate". The default value is True. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| AllowHTTPFallback:
Whether HTTP/2 connections are permitted to fallback to HTTP/1.1.This configuration setting controls whether HTTP/2 connections are permitted to fall back to HTTP/1.1 when the server
does not support HTTP/2. This setting is applicable only when http_version is set to "2.0".
If set to True (default), the class will automatically use HTTP/1.1 if the server does not support HTTP/2. If set to False, the class fails with an error if the server does not support HTTP/2. The default value is True. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Append: Whether to append data to LocalFile.This configuration setting determines whether data will be appended when writing to local_file. When set to True, downloaded data will be appended to local_file. This may be used in conjunction with range to resume a failed download. This is applicable only when local_file is set. The default value is False. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Authorization:
The Authorization string to be sent to the server.If the Authorization property contains a nonempty string,
an Authorization HTTP request header is added to the
request. This header conveys Authorization information to the
server.
This property is provided so that the HTTP class can be extended with other security schemes in addition to the authorization schemes already implemented by the class. The auth_scheme property defines the authentication scheme used. In the case of HTTP Basic Authentication (default), every time user and password are set, they are Base64 encoded, and the result is put in the authorization property in the form "Basic [encoded-user-password]". |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| BytesTransferred: Contains the number of bytes transferred in the response data.This configuration setting returns the raw number of bytes from the HTTP response data, before the component processes the data, whether it is chunked or compressed. This returns the same value as the on_transfer event, by BytesTransferred. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ChunkSize: Specifies the chunk size in bytes when using chunked encoding.This is applicable only when UseChunkedEncoding is True. This setting specifies the chunk size in bytes to be used when posting data. The default value is 16384. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| CompressHTTPRequest:
Set to true to compress the body of a PUT or POST request.If set to True, the body of a PUT or POST request will be compressed into gzip format before sending the request. The "Content-Encoding" header is also added to the outgoing request.
The default value is False. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| EncodeURL: If set to True the URL will be encoded by the class.If set to True, the URL passed to the class will be URL encoded. The default value is False. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| FollowRedirects:
Determines what happens when the server issues a redirect.This option determines what happens when the server issues a redirect. Normally, the class returns an error if the server responds
with an "Object Moved" message. If this property is set to 1 (always), the new url for the object is retrieved automatically every time.
If this property is set to 2 (Same Scheme), the new url is retrieved automatically only if the URL Scheme is the same; otherwise, the class fails with an error. Note: Following the HTTP specification, unless this option is set to 1 (Always), automatic redirects will be performed only for GET or HEAD requests. Other methods potentially could change the conditions of the initial request and create security vulnerabilities. Furthermore, if either the new URL server or port are different from the existing one, user and password are also reset to empty, unless this property is set to 1 (Always), in which case the same credentials are used to connect to the new server. A on_redirect event is fired for every URL the product is redirected to. In the case of automatic redirections, the on_redirect event is a good place to set properties related to the new connection (e.g., new authentication parameters). The default value is 0 (Never). In this case, redirects are never followed, and the class fails with an error instead. Following are the valid options:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| GetOn302Redirect: If set to True the class will perform a GET on the new location.The default value is False. If set to True, the class will perform a GET on the new location. Otherwise, it will use the same HTTP method again. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| HTTP2HeadersWithoutIndexing: HTTP2 headers that should not update the dynamic header table with incremental indexing.HTTP/2 servers maintain a dynamic table of headers and values seen over the course of a connection. Typically, these headers are inserted into the table through incremental indexing (also known as HPACK, defined in RFC 7541). To tell the component not to use incremental indexing for certain headers, and thus not update the dynamic table, set this configuration option to a comma-delimited list of the header names. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
HTTPVersion:
The version of HTTP used by the class.This property specifies the HTTP version used by the class. Possible values are as follows:
When using HTTP/2 ("2.0"), additional restrictions apply. Please see the following notes for details.
HTTP/2 NotesWhen using HTTP/2, a secure Secure Sockets Layer/Transport Layer Security (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/2 will result in an error. If the server does not support HTTP/2, the class will automatically use HTTP/1.1 instead. This is done to provide compatibility without the need for any additional settings. To see which version was used, check NegotiatedHTTPVersion after calling a method. The AllowHTTPFallback setting controls whether this behavior is allowed (default) or disallowed.
HTTP/3 NotesHTTP/3 is supported only in .NET and Java. When using HTTP/3, a secure (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/3 will result in an error. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| IfModifiedSince:
A date determining the maximum age of the desired document.If this setting contains a nonempty string, an If-Modified-Since HTTP header is added to the request.
The value of this header is used to make the HTTP request conditional: if the requested documented has not
been modified since the time specified in the field, a copy of the document will not be returned from
the server; instead, a 304 (not modified) response will be returned by the server and the component throws an exception
The format of the date value for IfModifiedSince is detailed in the HTTP specs. For example:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| KeepAlive:
Determines whether the HTTP connection is closed after completion of the request.If True, the component will not send the Connection: Close header. The absence of the Connection header indicates to the server
that HTTP persistent connections should be used if supported.
Note: Not all servers support persistent connections. You also may explicitly add the Keep-Alive header to the request headers by setting other_headers to Connection: Keep-Alive.
If False, the connection will be closed immediately after the server response is received.
The default value for KeepAlive is False. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| KerberosSPN: The Service Principal Name for the Kerberos Domain Controller.If the Service Principal Name on the Kerberos Domain Controller is not the same as the URL that you are authenticating to, the Service Principal Name should be set here. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
LogLevel:
The level of detail that is logged.This configuration setting controls the level of detail that is logged through the on_log event. Possible values are as follows:
The value 1 (Info) logs basic information, including the URL, HTTP version, and status details. The value 2 (Verbose) logs additional information about the request and response. The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any). |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| MaxRedirectAttempts: Limits the number of redirects that are followed in a request.When follow_redirects is set to any value other than frNever, the class will follow redirects until this maximum number of redirect attempts are made. The default value is 20. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| NegotiatedHTTPVersion: The negotiated HTTP version.This configuration setting may be queried after the request is complete to indicate the HTTP version used. When http_version is set to "2.0" (if the server does not support "2.0"), then the class will fall back to using "1.1" automatically. This setting will indicate which version was used. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| OtherHeaders:
Other headers as determined by the user (optional).This configuration setting can be set to a string of headers to be appended to the HTTP request headers.
The headers must follow the format "header: value" as described in the HTTP specifications. Header lines should be separated by CRLF ("\r\n") . Use this configuration setting with caution. If this configuration setting contains invalid headers, HTTP requests may fail. This configuration setting is useful for extending the functionality of the class beyond what is provided. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ProxyAuthorization: The authorization string to be sent to the proxy server.This is similar to the Authorization configuration setting, but is used for proxy authorization. If this configuration setting contains a nonempty string, a Proxy-Authorization HTTP request header is added to the request. This header conveys proxy Authorization information to the server. If proxy_user and proxy_password are specified, this value is calculated using the algorithm specified by proxy_auth_scheme. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ProxyAuthScheme: The authorization scheme to be used for the proxy.This configuration setting is provided for use by classs that do not directly expose Proxy properties. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ProxyPassword: A password if authentication is to be used for the proxy.This configuration setting is provided for use by classs that do not directly expose Proxy properties. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ProxyPort: Port for the proxy server (default 80).This configuration setting is provided for use by classs that do not directly expose Proxy properties. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ProxyServer: Name or IP address of a proxy server (optional).This configuration setting is provided for use by classs that do not directly expose Proxy properties. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ProxyUser: A user name if authentication is to be used for the proxy.This configuration setting is provided for use by classs that do not directly expose Proxy properties. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| SentHeaders: The full set of headers as sent by the client.This configuration setting returns the complete set of raw headers as sent by the client. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| StatusLine: The first line of the last response from the server.This setting contains the first line of the last response from the server. The format of the line will be [HTTP version] [Result Code] [Description]. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| TransferredData: The contents of the last response from the server.This configuration setting contains the contents of the last response from the server. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| TransferredDataLimit: The maximum number of incoming bytes to be stored by the class.If TransferredDataLimit is set to 0 (default), no limits are imposed. Otherwise, this reflects the maximum number of incoming bytes that can be stored by the class. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| TransferredHeaders: The full set of headers as received from the server.This configuration setting returns the complete set of raw headers as received from the server. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| TransferredRequest:
The full request as sent by the client.This configuration setting returns the full request as sent by the client. For performance reasons, the request is not normally saved. Set this configuration setting to ON before making a request to enable it. Following are examples of this request:
.NET
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| UseChunkedEncoding:
Enables or Disables HTTP chunked encoding for transfers.If UseChunkedEncoding is set to True, the class will use HTTP-chunked encoding when posting, if possible.
HTTP-chunked encoding allows large files to be sent in chunks instead of all at once.
If set to False, the class will not use HTTP-chunked encoding. The default value is False.
Note: Some servers (such as the ASP.NET Development Server) may not support chunked encoding. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| UseIDNs:
Whether to encode hostnames to internationalized domain names.This configuration setting specifies whether hostnames containing non-ASCII characters are encoded to internationalized domain names. When set to True, if a hostname contains non-ASCII characters, it is encoded using Punycode to an IDN (internationalized domain name).
The default value is False and the hostname will always be used exactly as specified. Note: The CodePage setting must be set to a value capable of interpreting the specified host name. For instance, to specify UTF-8, set CodePage to 65001. In the C++ Edition for Windows, the *W version of the class must be used. For instance, DNSW or HTTPW. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| UsePlatformHTTPClient:
Whether or not to use the platform HTTP client.When using this configuration setting, if True, the component will use the default HTTP client for the platform (URLConnection in Java, WebRequest in .NET, or CFHTTPMessage in Mac/iOS) instead of the internal HTTP implementation. This is important for environments in which direct access to sockets is limited or not allowed (e.g., in the Google AppEngine).
Note: This setting is applicable only to Mac/iOS editions. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| UseProxyAutoConfigURL:
Whether to use a Proxy auto-config file when attempting a connection.This configuration specifies whether the class will attempt to use the Proxy auto-config URL when establishing a connection and proxy_auto_detect is set to True.
When True (default), the class will check for the existence of a Proxy auto-config URL, and if found, will determine the appropriate proxy to use. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| UserAgent:
Information about the user agent (browser).This is the value supplied in the HTTP User-Agent header. The default
setting is "IPWorks HTTP Component - www.nsoftware.com".
Override the default with the name and version of your software. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
TCPClient Config Settings | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ConnectionTimeout: Sets a separate timeout value for establishing a connection.When set, this configuration setting allows you to specify a different timeout value for establishing a connection. Otherwise, the class will use timeout for establishing a connection and transmitting/receiving data. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| FirewallAutoDetect: Tells the class whether or not to automatically detect and use firewall system settings, if available.This configuration setting is provided for use by classs that do not directly expose Firewall properties. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| FirewallHost:
Name or IP address of firewall (optional).If a FirewallHost is given, requested connections will be authenticated through the specified firewall
when connecting.
If the FirewallHost setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the FirewallHost setting is set to the corresponding address. If the search is not successful, an error is returned. Note: This setting is provided for use by classs that do not directly expose Firewall properties. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| FirewallPassword:
Password to be used if authentication is to be used when connecting through the firewall.If FirewallHost is specified, the FirewallUser and FirewallPassword settings
are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.
Note: This setting is provided for use by classs that do not directly expose Firewall properties. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| FirewallPort:
The TCP port for the FirewallHost;.The FirewallPort is set automatically when FirewallType is set to a valid value.
Note: This configuration setting is provided for use by classs that do not directly expose Firewall properties. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
FirewallType:
Determines the type of firewall to connect through.The appropriate values are as follows:
Note: This setting is provided for use by classs that do not directly expose Firewall properties. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| FirewallUser:
A user name if authentication is to be used connecting through a firewall.If the FirewallHost is specified, the FirewallUser and FirewallPassword
settings are used to connect and authenticate to the Firewall. If the authentication fails, the class fails with an error.
Note: This setting is provided for use by classs that do not directly expose Firewall properties. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| KeepAliveInterval:
The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.When set, TCPKeepAlive will automatically be set to True.
A TCP keep-alive packet will be sent after a period of inactivity as
defined by KeepAliveTime. If no acknowledgment is received from the remote host, the keep-alive packet
will be sent again. This configuration setting specifies the interval at which the successive keep-alive packets are sent in milliseconds.
This system default if this value is not specified here is 1 second.
Note: This value is not applicable in macOS. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| KeepAliveTime: The inactivity time in milliseconds before a TCP keep-alive packet is sent.When set, TCPKeepAlive will automatically be set to True. By default, the operating system will determine the time a connection is idle before a Transmission Control Protocol (TCP) keep-alive packet is sent. This system default if this value is not specified here is 2 hours. In many cases, a shorter interval is more useful. Set this value to the desired interval in milliseconds. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Linger:
When set to True, connections are terminated gracefully.This property controls how a connection is closed. The default is True.
In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if LingerTime is 0 (default), the system will attempt to send pending data for a connection until the default IP timeout expires. In the second scenario, if LingerTime is a positive value, the system will attempt to send pending data until the specified LingerTime is reached. If this attempt fails, then the system will reset the connection. The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the class returns control immediately, the system could hold system resources until all pending data are sent (even after your application closes). Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (e.g., by a client acknowledgment), setting this property to False might be the appropriate course of action. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| LingerTime: Time in seconds to have the connection linger. LingerTime is the time, in seconds, the socket connection will linger. This value is 0 by default, which means it will use the default IP timeout. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| LocalHost:
The name of the local host through which connections are initiated or accepted.
The local_host setting contains the name of the local host
as obtained by the gethostname() system call, or if the
user has assigned an IP address, the value of that address.
In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface. If the class is connected, the local_host setting shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multi-homed hosts (machines with more than one IP interface). |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| LocalPort:
The port in the local host where the class binds.
This must be set before a connection is
attempted. It instructs the class to bind to a specific
port (or communication endpoint) in the local machine.
Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by local_port after the connection is established. local_port cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error. This; setting is useful when trying to connect to services that require a trusted port in the client side. An example is the remote shell (rsh) service in UNIX systems. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| MaxLineLength:
The maximum amount of data to accumulate when no EOL is found.MaxLineLength is the size of an internal buffer, which holds received data while waiting for an eol
string.
If an eol string is found in the input stream before MaxLineLength bytes are received, the on_data_in event is fired with the EOL parameter set to True, and the buffer is reset. If no eol is found, and MaxLineLength bytes are accumulated in the buffer, the on_data_in event is fired with the EOL parameter set to False, and the buffer is reset. The minimum value for MaxLineLength is 256 bytes. The default value is 2048 bytes. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| MaxTransferRate: The transfer rate limit in bytes per second.This configuration setting can be used to throttle outbound TCP traffic. Set this to the number of bytes to be sent per second. By default, this is not set and there is no limit. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ProxyExceptionsList:
A semicolon separated list of hosts and IPs to bypass when using a proxy.This configuration setting optionally specifies a semicolon-separated list of hostnames or IP addresses to bypass when a proxy is in use.
When requests are made to hosts specified in this property, the proxy will not be used. For instance:
www.google.com;www.nsoftware.com |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| TCPKeepAlive:
Determines whether or not the keep alive socket option is enabled.If set to True, the socket's keep-alive option is enabled and keep-alive packets will be sent periodically
to maintain the connection. Set KeepAliveTime and KeepAliveInterval to
configure the timing of the keep-alive packets.
Note: This value is not applicable in Java. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| TcpNoDelay:
Whether or not to delay when sending packets.
When true, the socket will send all data that is ready to send at once. When
false, the socket will send smaller buffered packets of data at small intervals.
This is known as the Nagle algorithm.
By default, this config is set to false. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
UseIPv6:
Whether to use IPv6.When set to 0 (default), the class will use IPv4 exclusively.
When set to 1, the class will use IPv6 exclusively. To instruct the class to prefer IPv6 addresses, but use IPv4 if IPv6 is not supported on the system, this setting should be set to 2. The default value is 0.
Possible values are:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSL Config Settings | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| LogSSLPackets:
Controls whether SSL packets are logged when using the internal security API.When ssl_provider is set to Internal, this setting controls whether SSL packets should be logged. By default, this setting is False, as it is only useful for debugging purposes.
When enabled, SSL packet logs are output using the on_ssl_status event, which will fire each time an SSL packet is sent or received. Enabling this setting has no effect if ssl_provider is set to Platform. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| OpenSSLCADir:
The path to a directory containing CA certificates.This functionality is available only when the provider is OpenSSL.
The path set by this property should point to a directory containing CA certificates in PEM format. The files each contain one CA certificate. The files are looked up by the CA subject name hash value, which must hence be available. If more than one CA certificate with the same name hash value exist, the extension must be different (e.g. 9d66eef0.0, 9d66eef0.1 etc). OpenSSL recommends to use the c_rehash utility to create the necessary links. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| OpenSSLCAFile:
Name of the file containing the list of CA's trusted by your application.This functionality is available only when the provider is OpenSSL.
The file set by this property should contain a list of CA certificates in PEM format. The file can contain several CA certificates identified by -----BEGIN CERTIFICATE----- ... (CA certificate in base64 encoding) ... -----END CERTIFICATE----- sequences. Before, between, and after the certificates text is allowed which can be used e.g. for descriptions of the certificates. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| OpenSSLCipherList:
A string that controls the ciphers to be used by SSL.This functionality is available only when the provider is OpenSSL.
The format of this string is described in the OpenSSL man page ciphers(1) section "CIPHER LIST FORMAT". Please refer to it for details. The default string "DEFAULT" is determined at compile time and is normally equivalent to "ALL:!ADH:RC4+RSA:+SSLv2:@STRENGTH". |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| OpenSSLPrngSeedData:
The data to seed the pseudo random number generator (PRNG).This functionality is available only when the provider is OpenSSL.
By default OpenSSL uses the device file "/dev/urandom" to seed the PRNG and setting OpenSSLPrngSeedData is not required. If set, the string specified is used to seed the PRNG. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ReuseSSLSession:
Determines if the SSL session is reused.
If set to true, the class will reuse the context if and only if the following criteria are met:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| SSLCACertFilePaths:
The paths to CA certificate files on Unix/Linux.This setting specifies the paths on disk to CA certificate files on Unix/Linux.
The value is formatted as a list of paths separated by semicolons. The class will check for the existence of each file in the order specified. When a file is found the CA certificates within the file will be loaded and used to determine the validity of server or client certificates. The default value is: /etc/ssl/ca-bundle.pem;/etc/pki/tls/certs/ca-bundle.crt;/etc/ssl/certs/ca-certificates.crt;/etc/pki/tls/cacert.pem |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSLCACerts:
A newline separated list of CA certificate to use during SSL client authentication.This setting specifies one or more CA certificates to be included in the request when performing
SSL client authentication. Some servers require the entire chain, including CA certificates, to be presented
when performing SSL client authentication. The value of this setting is a newline (CrLf) separated list of certificates. For instance:
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp .. d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE----- |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| SSLCheckCRL:
Whether to check the Certificate Revocation List for the server certificate.This setting specifies whether the class will check the Certificate Revocation List specified by the server certificate. If set to 1 or 2, the class will first obtain the list of CRL URLs from the server certificate's CRL distribution points extension. The class will then make HTTP requests to each CRL endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation the class fails with an error.
When set to 0 (default) the CRL check will not be performed by the class. When set to 1, it will attempt to perform the CRL check, but will continue without an error if the server's certificate does not support CRL. When set to 2, it will perform the CRL check and will throw an error if CRL is not supported. This configuration setting is only supported in the Java, C#, and C++ editions. In the C++ edition, it is only supported on Windows operating systems. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| SSLCheckOCSP:
Whether to use OCSP to check the status of the server certificate.This setting specifies whether the class will use OCSP to check the validity of the server certificate. If set to 1 or 2, the class will first obtain the OCSP URL from the server certificate's OCSP extension. The class will then locate the issuing certificate and make an HTTP request to the OCSP endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation the class fails with an error.
When set to 0 (default) the class will not perform an OCSP check. When set to 1, it will attempt to perform the OCSP check, but will continue without an error if the server's certificate does not support OCSP. When set to 2, it will perform the OCSP check and will throw an error if OCSP is not supported. This configuration setting is only supported in the Java, C#, and C++ editions. In the C++ edition, it is only supported on Windows operating systems. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| SSLCipherStrength:
The minimum cipher strength used for bulk encryption.
This minimum cipher strength largely dependent on the security modules installed
on the system. If the cipher strength specified is not supported,
an error will be returned when connections are initiated.
Please note that this setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the on_ssl_status event. Use this setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application. When the provider is OpenSSL, SSLCipherStrength is currently not supported. This functionality is instead made available through the OpenSSLCipherList config setting. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| SSLEnabledCipherSuites:
The cipher suite to be used in an SSL negotiation.The enabled cipher suites to be used in SSL negotiation.
By default, the enabled cipher suites will include all available ciphers ("*"). The special value "*" means that the class will pick all of the supported cipher suites. If SSLEnabledCipherSuites is set to any other value, only the specified cipher suites will be considered. Multiple cipher suites are separated by semicolons. Example values when ssl_provider is set to Platform:
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_DH_ANON_WITH_AES_128_CBC_SHA");
Possible values when ssl_provider is set to Internal include:
When TLS 1.3 is negotiated (see SSLEnabledProtocols) only the following cipher suites are supported:
SSLEnabledCipherSuites is used together with SSLCipherStrength. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| SSLEnabledProtocols:
Used to enable/disable the supported security protocols.Used to enable/disable the supported security protocols.
Not all supported protocols are enabled by default (the value of this setting is 4032). If you want more granular control over the enabled protocols, you can set this property to the binary 'OR' of one or more of the following values:
SSLEnabledProtocols - TLS 1.3 Notes By default when TLS 1.3 is enabled the class will use the internal TLS implementation when the ssl_provider is set to Automatic for all editions. In editions which are designed to run on Windows ssl_provider can be set to Platform to use the platform implementation instead of the internal implementation. When configured in this manner, please note that the platform provider is only supported on Windows 11 / Windows Server 2022 and up. The default internal provider is available on all platforms and is not restricted to any specific OS version. If set to 1 (Platform provider) please be aware of the following notes:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| SSLEnableRenegotiation:
Whether the renegotiation_info SSL extension is supported.This setting specifies whether the renegotiation_info SSL extension will be used in the request when using the internal security API.
This setting is True by default, but can be set to False to disable the extension.
This setting is only applicable when ssl_provider is set to Internal. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| SSLIncludeCertChain:
Whether the entire certificate chain is included in the SSLServerAuthentication event.This setting specifies whether the Encoded parameter of the on_ssl_server_authentication event contains
the full certificate chain. By default this value is False and only the leaf certificate will be present
in the Encoded parameter of the on_ssl_server_authentication event.
If set to True all certificates returned by the server will be present in the Encoded parameter of the on_ssl_server_authentication event. This includes the leaf certificate, any intermediate certificate, and the root certificate. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| SSLKeyLogFile:
The location of a file where per-session secrets are written for debugging purposes.This setting optionally specifies the full path to a file on disk where per-session secrets are stored for debugging purposes.
When set, the class will save the session secrets in the same format as the SSLKEYLOGFILE environment variable functionality used by most major browsers and tools such as Chrome, Firefox, and cURL. This file can then be used in tools such as Wireshark to decrypt TLS traffice for debugging purposes. When writing to this file the class will only append, it will not overwrite previous values. Note: This setting is only applicable when ssl_provider is set to Internal. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| SSLNegotiatedCipher:
Returns the negotiated ciphersuite.Returns the ciphersuite negotiated during the SSL handshake.
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| SSLNegotiatedCipherStrength:
Returns the negotiated ciphersuite strength.Returns the strength of the ciphersuite negotiated during the SSL handshake.
Note: For server components (e.g.TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| SSLNegotiatedCipherSuite:
Returns the negotiated ciphersuite.Returns the ciphersuite negotiated during the SSL handshake represented as a single string.
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| SSLNegotiatedKeyExchange:
Returns the negotiated key exchange algorithm.Returns the key exchange algorithm negotiated during the SSL handshake.
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| SSLNegotiatedKeyExchangeStrength:
Returns the negotiated key exchange algorithm strength.Returns the strenghth of the key exchange algorithm negotiated during the SSL handshake.
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| SSLNegotiatedVersion:
Returns the negotiated protocol version.Returns the protocol version negotiated during the SSL handshake.
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSLSecurityFlags:
Flags that control certificate verification.The following flags are defined (specified in hexadecimal
notation). They can be or-ed together to exclude multiple
conditions:
This functionality is currently not available when the provider is OpenSSL. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| SSLServerCACerts:
A newline separated list of CA certificate to use during SSL server certificate validation.This setting optionally specifies one or more CA certificates to be used when verifying the server certificate. When verifying the server's certificate the certificates trusted by the system will be used as part of the verification process. If the server's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This setting should only be set if the server's CA certificates are not already trusted on the system and cannot be installed to the trusted system store.
The value of this setting is a newline (CrLf) separated list of certificates. For instance: -----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp .. d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE----- |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| TLS12SignatureAlgorithms:
Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.This setting specifies the allowed server certificate signature algorithms when ssl_provider is set to Internal and SSLEnabledProtocols is set to allow TLS 1.2.
When specified the class will verify that the server certificate signature algorithm is among the values specified in this setting. If the server certificate signature algorithm is unsupported the class fails with an error. The format of this value is a comma separated list of hash-signature combinations. For instance:
In order to not restrict the server's certificate signature algorithm, specify an empty string as the value for this setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| TLS12SupportedGroups:
The supported groups for ECC.This setting specifies a comma separated list of named groups used in TLS 1.2 for ECC.
The default value is ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1. When using TLS 1.2 and ssl_provider is set to Internal, the values refer to the supported groups for ECC. The following values are supported:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| TLS13KeyShareGroups:
The groups for which to pregenerate key shares.This setting specifies a comma separated list of named groups used in TLS 1.3 for key exchange.
The groups specified here will have key share data pregenerated locally before establishing a connection.
This can prevent an additional round trip during the handshake if the group is supported by the server.
The default value is set to balance common supported groups and the computational resources required to generate key shares. As a result only some groups are included by default in this setting. Note: All supported groups can always be used during the handshake even if not listed here, but if a group is used which is not present in this list it will incur an additional round trip and time to generate the key share for that group. In most cases this setting does not need to be modified. This should only be modified if there is a specific reason to do so. The default value is ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072 The values are ordered from most preferred to least preferred. The following values are supported:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
TLS13SignatureAlgorithms:
The allowed certificate signature algorithms.This setting holds a comma separated list of allowed signature algorithms. Possible values are:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| TLS13SupportedGroups:
The supported groups for (EC)DHE key exchange.This setting specifies a comma separated list of named groups used in TLS 1.3 for key exchange.
This setting should only be modified if there is a specific reason to do so.
The default value is ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192 The values are ordered from most preferred to least preferred. The following values are supported:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Socket Config Settings | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| AbsoluteTimeout:
Determines whether timeouts are inactivity timeouts or absolute timeouts.If AbsoluteTimeout is set to True, any method which does not complete within Timeout seconds
will be aborted. By default, AbsoluteTimeout is False, and the timeout is an inactivity timeout.
Note: This option is not valid for UDP ports. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| FirewallData: Used to send extra data to the firewall.When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g. headers for custom authentication schemes). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| InBufferSize:
The size in bytes of the incoming queue of the socket.
This is the size of an internal queue in the TCP/IP stack.
You can increase or decrease its size depending on the amount
of data that you will be receiving. Increasing the value of the
InBufferSize setting can provide significant improvements in
performance in some cases.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the InBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| OutBufferSize:
The size in bytes of the outgoing queue of the socket.This is the size of an internal queue in the TCP/IP stack.
You can increase or decrease its size depending on the amount
of data that you will be sending. Increasing the value of the
OutBufferSize setting can provide significant improvements in
performance in some cases.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the OutBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Base Config Settings | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| BuildInfo: Information about the product's build.When queried, this setting will return a string containing information about the product's build. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| CodePage:
The system code page used for Unicode to Multibyte translations.The default code page is Unicode UTF-8 (65001).
The following is a list of valid code page identifiers:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
LicenseInfo:
Information about the current license.When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| MaskSensitive:
Whether sensitive data is masked in log messages.In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to True to mask sensitive data. The default is True.
This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ProcessIdleEvents: Whether the class uses its internal event loop to process events when the main thread is idle.If set to False, the class will not fire internal idle events. Set this to False to use the class in a background thread on Mac OS. By default, this setting is True. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| SelectWaitMillis: The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.If there are no events to process when do_events is called, the class will wait for the amount of time specified here before returning. The default value is 20. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| UseInternalSecurityAPI:
Tells the class whether or not to use the system security libraries or an internal implementation.
When set to False, the class will use the system security libraries by default to perform cryptographic functions where applicable.
Setting this setting to True tells the class to use the internal implementation instead of using the system security libraries. On Windows, this setting is set to False by default. On Linux/macOS, this setting is set to True by default. To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the OpenSSL Notes section. |
ICharge Errors
ICharge Errors
| 159 Invalid form variable index (out of range). | |
| 501 Data field invalid length. | |
| 502 Data field invalid format. | |
| 503 Data field out of range. | |
| 504 Luhn digit check failed. | |
| 505 Card date invalid. | |
| 506 Card expired. | |
| 507 Card type unknown. | |
| 510 No gateway specified. | |
| 511 Invalid data entered. | |
| 512 Truncated response. | |
| 513 Invalid response. | |
| 514 A Special Field is required for this transaction type. | |
| 535 Signature verification failed. | |
| 542 Error computing MD5 hash for Authorize.Net | |
| 593 Required properties are missing from request. |
CardValidator Errors
| 504 Luhn digit check failed. | |
| 505 Card date invalid. | |
| 506 Card expired. | |
| 703 Invalid CardNumber format (contains letters or unknown characters). | |
| 704 Could not determine the Credit Card type. | |
| 705 Error parsing track_data. Format cannot be determined. |
The class may also return one of the following error codes, which are inherited from other classes.
HTTP Errors
| 118 Firewall Error. Error description contains detailed message. | |
| 143 Busy executing current method. | |
| 151 HTTP protocol error. The error message has the server response. | |
| 152 No server specified in url | |
| 153 Specified url_scheme is invalid. | |
| 155 Range operation is not supported by server. | |
| 156 Invalid cookie index (out of range). | |
| 301 Interrupted. | |
| 302 Can't open attached_file. |
The class may also return one of the following error codes, which are inherited from other classes.
TCPClient Errors
| 100 You cannot change the remote_port at this time. A connection is in progress. | |
| 101 You cannot change the remote_host (Server) at this time. A connection is in progress. | |
| 102 The remote_host address is invalid (0.0.0.0). | |
| 104 Already connected. If you want to reconnect, close the current connection first. | |
| 106 You cannot change the local_port at this time. A connection is in progress. | |
| 107 You cannot change the local_host at this time. A connection is in progress. | |
| 112 You cannot change MaxLineLength at this time. A connection is in progress. | |
| 116 remote_port cannot be zero. Please specify a valid service port number. | |
| 117 You cannot change the UseConnection option while the class is active. | |
| 135 Operation would block. | |
| 201 Timeout. | |
| 211 Action impossible in control's present state. | |
| 212 Action impossible while not connected. | |
| 213 Action impossible while listening. | |
| 301 Timeout. | |
| 302 Could not open file. | |
| 434 Unable to convert string to selected CodePage. | |
| 1105 Already connecting. If you want to reconnect, close the current connection first. | |
| 1117 You need to connect first. | |
| 1119 You cannot change the LocalHost at this time. A connection is in progress. | |
| 1120 Connection dropped by remote host. |
SSL Errors
| 270 Cannot load specified security library. | |
| 271 Cannot open certificate store. | |
| 272 Cannot find specified certificate. | |
| 273 Cannot acquire security credentials. | |
| 274 Cannot find certificate chain. | |
| 275 Cannot verify certificate chain. | |
| 276 Error during handshake. | |
| 280 Error verifying certificate. | |
| 281 Could not find client certificate. | |
| 282 Could not find server certificate. | |
| 283 Error encrypting data. | |
| 284 Error decrypting data. |
TCP/IP Errors
| 10004 [10004] Interrupted system call. | |
| 10009 [10009] Bad file number. | |
| 10013 [10013] Access denied. | |
| 10014 [10014] Bad address. | |
| 10022 [10022] Invalid argument. | |
| 10024 [10024] Too many open files. | |
| 10035 [10035] Operation would block. | |
| 10036 [10036] Operation now in progress. | |
| 10037 [10037] Operation already in progress. | |
| 10038 [10038] Socket operation on non-socket. | |
| 10039 [10039] Destination address required. | |
| 10040 [10040] Message too long. | |
| 10041 [10041] Protocol wrong type for socket. | |
| 10042 [10042] Bad protocol option. | |
| 10043 [10043] Protocol not supported. | |
| 10044 [10044] Socket type not supported. | |
| 10045 [10045] Operation not supported on socket. | |
| 10046 [10046] Protocol family not supported. | |
| 10047 [10047] Address family not supported by protocol family. | |
| 10048 [10048] Address already in use. | |
| 10049 [10049] Can't assign requested address. | |
| 10050 [10050] Network is down. | |
| 10051 [10051] Network is unreachable. | |
| 10052 [10052] Net dropped connection or reset. | |
| 10053 [10053] Software caused connection abort. | |
| 10054 [10054] Connection reset by peer. | |
| 10055 [10055] No buffer space available. | |
| 10056 [10056] Socket is already connected. | |
| 10057 [10057] Socket is not connected. | |
| 10058 [10058] Can't send after socket shutdown. | |
| 10059 [10059] Too many references, can't splice. | |
| 10060 [10060] Connection timed out. | |
| 10061 [10061] Connection refused. | |
| 10062 [10062] Too many levels of symbolic links. | |
| 10063 [10063] File name too long. | |
| 10064 [10064] Host is down. | |
| 10065 [10065] No route to host. | |
| 10066 [10066] Directory not empty | |
| 10067 [10067] Too many processes. | |
| 10068 [10068] Too many users. | |
| 10069 [10069] Disc Quota Exceeded. | |
| 10070 [10070] Stale NFS file handle. | |
| 10071 [10071] Too many levels of remote in path. | |
| 10091 [10091] Network subsystem is unavailable. | |
| 10092 [10092] WINSOCK DLL Version out of range. | |
| 10093 [10093] Winsock not loaded yet. | |
| 11001 [11001] Host not found. | |
| 11002 [11002] Non-authoritative 'Host not found' (try again or check DNS setup). | |
| 11003 [11003] Non-recoverable errors: FORMERR, REFUSED, NOTIMP. | |
| 11004 [11004] Valid name, no data record (check DNS setup). |