RecurringBilling Class
Properties Methods Events Config Settings Errors
The RecurringBilling class is used to authorize and set up recurring transactions with any of the supported Internet Payment Gateways.
Syntax
RecurringBilling
Remarks
The RecurringBilling 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.
RecurringBilling Gateway Setup and Required Properties
The RecurringBilling class allows your website to securely perform and setup recurring transactions without the need to redirect to a separate website. 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 website or any stand-alone application can process transactions without the need for a secure server or third-party intervention.
Gateway Setup
The first thing you must do is select one of the many gateways supported by the RecurringBilling class, and set up an account with that gateway. Once you have an account set up with a valid (or test) login Id and password, you can use the RecurringBilling 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 GatewayURL at this time.
Next, set the MerchantLogin (and for some gateways the MerchantPassword). These are supplied by your gateway vendor when you set up an account.
Many gateways have different setup requirements. See RecurringBilling Gateway Setup and Required Properties for details about each gateway's requirements.
Now you are ready to process transactions. For each transaction, you must set either Card or Bank. Most gateways will also require additional properties, such as Address, FirstName, LastName, InvoiceNumber, etc.
Subscription Management
Once all required properties are set, you may create a recurring payment using the specified card or bank data by calling the CreateSubscription method. If the Gateway supports it, you may also Cancel recurring payments with the CancelSubscription method. Recurring payments that need to be changed may be updated with the UpdateSubscription method.
The following gateways are supported by the RecurringBilling 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 |
iTransact RediCharge HTML (4) | http://www.itransact.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/ |
Merchant Anywhere (Transaction Central) (15) | http://www.merchantanywhere.com/ |
SkipJack (16) | http://www.skipjack.com |
Chase Paymentech Orbital Gateway (23) | https://merchantservices.chase.com/ |
LinkPoint (24) | http://www.linkpoint.com |
Moneris eSelect Plus Canada (25) | http://www.moneris.com |
NetworkMerchants Direct-Post API (28) | http://www.nmi.com/ |
TransFirst Transaction Central Classic (formerly PRIGate) (30) | www.transfirst.com |
Merchant Partners (Transaction Engine) (31) | http://www.merchantpartners.com/ |
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/ |
Chase Merchant Services (Linkpoint) (41) | http://www.chase.com |
Thompson Merchant Services NexCommerce (iTransact mode) (42) | http://www.thompsonmerchant.com |
TransFirst Transaction Central (44) | http://www.transfirst.com. (This is different from TransFirst eLink, supported above. The TransactionCentral gateway is also used by MerchantAnywhere and PRIGate) |
Elavon/NOVA/My Virtual Merchant (49) | http://www.myvirtualmerchant.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 |
Intuit QuickBooks Merchant Services (QBMS) (61) | This gateway is no longer in service. |
Litle Online Gateway (63) | http://www.litle.com/ |
PayTrace Payment Gateway (70) | https://www.paytrace.net/ |
TransNational Bankcard (74) | http://www.tnbci.com/ |
Payscape (83) | http://www.payscape.com |
Authorize.NET CIM (85) | http://www.authorize.net |
WorldPay US Link Gateway (87) | https://www.worldpay.com/en-us/index |
3DSI Payment WorkSuite (88) | http://www.3dsi.com/ |
First Data PayPoint (90) | https://www.firstdata.com/en_us/customer-center/financial-institutions/paypoint.html |
Converge (formerly MyVirtualMerchant) (93) | https://support.convergepay.com/s/ |
PhoeniXGate Gateway (97) | http://www.phoenixmanagednetworks.com/ |
Repay Gateway (98) | https://www.repay.com/ |
PayWiser (98) | http://www.paywiser.si/ |
BlueSnap Gateway (104) | https://home.bluesnap.com/ |
BASYS Gateway (106) | https://basyspro.com/ |
Square (108) | https://www.squareup.com |
Nuvei / GlobalOnePay (110) | https://nuvei.com/en-us/ |
Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
Card | Contains the customer's credit card information. |
Customer | Contains the customer's name, address, and other identifying information. |
ECheckBank | Bank account and routing information for an electronic check transaction. |
ECheckPaymentType | The type of check payment request (commonly referred to as SEC Code). |
Gateway | Gateway to process transactions with. |
GatewayURL | Default URL for a specific Gateway . |
InvoiceNumber | Merchant-generated invoice number. |
MerchantLogin | Merchant's Gateway login. |
MerchantPassword | Merchant's Gateway password. |
PaymentSchedule | This property is used to specify the payment schedule for a recurring billing. |
Proxy | A set of properties related to proxy access. |
Response | Contains the response to the recurring transaction. |
ShippingInfo | Contains the customer's shipping name, address, and other identifying information. |
SpecialFields | A list of additional fields to send in the request. |
SSLAcceptServerCert | Instructs the class to unconditionally accept the server certificate that matches the supplied certificate. |
SSLCert | The certificate to be used during Secure Sockets Layer (SSL) negotiation. |
SSLProvider | The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use. |
SSLServerCert | The server certificate for the last established connection. |
SubscriptionDesc | Description of recurring subscription. |
SubscriptionDetails | Contains the recurring subscription details. |
SubscriptionName | The name of the recurring subscription or profile. |
TestMode | Turns test mode on and off for transactions sent to the current Gateway . |
Timeout | A timeout for the class. |
TransactionId | 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.
AddSpecialField | Adds a special field name and the corresponding value. |
CancelSubscription | Cancels or deletes a recurring payment subscription. |
Config | Sets or retrieves a configuration setting. |
CreateSubscription | Creates a new recurring subscription. |
DoEvents | This method processes events from the internal message queue. |
GetResponseVar | Parses additional information out of the response. |
GetSubscriptionStatus | Retrieves the status of a recurring payment subscription. |
Interrupt | Interrupts the current action. |
ResetSpecialFields | Resets all special fields to the default settings. |
UpdateSubscription | Updates a recurring payment subscription. |
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.
Error | Information about errors during data delivery. |
SSLServerAuthentication | Fired after the server presents its certificate to the client. |
SSLStatus | Fired when secure connection progress messages are available. |
Config Settings
The following is a list of config settings for the class with short descriptions. Click on the links for further details.
3DSECI | Electronic Commerce Indicator. |
AmountFormat | Used to set the input format for TransactionAmount. |
AuthNetCIMGuestProfile | Specifies whether a profile is a guest profile or a normal profile. |
AuthNetCIMMaskedCardNumber | The masked card number returned for the payment profile at the specified index. |
AuthNetCIMPaymentProfileCount | The number of Payment Profiles assigned to a customer profile within the Authorize.NET CIM gateway. |
AuthNetCIMPaymentProfileId | The Payment Profile ID assigned by Authorize.NET CIM gateway. |
AuthNetCIMPaymentProfileIndex | Parses the Payment Profile contained at the specified index within a GetSusbcriptionStatus response. |
AuthNetCIMRequestType | The request type to send for the Authorize.NET CIM gateway. |
AuthNetCIMShippingAddressCount | The number of Shipping Addresses assigned to a customer profile within the Authorize.NET CIM gateway. |
AuthNetCIMShippingAddressId | The Shipping Address ID assigned by Authorize.NET CIM gateway. |
AuthNetCIMShippingAddressIndex | Parses the Shipping Address contained at the specified index within a GetSusbcriptionStatus response. |
AuthNetGetSubscriptionDetails | Specifies whether a call to GetSubscriptionStatus will return the details of the subscription or just the status. |
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. |
BamboraUsername | The Username used for authentication with the Bambora gateway. |
BASYSCardInfoKey | BASYS Gateway Credit Card Info Key. |
BASYSCheckInfoKey | BASYS Gateway Check Info Key. |
BASYSContractID | BASYS Gateway Contract ID. |
BASYSContractKey | BASYS Gateway Contract Key. |
BASYSCustomerKey | BASYS Gateway Customer Key. |
BASYSCustomerStatus | Indicates the Customer Status. |
BASYSNextBillingDate | BASYS Gateway Next Billing Date. |
BASYSNumberOfDays | Number of days to be added to the next billing date. |
BASYSPaymentType | Indicates the Payment Type. |
BASYSRequestType | The request type for the BASYS gateway. |
BASYSToken | BASYS Gateway Token Value. |
BASYSTokenMode | Indicates the Token Type. |
BlueSnapCardCount | How many card payment sources the last retrieved vaulted shopper has. |
BlueSnapCardIndex | Determines which card payment source the class's fields are populated for currently. |
BlueSnapEnterpriseUdfs | User-Defined Fields (UDFs) to send when updating a BlueSnap vaulted shopper. |
BlueSnapGetToken | Retrieves a new hosted payment fields token (pfToken) from BlueSnap. |
BlueSnapRequestType | The request type for the BlueSnap gateway. |
BlueSnapVaultedShopperId | BlueSnap gateway vaulted shopper ID. |
CardIssueNumber | Special Issue Number used for Switch and Solo cards. |
CardLast4Digits | The last 4 digits of a credit card. |
CardPresent | Specifies whether the card is present during the transaction. |
CardStartMonth | Used for some international cards. |
CardStartYear | Used for some international cards. |
CardToken | The credit card token. |
CardType | Type of credit card being used in this transaction. |
CheckNumber | Check Number. |
CheckRoutingNumber | Determines whether to perform a checksum test on the RoutingNumber. |
COFPermission | Indicates if the customer gave permission to make a Card On File transaction. |
CompanyName | The Customer's Company Name. |
ConvenienceFee | The total convenience fee charged for a transaction. |
CustomerPassword | The Customer's Password. |
CustomerUsername | The Customer's Username. |
CyberSourceDeleteSubscription | Whether subscriptions should be deleted when CancelSubscription is called. |
CyberSourceXMLEscape | Determines whether to XML escape the CyberSource gateway request field values. |
DateFormat | The format of the date properties. |
EscapeXML | Automatically escape data within XML tags. |
EwayCustomerId | The Customer Id used to authenticate with the Eway gateway. |
EwayInitialDate | The date of the initial payment for the Eway gateway. |
EwayTransactionType | The Transaction Type for the Eway gateway. |
FirstDataPayPointAgreedToTerms | Specifies whether the customer has approved the registration process and agreed to the terms for the FirstDataPayPoint gateway. |
FirstDataPayPointTransactionType | The Transaction Type for the FirstDataPayPoint gateway. |
HashAlgorithm | Algorithm used for hashing. |
HashSecret | Security key used to generate a hash for gateways supporting such functionality. |
LicenseDOB | Customer's Date of Birth as indicated on his drivers license. |
LicenseNumber | Customer's driver's license number. |
LicenseState | State in which customer's driver's license was issued. |
LitleCardholderId | Describes the method used to identify the cardholder at the point of sale for the Litle gateway. |
LitleSubscriptionAggregate | Used to specify an XML aggregate for Subscription Create and Update transactions within the Litle gateway. |
LitleTransactionType | The Transaction Type for the Litle gateway. |
LitleTrialFrequency | Used to specify a trial frequency for the Litle gateway. |
MerchantCode | A gateway-supplied merchant number, code, or Id. |
MerchantPartnersLast4Digits | The last 4 digits of the account number for a transaction processed via the MerchantPartners or WorldPay Link gateways. |
MerchantPartnersReaderType | The reader type used to read and encrypt a swiped card for the MerchantPartners or WorldPay Link gateways. |
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. |
MITType | For the MIT framework - Indicates the type of transaction being requested in a Merchant-Initiated Transaction (MIT). |
MyVirtualMerchantUserId | The MyVirtualMerchant user Id as configured on VirtualMerchant. |
NetBillingVersion | The Version to be sent in the User-Agent heading of a NetBilling gateway request. |
NuveiPermittedTerminals | A list of the terminals permitted to use a Nuvei secure card. |
OmniFundTransactionType | The Transaction Type for the OmniFund 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. |
OrbitalCustomerProfileOrderOverrideInd | Indicator to specify how the CustomerId is leveraged to populate other data sets for the Orbital gateway. |
PayerIP | The IP address of the payer. |
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. |
PaymentWorkSuiteTransactionType | The transaction type to send for the Payment WorkSuite gateway. |
PayTraceIntegratorId | Used to specify the Integrator Id value assigned by the PayTrace gateway. |
PayTraceTransactionType | The Transaction Type for the PayTrace gateway. |
PayWiserCardToken | PayWiser Gateway Card Token Value. |
PayWiserPaymentHour | Payment hour. |
PayWiserPlanPattern | PayWiser plan pattern for creating a recurring plan. |
PayWiserRecurringPlanId | PayWiser Recurring Plan Id. |
PayWiserRequestType | The request type for the PayWiser gateway. |
PayWiserRetryPattern | PayWiser retry pattern for retrying failed payments. |
PayWiserTokenReferenceId | PayWiser Gateway Token Reference Id. |
PhoeniXGateCardInfoKey | PhoeniXGate Gateway Credit Card Info Key. |
PhoeniXGateCheckInfoKey | PhoeniXGate Gateway Check Info Key. |
PhoeniXGateContractID | PhoeniXGate Gateway Contract ID. |
PhoeniXGateContractKey | PhoeniXGate Gateway Contract Key. |
PhoeniXGateCustomerKey | PhoeniXGate Gateway Customer Key. |
PhoeniXGateCustomerStatus | Indicates the Customer Status. |
PhoeniXGateNextBillingDate | PhoeniXGate Gateway Next Billing Date. |
PhoeniXGateNumberOfDays | Number of days to be added to the next billing date. |
PhoeniXGatePaymentType | Indicates the Payment Type. |
PhoeniXGateRequestType | The request type for the PhoeniXGate gateway. |
PhoeniXGateToken | PhoeniXGate Gateway Token Value. |
PhoeniXGateTokenMode | Indicates the Token Type. |
PlanetPaymentFrequencyDate | The date of the month that a recurring payment should occur for the Planet Payment gateway. |
PlanetPaymentFrequencyDay | The day that a recurring payment should occur for the Planet Payment gateway. |
PlanetPaymentFrequencyMonth | The month that a recurring payment should occur for the Planet Payment gateway. |
QBMSTransactionType | The Transaction Type for the QBMS gateway. |
RawRequest | Returns the data that was sent to the gateway. |
RawResponse | Returns the data that was received from the gateway. |
RepayCardInfoKey | Repay Gateway Credit Card Info Key. |
RepayCheckInfoKey | Repay Gateway Check Info Key. |
RepayContractID | Repay Gateway Contract ID. |
RepayContractKey | Repay Gateway Contract Key. |
RepayCustomerKey | Repay Gateway Customer Key. |
RepayCustomerStatus | Indicates the Customer Status. |
RepayNextBillingDate | Repay Gateway Next Billing Date. |
RepayNumberOfDays | Number of days to be added to the next billing date. |
RepayPaymentType | Indicates the Payment Type. |
RepayRequestType | The request type for the Repay gateway. |
RepayToken | Repay Gateway Token Value. |
RepayTokenMode | Indicates the Token Type. |
SkipJackStatusIndex | Gets subscription details at the specified status index. |
SquareCustomerCardCount | The number of cards saved to the Square customer profile. |
SquareCustomerCardId | The Id of a card saved to a Square customer profile. |
SquareCustomerCardIndex | Which card's details to populate the class with from the retreived Square customer profile. |
SquareRequestType | What type of Square customer data to create or delete. |
StoreCardOnFile | For the Stored Credentials framework - Used to indicate that the merchant will be storing the customer's card on file (COF). |
TaxId | Company's Tax Id or a Customer's Social Security Number. |
TerminalCapability | The capability of the terminal that is used to submit the transaction. |
TerminalId | Terminal Id value sent in the transaction. |
TerminalType | The terminal type that is used to submit the transaction. |
UseCardOnFile | For the Stored Credentials framework - Used to indicate that the merchant is using stored card on file (COF) information for the request. |
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. |
StatusCode | The status code of the last response from the server. |
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. |
KeepAliveRetryCount | The number of keep-alive packets to be sent before the remotehost is considered disconnected. |
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 certificates to be included when performing an SSL handshake. |
SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
SSLClientCACerts | A newline separated list of CA certificates to use during SSL client certificate validation. |
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 cipher suite. |
SSLNegotiatedCipherStrength | Returns the negotiated cipher suite strength. |
SSLNegotiatedCipherSuite | Returns the negotiated cipher suite. |
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 certificates 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. |
MaskSensitiveData | 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 | Whether or not to use the system security libraries or an internal implementation. |
Card Property (RecurringBilling Class)
Contains the customer's credit card information.
Syntax
InPayCCCard* GetCard(); int SetCard(InPayCCCard* val);
int inpay_recurringbilling_getcardtype(void* lpObj);
int inpay_recurringbilling_setcardtype(void* lpObj, int iCardType);
char* inpay_recurringbilling_getcardcvvdata(void* lpObj);
int inpay_recurringbilling_setcardcvvdata(void* lpObj, const char* lpszCardCVVData);
int inpay_recurringbilling_getcardcvvpresence(void* lpObj);
int inpay_recurringbilling_setcardcvvpresence(void* lpObj, int iCardCVVPresence);
int inpay_recurringbilling_getcardentrydatasource(void* lpObj);
int inpay_recurringbilling_setcardentrydatasource(void* lpObj, int iCardEntryDataSource);
int inpay_recurringbilling_getcardexpmonth(void* lpObj);
int inpay_recurringbilling_setcardexpmonth(void* lpObj, int iCardExpMonth);
int inpay_recurringbilling_getcardexpyear(void* lpObj);
int inpay_recurringbilling_setcardexpyear(void* lpObj, int iCardExpYear);
int inpay_recurringbilling_getcardisencrypted(void* lpObj);
int inpay_recurringbilling_setcardisencrypted(void* lpObj, int bCardIsEncrypted);
char* inpay_recurringbilling_getcardmagneticstripe(void* lpObj);
int inpay_recurringbilling_setcardmagneticstripe(void* lpObj, const char* lpszCardMagneticStripe);
char* inpay_recurringbilling_getcardnumber(void* lpObj);
int inpay_recurringbilling_setcardnumber(void* lpObj, const char* lpszCardNumber);
int GetCardType();
int SetCardType(int iCardType); QString GetCardCVVData();
int SetCardCVVData(QString qsCardCVVData); int GetCardCVVPresence();
int SetCardCVVPresence(int iCardCVVPresence); int GetCardEntryDataSource();
int SetCardEntryDataSource(int iCardEntryDataSource); int GetCardExpMonth();
int SetCardExpMonth(int iCardExpMonth); int GetCardExpYear();
int SetCardExpYear(int iCardExpYear); bool GetCardIsEncrypted();
int SetCardIsEncrypted(bool bCardIsEncrypted); QString GetCardMagneticStripe();
int SetCardMagneticStripe(QString qsCardMagneticStripe); QString GetCardNumber();
int SetCardNumber(QString qsCardNumber);
Remarks
This must be set to an instance of the CCCard type, which will contain information about the credit card to be charged. This may include a MagneticStripe for swiped cards, or a Number, ExpMonth, and ExpYear for manually entered cards. (EntryDataSource indicates which set of properties will be used). See the CCCard type for more information.
This property is not available at design time.
Data Type
Customer Property (RecurringBilling Class)
Contains the customer's name, address, and other identifying information.
Syntax
InPayEPCustomer* GetCustomer(); int SetCustomer(InPayEPCustomer* val);
char* inpay_recurringbilling_getcustomeraddress(void* lpObj);
int inpay_recurringbilling_setcustomeraddress(void* lpObj, const char* lpszCustomerAddress);
char* inpay_recurringbilling_getcustomeraddress2(void* lpObj);
int inpay_recurringbilling_setcustomeraddress2(void* lpObj, const char* lpszCustomerAddress2);
char* inpay_recurringbilling_getcustomeraggregate(void* lpObj);
int inpay_recurringbilling_setcustomeraggregate(void* lpObj, const char* lpszCustomerAggregate);
char* inpay_recurringbilling_getcustomercity(void* lpObj);
int inpay_recurringbilling_setcustomercity(void* lpObj, const char* lpszCustomerCity);
char* inpay_recurringbilling_getcustomercountry(void* lpObj);
int inpay_recurringbilling_setcustomercountry(void* lpObj, const char* lpszCustomerCountry);
char* inpay_recurringbilling_getcustomeremail(void* lpObj);
int inpay_recurringbilling_setcustomeremail(void* lpObj, const char* lpszCustomerEmail);
char* inpay_recurringbilling_getcustomerfax(void* lpObj);
int inpay_recurringbilling_setcustomerfax(void* lpObj, const char* lpszCustomerFax);
char* inpay_recurringbilling_getcustomerfirstname(void* lpObj);
int inpay_recurringbilling_setcustomerfirstname(void* lpObj, const char* lpszCustomerFirstName);
char* inpay_recurringbilling_getcustomerfullname(void* lpObj);
int inpay_recurringbilling_setcustomerfullname(void* lpObj, const char* lpszCustomerFullName);
char* inpay_recurringbilling_getcustomerid(void* lpObj);
int inpay_recurringbilling_setcustomerid(void* lpObj, const char* lpszCustomerId);
char* inpay_recurringbilling_getcustomerlastname(void* lpObj);
int inpay_recurringbilling_setcustomerlastname(void* lpObj, const char* lpszCustomerLastName);
char* inpay_recurringbilling_getcustomerphone(void* lpObj);
int inpay_recurringbilling_setcustomerphone(void* lpObj, const char* lpszCustomerPhone);
char* inpay_recurringbilling_getcustomerstate(void* lpObj);
int inpay_recurringbilling_setcustomerstate(void* lpObj, const char* lpszCustomerState);
char* inpay_recurringbilling_getcustomerzip(void* lpObj);
int inpay_recurringbilling_setcustomerzip(void* lpObj, const char* lpszCustomerZip);
QString GetCustomerAddress();
int SetCustomerAddress(QString qsCustomerAddress); QString GetCustomerAddress2();
int SetCustomerAddress2(QString qsCustomerAddress2); QString GetCustomerAggregate();
int SetCustomerAggregate(QString qsCustomerAggregate); QString GetCustomerCity();
int SetCustomerCity(QString qsCustomerCity); QString GetCustomerCountry();
int SetCustomerCountry(QString qsCustomerCountry); QString GetCustomerEmail();
int SetCustomerEmail(QString qsCustomerEmail); QString GetCustomerFax();
int SetCustomerFax(QString qsCustomerFax); QString GetCustomerFirstName();
int SetCustomerFirstName(QString qsCustomerFirstName); QString GetCustomerFullName();
int SetCustomerFullName(QString qsCustomerFullName); QString GetCustomerId();
int SetCustomerId(QString qsCustomerId); QString GetCustomerLastName();
int SetCustomerLastName(QString qsCustomerLastName); QString GetCustomerPhone();
int SetCustomerPhone(QString qsCustomerPhone); QString GetCustomerState();
int SetCustomerState(QString qsCustomerState); QString GetCustomerZip();
int SetCustomerZip(QString qsCustomerZip);
Remarks
This property must be set to an instance of the EPCustomer type, which will contain information that identifies the customer. This information will be used by the Gateway for fraud checking purposes. See the EPCustomer type for more information.
All gateways require at the minimum the FirstName, LastName, FullName (the customer's name as it appears on the card), Address, City, State, and Zip. The following table shows which gateways require which additional Customer properties:
Gateway | Country | Id | Phone | |
gwGoRealTime (4) | X | |||
gwITransact (8) | X | X | X | |
gwSkipjack (22) | X | X | ||
gwECHOnline (23) | X | |||
gwPayFlowLink (28) | X | X | X | |
gwCyberCash (41) | X | X | X | |
gwCyberSource (46) | X | |||
gwGoEMerchant (48) | X | |||
gwNexCommerce (53) | X | X | X | |
gwWorldPay (54) | X | |||
gwPayGea (56) | X | X |
This property is not available at design time.
Data Type
ECheckBank Property (RecurringBilling Class)
Bank account and routing information for an electronic check transaction.
Syntax
InPayEPBank* GetECheckBank(); int SetECheckBank(InPayEPBank* val);
int inpay_recurringbilling_getbankaccountclass(void* lpObj);
int inpay_recurringbilling_setbankaccountclass(void* lpObj, int iBankAccountClass);
char* inpay_recurringbilling_getbankaccountholdername(void* lpObj);
int inpay_recurringbilling_setbankaccountholdername(void* lpObj, const char* lpszBankAccountHolderName);
char* inpay_recurringbilling_getbankaccountnumber(void* lpObj);
int inpay_recurringbilling_setbankaccountnumber(void* lpObj, const char* lpszBankAccountNumber);
int inpay_recurringbilling_getbankaccounttype(void* lpObj);
int inpay_recurringbilling_setbankaccounttype(void* lpObj, int iBankAccountType);
char* inpay_recurringbilling_getbankname(void* lpObj);
int inpay_recurringbilling_setbankname(void* lpObj, const char* lpszBankName);
char* inpay_recurringbilling_getbankroutingnumber(void* lpObj);
int inpay_recurringbilling_setbankroutingnumber(void* lpObj, const char* lpszBankRoutingNumber);
int GetBankAccountClass();
int SetBankAccountClass(int iBankAccountClass); QString GetBankAccountHolderName();
int SetBankAccountHolderName(QString qsBankAccountHolderName); QString GetBankAccountNumber();
int SetBankAccountNumber(QString qsBankAccountNumber); int GetBankAccountType();
int SetBankAccountType(int iBankAccountType); QString GetBankName();
int SetBankName(QString qsBankName); QString GetBankRoutingNumber();
int SetBankRoutingNumber(QString qsBankRoutingNumber);
Remarks
This property must be set to an instance of the EPBank type, which will contain the customer's bank account and routing information. This information is either copied off of a physical check or entered online. See the EPBank type for more information.
All Gateways require the AccountNumber and RoutingNumber, but many of the other properties may not be available for each gateway. The following table indicates which gateways support which fields:
Gateway | AccountHolderName | AccountType | AccountClass | Name |
gwAuthorizeNet (1) | X | X | X | |
gwITransact (4) | X | X | ||
gwUSAePay (7) | X | X | ||
gwPlugNPay (8) | X | X | X | |
gwPlanetPayment (9) | X | X | ||
gwMerchantAnywhere (15) | X | X | ||
gwOrbital (23) | X | X | ||
gwPRIGate (30) | X | X | ||
gwMerchantPartners (31) | X | |||
gwACHPayments (35) | X | |||
gwForte (36) | X | |||
gwCyberSource (37) | X | X | X | |
gwNexCommerce (42) | X | X | ||
gwTransactionCentral (44) | X | X | ||
gwQBMS (61) | X | |||
gwPayTrace (70) | X | |||
gwOmniFund (73) | X | X | ||
gwAuthorizeNetCIM (85) | X | X | X | |
gwWorldPayLink (87) | X | |||
gwFirstDataPayPoint (90) | X | X | X |
This property is not available at design time.
Data Type
ECheckPaymentType Property (RecurringBilling Class)
The type of check payment request (commonly referred to as SEC Code).
Syntax
ANSI (Cross Platform) int GetECheckPaymentType();
int SetECheckPaymentType(int iECheckPaymentType); Unicode (Windows) INT GetECheckPaymentType();
INT SetECheckPaymentType(INT iECheckPaymentType);
Possible Values
PT_WEB(0),
PT_PPD(1),
PT_TEL(2),
PT_CCD(3),
PT_ARC(4),
PT_BOC(5),
PT_POP(6),
PT_RCK(7)
int inpay_recurringbilling_getecheckpaymenttype(void* lpObj);
int inpay_recurringbilling_setecheckpaymenttype(void* lpObj, int iECheckPaymentType);
int GetECheckPaymentType();
int SetECheckPaymentType(int iECheckPaymentType);
Default Value
0
Remarks
This property is used to specify the payment type of the check transaction.
Available values:
Value | Definition |
ptWEB (0) | Internet Initiated Entry. Transaction was received from consumer via the Internet (ie shopping cart). Web transactions require a drop-down 'I agree' or a standard form of acknowledgment initiated by the customer. |
ptPPD (1) | Prearranged Payment or Deposit. Credits or Debits that have been pre-arranged by consumers to draft from their personal bank account. Typically used for recurring payments. Signed Authorization by Customer required, or contract language along with voided check. |
ptTEL (2) | Telephone Initiated Entry. Transaction information was received via the telephone. Transactions Authorization script must be recorded at the time the transaction is processed, or written acknowledgment sent to the customer. |
ptCCD (3) | Cash Concentration or Disbursement. Used for the transfer of funds between entities. Signed Authorization by Customer required. |
ptARC (4) | Accounts Receivable Conversion. Used for payments being made against a bill such as a utility. Signed Authorization by Customer required. |
ptBOC (5) | Back Office Conversion. Paper checks that are collected in a retail environment and then scanned and batched electronically. Customer notification 'Checks are Electronically Processed' required at Point of Sale. |
ptPOP (6) | Point-of-Purchase. Paper checks that are converted (scanned) into electronic format at the point of sale. The original paper check is voided and returned to the customer. Point of Sale is authorization. |
ptRCK (7) | Re-Presentation Check. After a check has been return for insufficient funds it may be attempted again using this format. RCK may only be retried once. Customer notification 'Returned Checks are Electronically Re-Processed' required at Point of Sale. |
Data Type
Integer
Gateway Property (RecurringBilling Class)
Gateway to process transactions with.
Syntax
ANSI (Cross Platform) int GetGateway();
int SetGateway(int iGateway); Unicode (Windows) INT GetGateway();
INT SetGateway(INT iGateway);
Possible Values
RBGW_NO_GATEWAY(0),
RBGW_AUTHORIZE_NET(1),
RBGW_EPROCESSING(2),
RBGW_ITRANSACT(4),
RBGW_PAY_FLOW_PRO(6),
RBGW_USAE_PAY(7),
RBGW_PLUG_NPAY(8),
RBGW_PLANET_PAYMENT(9),
RBGW_MERCHANT_ANYWHERE(15),
RBGW_SKIPJACK(16),
RBGW_ORBITAL(23),
RBGW_LINK_POINT(24),
RBGW_MONERIS(25),
RBGW_NETWORK_MERCHANTS(28),
RBGW_PRIGATE(30),
RBGW_MERCHANT_PARTNERS(31),
RBGW_FIRST_DATA(33),
RBGW_YOUR_PAY(34),
RBGW_ACHPAYMENTS(35),
RBGW_FORTE(36),
RBGW_CYBER_SOURCE(37),
RBGW_EWAY(38),
RBGW_CHASE(41),
RBGW_NEX_COMMERCE(42),
RBGW_TRANSACTION_CENTRAL(44),
RBGW_MY_VIRTUAL_MERCHANT(49),
RBGW_MONERIS_USA(52),
RBGW_BAMBORA(53),
RBGW_VERIFI(54),
RBGW_QBMS(61),
RBGW_LITLE(63),
RBGW_PAY_TRACE(70),
RBGW_OMNI_FUND(73),
RBGW_TRANS_NATIONAL_BANKCARD(74),
RBGW_PAYSCAPE(83),
RBGW_AUTHORIZE_NET_CIM(85),
RBGW_WORLD_PAY_LINK(87),
RBGW_PAYMENT_WORK_SUITE(88),
RBGW_FIRST_DATA_PAY_POINT(90),
RBGW_CONVERGE(93),
RBGW_AUTHORIZE_NET_XML(96),
RBGW_PHOENI_XGATE(97),
RBGW_REPAY(98),
RBGW_PAY_WISER(100),
RBGW_BLUE_SNAP(104),
RBGW_BASYS(106),
RBGW_SQUARE(108),
RBGW_NUVEI(110)
int inpay_recurringbilling_getgateway(void* lpObj);
int inpay_recurringbilling_setgateway(void* lpObj, int iGateway);
int GetGateway();
int SetGateway(int iGateway);
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 GatewayURL, Name, and Value properties with default data for the selected gateway. 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 |
iTransact RediCharge HTML (4) | http://www.itransact.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/ |
Merchant Anywhere (Transaction Central) (15) | http://www.merchantanywhere.com/ |
SkipJack (16) | http://www.skipjack.com |
Chase Paymentech Orbital Gateway (23) | https://merchantservices.chase.com/ |
LinkPoint (24) | http://www.linkpoint.com |
Moneris eSelect Plus Canada (25) | http://www.moneris.com |
NetworkMerchants Direct-Post API (28) | http://www.nmi.com/ |
TransFirst Transaction Central Classic (formerly PRIGate) (30) | www.transfirst.com |
Merchant Partners (Transaction Engine) (31) | http://www.merchantpartners.com/ |
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/ |
Chase Merchant Services (Linkpoint) (41) | http://www.chase.com |
Thompson Merchant Services NexCommerce (iTransact mode) (42) | http://www.thompsonmerchant.com |
TransFirst Transaction Central (44) | http://www.transfirst.com. (This is different from TransFirst eLink, supported above. The TransactionCentral gateway is also used by MerchantAnywhere and PRIGate) |
Elavon/NOVA/My Virtual Merchant (49) | http://www.myvirtualmerchant.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 |
Intuit QuickBooks Merchant Services (QBMS) (61) | This gateway is no longer in service. |
Litle Online Gateway (63) | http://www.litle.com/ |
PayTrace Payment Gateway (70) | https://www.paytrace.net/ |
TransNational Bankcard (74) | http://www.tnbci.com/ |
Payscape (83) | http://www.payscape.com |
Authorize.NET CIM (85) | http://www.authorize.net |
WorldPay US Link Gateway (87) | https://www.worldpay.com/en-us/index |
3DSI Payment WorkSuite (88) | http://www.3dsi.com/ |
First Data PayPoint (90) | https://www.firstdata.com/en_us/customer-center/financial-institutions/paypoint.html |
Converge (formerly MyVirtualMerchant) (93) | https://support.convergepay.com/s/ |
PhoeniXGate Gateway (97) | http://www.phoenixmanagednetworks.com/ |
Repay Gateway (98) | https://www.repay.com/ |
PayWiser (98) | http://www.paywiser.si/ |
BlueSnap Gateway (104) | https://home.bluesnap.com/ |
BASYS Gateway (106) | https://basyspro.com/ |
Square (108) | https://www.squareup.com |
Nuvei / GlobalOnePay (110) | https://nuvei.com/en-us/ |
Data Type
Integer
GatewayURL Property (RecurringBilling Class)
Default URL for a specific Gateway .
Syntax
ANSI (Cross Platform) char* GetGatewayURL();
int SetGatewayURL(const char* lpszGatewayURL); Unicode (Windows) LPWSTR GetGatewayURL();
INT SetGatewayURL(LPCWSTR lpszGatewayURL);
char* inpay_recurringbilling_getgatewayurl(void* lpObj);
int inpay_recurringbilling_setgatewayurl(void* lpObj, const char* lpszGatewayURL);
QString GetGatewayURL();
int SetGatewayURL(QString qsGatewayURL);
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.
Data Type
String
InvoiceNumber Property (RecurringBilling Class)
Merchant-generated invoice number.
Syntax
ANSI (Cross Platform) char* GetInvoiceNumber();
int SetInvoiceNumber(const char* lpszInvoiceNumber); Unicode (Windows) LPWSTR GetInvoiceNumber();
INT SetInvoiceNumber(LPCWSTR lpszInvoiceNumber);
char* inpay_recurringbilling_getinvoicenumber(void* lpObj);
int inpay_recurringbilling_setinvoicenumber(void* lpObj, const char* lpszInvoiceNumber);
QString GetInvoiceNumber();
int SetInvoiceNumber(QString qsInvoiceNumber);
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.
Data Type
String
MerchantLogin Property (RecurringBilling Class)
Merchant's Gateway login.
Syntax
ANSI (Cross Platform) char* GetMerchantLogin();
int SetMerchantLogin(const char* lpszMerchantLogin); Unicode (Windows) LPWSTR GetMerchantLogin();
INT SetMerchantLogin(LPCWSTR lpszMerchantLogin);
char* inpay_recurringbilling_getmerchantlogin(void* lpObj);
int inpay_recurringbilling_setmerchantlogin(void* lpObj, const char* lpszMerchantLogin);
QString GetMerchantLogin();
int SetMerchantLogin(QString qsMerchantLogin);
Default Value
""
Remarks
This is the login Id supplied by the Gateway you signed up with to process credit card transactions.
Data Type
String
MerchantPassword Property (RecurringBilling Class)
Merchant's Gateway password.
Syntax
ANSI (Cross Platform) char* GetMerchantPassword();
int SetMerchantPassword(const char* lpszMerchantPassword); Unicode (Windows) LPWSTR GetMerchantPassword();
INT SetMerchantPassword(LPCWSTR lpszMerchantPassword);
char* inpay_recurringbilling_getmerchantpassword(void* lpObj);
int inpay_recurringbilling_setmerchantpassword(void* lpObj, const char* lpszMerchantPassword);
QString GetMerchantPassword();
int SetMerchantPassword(QString qsMerchantPassword);
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.
Data Type
String
PaymentSchedule Property (RecurringBilling Class)
This property is used to specify the payment schedule for a recurring billing.
Syntax
InPayEPPaymentSchedule* GetPaymentSchedule(); int SetPaymentSchedule(InPayEPPaymentSchedule* val);
char* inpay_recurringbilling_getpaymentscheduleenddate(void* lpObj);
int inpay_recurringbilling_setpaymentscheduleenddate(void* lpObj, const char* lpszPaymentScheduleEndDate);
char* inpay_recurringbilling_getpaymentschedulefrequency(void* lpObj);
int inpay_recurringbilling_setpaymentschedulefrequency(void* lpObj, const char* lpszPaymentScheduleFrequency);
char* inpay_recurringbilling_getpaymentschedulefrequencyunit(void* lpObj);
int inpay_recurringbilling_setpaymentschedulefrequencyunit(void* lpObj, const char* lpszPaymentScheduleFrequencyUnit);
char* inpay_recurringbilling_getpaymentscheduleinitialamount(void* lpObj);
int inpay_recurringbilling_setpaymentscheduleinitialamount(void* lpObj, const char* lpszPaymentScheduleInitialAmount);
char* inpay_recurringbilling_getpaymentschedulerecuramount(void* lpObj);
int inpay_recurringbilling_setpaymentschedulerecuramount(void* lpObj, const char* lpszPaymentScheduleRecurAmount);
char* inpay_recurringbilling_getpaymentschedulestartdate(void* lpObj);
int inpay_recurringbilling_setpaymentschedulestartdate(void* lpObj, const char* lpszPaymentScheduleStartDate);
int inpay_recurringbilling_getpaymentscheduletotalpayments(void* lpObj);
int inpay_recurringbilling_setpaymentscheduletotalpayments(void* lpObj, int iPaymentScheduleTotalPayments);
int inpay_recurringbilling_getpaymentscheduletrialpayments(void* lpObj);
int inpay_recurringbilling_setpaymentscheduletrialpayments(void* lpObj, int iPaymentScheduleTrialPayments);
QString GetPaymentScheduleEndDate();
int SetPaymentScheduleEndDate(QString qsPaymentScheduleEndDate); QString GetPaymentScheduleFrequency();
int SetPaymentScheduleFrequency(QString qsPaymentScheduleFrequency); QString GetPaymentScheduleFrequencyUnit();
int SetPaymentScheduleFrequencyUnit(QString qsPaymentScheduleFrequencyUnit); QString GetPaymentScheduleInitialAmount();
int SetPaymentScheduleInitialAmount(QString qsPaymentScheduleInitialAmount); QString GetPaymentScheduleRecurAmount();
int SetPaymentScheduleRecurAmount(QString qsPaymentScheduleRecurAmount); QString GetPaymentScheduleStartDate();
int SetPaymentScheduleStartDate(QString qsPaymentScheduleStartDate); int GetPaymentScheduleTotalPayments();
int SetPaymentScheduleTotalPayments(int iPaymentScheduleTotalPayments); int GetPaymentScheduleTrialPayments();
int SetPaymentScheduleTrialPayments(int iPaymentScheduleTrialPayments);
Remarks
This property must be set to an instance of the EPPaymentSchedule type, which will contain information that specifies the payment schedule for the recurring billing transaction. See the EPPaymentSchedule type for more information.
The EPPaymentSchedule type contains the following fields:
EndDate | The date in which the recurring payments will stop processing. |
FrequencyUnit | The unit to be used in the frequency of the payments. |
Frequency | The frequency in which the payments will be processed. |
InitialAmount | The initial amount to be charged (such as a trial period or setup fee). |
RecurAmount | The amount to be charged on a recurring basis. |
StartDate | The date in which the recurring payments will start processing. |
TotalPayments | The total number of payments. |
TrialPayments | The total number of trial payments. |
This property is not available at design time.
Data Type
Proxy Property (RecurringBilling Class)
A set of properties related to proxy access.
Syntax
InPayProxy* GetProxy(); int SetProxy(InPayProxy* val);
int inpay_recurringbilling_getproxyauthscheme(void* lpObj);
int inpay_recurringbilling_setproxyauthscheme(void* lpObj, int iProxyAuthScheme);
int inpay_recurringbilling_getproxyautodetect(void* lpObj);
int inpay_recurringbilling_setproxyautodetect(void* lpObj, int bProxyAutoDetect);
char* inpay_recurringbilling_getproxypassword(void* lpObj);
int inpay_recurringbilling_setproxypassword(void* lpObj, const char* lpszProxyPassword);
int inpay_recurringbilling_getproxyport(void* lpObj);
int inpay_recurringbilling_setproxyport(void* lpObj, int iProxyPort);
char* inpay_recurringbilling_getproxyserver(void* lpObj);
int inpay_recurringbilling_setproxyserver(void* lpObj, const char* lpszProxyServer);
int inpay_recurringbilling_getproxyssl(void* lpObj);
int inpay_recurringbilling_setproxyssl(void* lpObj, int iProxySSL);
char* inpay_recurringbilling_getproxyuser(void* lpObj);
int inpay_recurringbilling_setproxyuser(void* lpObj, const char* lpszProxyUser);
int GetProxyAuthScheme();
int SetProxyAuthScheme(int iProxyAuthScheme); bool GetProxyAutoDetect();
int SetProxyAutoDetect(bool bProxyAutoDetect); QString GetProxyPassword();
int SetProxyPassword(QString qsProxyPassword); int GetProxyPort();
int SetProxyPort(int iProxyPort); QString GetProxyServer();
int SetProxyServer(QString qsProxyServer); int GetProxySSL();
int SetProxySSL(int iProxySSL); QString GetProxyUser();
int SetProxyUser(QString qsProxyUser);
Remarks
This property contains fields describing the proxy through which the class will attempt to connect.
Data Type
Response Property (RecurringBilling Class)
Contains the response to the recurring transaction.
Syntax
InPayEPRecurringResponse* GetResponse();
char* inpay_recurringbilling_getresponseapprovalcode(void* lpObj);
int inpay_recurringbilling_getresponseapproved(void* lpObj);
char* inpay_recurringbilling_getresponseavsresult(void* lpObj);
char* inpay_recurringbilling_getresponsecode(void* lpObj);
char* inpay_recurringbilling_getresponsecvvresult(void* lpObj);
char* inpay_recurringbilling_getresponsedata(void* lpObj);
char* inpay_recurringbilling_getresponseerrorcode(void* lpObj);
char* inpay_recurringbilling_getresponseerrortext(void* lpObj);
char* inpay_recurringbilling_getresponseinvoicenumber(void* lpObj);
char* inpay_recurringbilling_getresponseprocessorcode(void* lpObj);
char* inpay_recurringbilling_getresponsesubscriptionid(void* lpObj);
char* inpay_recurringbilling_getresponsetext(void* lpObj);
char* inpay_recurringbilling_getresponsetransactionid(void* lpObj);
QString GetResponseApprovalCode(); bool GetResponseApproved(); QString GetResponseAVSResult(); QString GetResponseCode(); QString GetResponseCVVResult(); QString GetResponseData(); QString GetResponseErrorCode(); QString GetResponseErrorText(); QString GetResponseInvoiceNumber(); QString GetResponseProcessorCode(); QString GetResponseSubscriptionId(); QString GetResponseText(); QString GetResponseTransactionId();
Remarks
This property will contain the response returned from the Gateway server. It should be inspected (and logged) after a call to CreateSubscription, UpdateSubscription, or CancelSubscription. The EPRecurringResponse type contains the following fields:
ApprovalCode | Contains an authorization code for an approved transaction. |
Approved | Indicates whether the transaction was successful (True) or unsuccessful (False). |
AVSResult | Contains the Address Verification System result code. Used for fraud detection. |
Code | Indicates the success or failure of the transaction. |
CVVResult | Contains the returned CVV result code if it was requested. Used for fraud detection. |
Data | Contains the raw response from the host. |
ErrorCode | Additional code returned for declined or failed transactions. |
ErrorText | Description of the error which occurred. |
InvoiceNumber | Merchant-generated invoice number echoed back in the response. |
ProcessorCode | Return code generated by the processor, or additional gateway response code that may contain more information beyond "Approved" or "Declined". |
Text | Contains a human-readable message explaining the code. |
TransactionId | Host-generated transaction identifier, used for Captures, Credits, or Voids. |
SubscriptionId | Contains the Subscription or Profile Identifier for the recurring payment. |
Note that many gateways do not return values in all of these fields. Any field in the Data which has not been parsed into these Response fields may be retrieved with the GetResponseVar method.
This property is read-only and not available at design time.
Data Type
ShippingInfo Property (RecurringBilling Class)
Contains the customer's shipping name, address, and other identifying information.
Syntax
InPayEPShipInfo* GetShippingInfo(); int SetShippingInfo(InPayEPShipInfo* val);
char* inpay_recurringbilling_getshippingaddress(void* lpObj);
int inpay_recurringbilling_setshippingaddress(void* lpObj, const char* lpszShippingAddress);
char* inpay_recurringbilling_getshippingaddress2(void* lpObj);
int inpay_recurringbilling_setshippingaddress2(void* lpObj, const char* lpszShippingAddress2);
char* inpay_recurringbilling_getshippingcity(void* lpObj);
int inpay_recurringbilling_setshippingcity(void* lpObj, const char* lpszShippingCity);
char* inpay_recurringbilling_getshippingcountry(void* lpObj);
int inpay_recurringbilling_setshippingcountry(void* lpObj, const char* lpszShippingCountry);
char* inpay_recurringbilling_getshippingemail(void* lpObj);
int inpay_recurringbilling_setshippingemail(void* lpObj, const char* lpszShippingEmail);
char* inpay_recurringbilling_getshippingfirstname(void* lpObj);
int inpay_recurringbilling_setshippingfirstname(void* lpObj, const char* lpszShippingFirstName);
char* inpay_recurringbilling_getshippinglastname(void* lpObj);
int inpay_recurringbilling_setshippinglastname(void* lpObj, const char* lpszShippingLastName);
char* inpay_recurringbilling_getshippingphone(void* lpObj);
int inpay_recurringbilling_setshippingphone(void* lpObj, const char* lpszShippingPhone);
char* inpay_recurringbilling_getshippingstate(void* lpObj);
int inpay_recurringbilling_setshippingstate(void* lpObj, const char* lpszShippingState);
char* inpay_recurringbilling_getshippingzip(void* lpObj);
int inpay_recurringbilling_setshippingzip(void* lpObj, const char* lpszShippingZip);
QString GetShippingAddress();
int SetShippingAddress(QString qsShippingAddress); QString GetShippingAddress2();
int SetShippingAddress2(QString qsShippingAddress2); QString GetShippingCity();
int SetShippingCity(QString qsShippingCity); QString GetShippingCountry();
int SetShippingCountry(QString qsShippingCountry); QString GetShippingEmail();
int SetShippingEmail(QString qsShippingEmail); QString GetShippingFirstName();
int SetShippingFirstName(QString qsShippingFirstName); QString GetShippingLastName();
int SetShippingLastName(QString qsShippingLastName); QString GetShippingPhone();
int SetShippingPhone(QString qsShippingPhone); QString GetShippingState();
int SetShippingState(QString qsShippingState); QString GetShippingZip();
int SetShippingZip(QString qsShippingZip);
Remarks
This property must be set to an instance of the EPShipInfo type, which will contain information that specifies the shipping information for the order. See the EPShipInfo type for more information.
This property is not available at design time.
Data Type
SpecialFields Property (RecurringBilling Class)
A list of additional fields to send in the request.
Syntax
InPayList<InPayEPSpecialField>* GetSpecialFields(); int SetSpecialFields(InPayList<InPayEPSpecialField>* val);
int inpay_recurringbilling_getspecialfieldcount(void* lpObj);
int inpay_recurringbilling_setspecialfieldcount(void* lpObj, int iSpecialFieldCount);
char* inpay_recurringbilling_getspecialfieldname(void* lpObj, int fieldindex);
int inpay_recurringbilling_setspecialfieldname(void* lpObj, int fieldindex, const char* lpszSpecialFieldName);
char* inpay_recurringbilling_getspecialfieldvalue(void* lpObj, int fieldindex);
int inpay_recurringbilling_setspecialfieldvalue(void* lpObj, int fieldindex, const char* lpszSpecialFieldValue);
int GetSpecialFieldCount();
int SetSpecialFieldCount(int iSpecialFieldCount); QString GetSpecialFieldName(int iFieldIndex);
int SetSpecialFieldName(int iFieldIndex, QString qsSpecialFieldName); QString GetSpecialFieldValue(int iFieldIndex);
int SetSpecialFieldValue(int iFieldIndex, QString qsSpecialFieldValue);
Remarks
This property contains a properties of EPSpecialField name/value pair objects. The Gateway may put some special configuration fields into this property which you can edit or add to. This allows you to extend the functionality of the class by adding fields for which there are not currently properties for.
This property is not available at design time.
Data Type
SSLAcceptServerCert Property (RecurringBilling Class)
Instructs the class to unconditionally accept the server certificate that matches the supplied certificate.
Syntax
InPayCertificate* GetSSLAcceptServerCert(); int SetSSLAcceptServerCert(InPayCertificate* val);
char* inpay_recurringbilling_getsslacceptservercerteffectivedate(void* lpObj);
char* inpay_recurringbilling_getsslacceptservercertexpirationdate(void* lpObj);
char* inpay_recurringbilling_getsslacceptservercertextendedkeyusage(void* lpObj);
char* inpay_recurringbilling_getsslacceptservercertfingerprint(void* lpObj);
char* inpay_recurringbilling_getsslacceptservercertfingerprintsha1(void* lpObj);
char* inpay_recurringbilling_getsslacceptservercertfingerprintsha256(void* lpObj);
char* inpay_recurringbilling_getsslacceptservercertissuer(void* lpObj);
char* inpay_recurringbilling_getsslacceptservercertprivatekey(void* lpObj);
int inpay_recurringbilling_getsslacceptservercertprivatekeyavailable(void* lpObj);
char* inpay_recurringbilling_getsslacceptservercertprivatekeycontainer(void* lpObj);
char* inpay_recurringbilling_getsslacceptservercertpublickey(void* lpObj);
char* inpay_recurringbilling_getsslacceptservercertpublickeyalgorithm(void* lpObj);
int inpay_recurringbilling_getsslacceptservercertpublickeylength(void* lpObj);
char* inpay_recurringbilling_getsslacceptservercertserialnumber(void* lpObj);
char* inpay_recurringbilling_getsslacceptservercertsignaturealgorithm(void* lpObj);
int inpay_recurringbilling_getsslacceptservercertstore(void* lpObj, char** lpSSLAcceptServerCertStore, int* lenSSLAcceptServerCertStore);
int inpay_recurringbilling_setsslacceptservercertstore(void* lpObj, const char* lpSSLAcceptServerCertStore, int lenSSLAcceptServerCertStore);
char* inpay_recurringbilling_getsslacceptservercertstorepassword(void* lpObj);
int inpay_recurringbilling_setsslacceptservercertstorepassword(void* lpObj, const char* lpszSSLAcceptServerCertStorePassword);
int inpay_recurringbilling_getsslacceptservercertstoretype(void* lpObj);
int inpay_recurringbilling_setsslacceptservercertstoretype(void* lpObj, int iSSLAcceptServerCertStoreType);
char* inpay_recurringbilling_getsslacceptservercertsubjectaltnames(void* lpObj);
char* inpay_recurringbilling_getsslacceptservercertthumbprintmd5(void* lpObj);
char* inpay_recurringbilling_getsslacceptservercertthumbprintsha1(void* lpObj);
char* inpay_recurringbilling_getsslacceptservercertthumbprintsha256(void* lpObj);
char* inpay_recurringbilling_getsslacceptservercertusage(void* lpObj);
int inpay_recurringbilling_getsslacceptservercertusageflags(void* lpObj);
char* inpay_recurringbilling_getsslacceptservercertversion(void* lpObj);
char* inpay_recurringbilling_getsslacceptservercertsubject(void* lpObj);
int inpay_recurringbilling_setsslacceptservercertsubject(void* lpObj, const char* lpszSSLAcceptServerCertSubject);
int inpay_recurringbilling_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int inpay_recurringbilling_setsslacceptservercertencoded(void* lpObj, const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);
QString GetSSLAcceptServerCertEffectiveDate(); QString GetSSLAcceptServerCertExpirationDate(); QString GetSSLAcceptServerCertExtendedKeyUsage(); QString GetSSLAcceptServerCertFingerprint(); QString GetSSLAcceptServerCertFingerprintSHA1(); QString GetSSLAcceptServerCertFingerprintSHA256(); QString GetSSLAcceptServerCertIssuer(); QString GetSSLAcceptServerCertPrivateKey(); bool GetSSLAcceptServerCertPrivateKeyAvailable(); QString GetSSLAcceptServerCertPrivateKeyContainer(); QString GetSSLAcceptServerCertPublicKey(); QString GetSSLAcceptServerCertPublicKeyAlgorithm(); int GetSSLAcceptServerCertPublicKeyLength(); QString GetSSLAcceptServerCertSerialNumber(); QString GetSSLAcceptServerCertSignatureAlgorithm(); QByteArray GetSSLAcceptServerCertStore();
int SetSSLAcceptServerCertStore(QByteArray qbaSSLAcceptServerCertStore); QString GetSSLAcceptServerCertStorePassword();
int SetSSLAcceptServerCertStorePassword(QString qsSSLAcceptServerCertStorePassword); int GetSSLAcceptServerCertStoreType();
int SetSSLAcceptServerCertStoreType(int iSSLAcceptServerCertStoreType); QString GetSSLAcceptServerCertSubjectAltNames(); QString GetSSLAcceptServerCertThumbprintMD5(); QString GetSSLAcceptServerCertThumbprintSHA1(); QString GetSSLAcceptServerCertThumbprintSHA256(); QString GetSSLAcceptServerCertUsage(); int GetSSLAcceptServerCertUsageFlags(); QString GetSSLAcceptServerCertVersion(); QString GetSSLAcceptServerCertSubject();
int SetSSLAcceptServerCertSubject(QString qsSSLAcceptServerCertSubject); QByteArray GetSSLAcceptServerCertEncoded();
int SetSSLAcceptServerCertEncoded(QByteArray qbaSSLAcceptServerCertEncoded);
Remarks
If it finds any issues with the certificate presented by the server, the class will normally terminate the connection with an error.
You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.
Note: This functionality is provided only for cases in which you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk.
Data Type
SSLCert Property (RecurringBilling Class)
The certificate to be used during Secure Sockets Layer (SSL) negotiation.
Syntax
InPayCertificate* GetSSLCert(); int SetSSLCert(InPayCertificate* val);
char* inpay_recurringbilling_getsslcerteffectivedate(void* lpObj);
char* inpay_recurringbilling_getsslcertexpirationdate(void* lpObj);
char* inpay_recurringbilling_getsslcertextendedkeyusage(void* lpObj);
char* inpay_recurringbilling_getsslcertfingerprint(void* lpObj);
char* inpay_recurringbilling_getsslcertfingerprintsha1(void* lpObj);
char* inpay_recurringbilling_getsslcertfingerprintsha256(void* lpObj);
char* inpay_recurringbilling_getsslcertissuer(void* lpObj);
char* inpay_recurringbilling_getsslcertprivatekey(void* lpObj);
int inpay_recurringbilling_getsslcertprivatekeyavailable(void* lpObj);
char* inpay_recurringbilling_getsslcertprivatekeycontainer(void* lpObj);
char* inpay_recurringbilling_getsslcertpublickey(void* lpObj);
char* inpay_recurringbilling_getsslcertpublickeyalgorithm(void* lpObj);
int inpay_recurringbilling_getsslcertpublickeylength(void* lpObj);
char* inpay_recurringbilling_getsslcertserialnumber(void* lpObj);
char* inpay_recurringbilling_getsslcertsignaturealgorithm(void* lpObj);
int inpay_recurringbilling_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int inpay_recurringbilling_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);
char* inpay_recurringbilling_getsslcertstorepassword(void* lpObj);
int inpay_recurringbilling_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);
int inpay_recurringbilling_getsslcertstoretype(void* lpObj);
int inpay_recurringbilling_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);
char* inpay_recurringbilling_getsslcertsubjectaltnames(void* lpObj);
char* inpay_recurringbilling_getsslcertthumbprintmd5(void* lpObj);
char* inpay_recurringbilling_getsslcertthumbprintsha1(void* lpObj);
char* inpay_recurringbilling_getsslcertthumbprintsha256(void* lpObj);
char* inpay_recurringbilling_getsslcertusage(void* lpObj);
int inpay_recurringbilling_getsslcertusageflags(void* lpObj);
char* inpay_recurringbilling_getsslcertversion(void* lpObj);
char* inpay_recurringbilling_getsslcertsubject(void* lpObj);
int inpay_recurringbilling_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);
int inpay_recurringbilling_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int inpay_recurringbilling_setsslcertencoded(void* lpObj, const char* lpSSLCertEncoded, int lenSSLCertEncoded);
QString GetSSLCertEffectiveDate(); QString GetSSLCertExpirationDate(); QString GetSSLCertExtendedKeyUsage(); QString GetSSLCertFingerprint(); QString GetSSLCertFingerprintSHA1(); QString GetSSLCertFingerprintSHA256(); QString GetSSLCertIssuer(); QString GetSSLCertPrivateKey(); bool GetSSLCertPrivateKeyAvailable(); QString GetSSLCertPrivateKeyContainer(); QString GetSSLCertPublicKey(); QString GetSSLCertPublicKeyAlgorithm(); int GetSSLCertPublicKeyLength(); QString GetSSLCertSerialNumber(); QString GetSSLCertSignatureAlgorithm(); QByteArray GetSSLCertStore();
int SetSSLCertStore(QByteArray qbaSSLCertStore); QString GetSSLCertStorePassword();
int SetSSLCertStorePassword(QString qsSSLCertStorePassword); int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType); QString GetSSLCertSubjectAltNames(); QString GetSSLCertThumbprintMD5(); QString GetSSLCertThumbprintSHA1(); QString GetSSLCertThumbprintSHA256(); QString GetSSLCertUsage(); int GetSSLCertUsageFlags(); QString GetSSLCertVersion(); QString GetSSLCertSubject();
int SetSSLCertSubject(QString qsSSLCertSubject); QByteArray GetSSLCertEncoded();
int SetSSLCertEncoded(QByteArray qbaSSLCertEncoded);
Remarks
This property includes the digital certificate that the class will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the Encoded field to the encoded certificate. To select a certificate, use the store and subject fields.
Data Type
SSLProvider Property (RecurringBilling Class)
The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.
Syntax
ANSI (Cross Platform) int GetSSLProvider();
int SetSSLProvider(int iSSLProvider); Unicode (Windows) INT GetSSLProvider();
INT SetSSLProvider(INT iSSLProvider);
Possible Values
SSLP_AUTOMATIC(0),
SSLP_PLATFORM(1),
SSLP_INTERNAL(2)
int inpay_recurringbilling_getsslprovider(void* lpObj);
int inpay_recurringbilling_setsslprovider(void* lpObj, int iSSLProvider);
int GetSSLProvider();
int SetSSLProvider(int iSSLProvider);
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 as follows:
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.
Data Type
Integer
SSLServerCert Property (RecurringBilling Class)
The server certificate for the last established connection.
Syntax
InPayCertificate* GetSSLServerCert();
char* inpay_recurringbilling_getsslservercerteffectivedate(void* lpObj);
char* inpay_recurringbilling_getsslservercertexpirationdate(void* lpObj);
char* inpay_recurringbilling_getsslservercertextendedkeyusage(void* lpObj);
char* inpay_recurringbilling_getsslservercertfingerprint(void* lpObj);
char* inpay_recurringbilling_getsslservercertfingerprintsha1(void* lpObj);
char* inpay_recurringbilling_getsslservercertfingerprintsha256(void* lpObj);
char* inpay_recurringbilling_getsslservercertissuer(void* lpObj);
char* inpay_recurringbilling_getsslservercertprivatekey(void* lpObj);
int inpay_recurringbilling_getsslservercertprivatekeyavailable(void* lpObj);
char* inpay_recurringbilling_getsslservercertprivatekeycontainer(void* lpObj);
char* inpay_recurringbilling_getsslservercertpublickey(void* lpObj);
char* inpay_recurringbilling_getsslservercertpublickeyalgorithm(void* lpObj);
int inpay_recurringbilling_getsslservercertpublickeylength(void* lpObj);
char* inpay_recurringbilling_getsslservercertserialnumber(void* lpObj);
char* inpay_recurringbilling_getsslservercertsignaturealgorithm(void* lpObj);
int inpay_recurringbilling_getsslservercertstore(void* lpObj, char** lpSSLServerCertStore, int* lenSSLServerCertStore);
char* inpay_recurringbilling_getsslservercertstorepassword(void* lpObj);
int inpay_recurringbilling_getsslservercertstoretype(void* lpObj);
char* inpay_recurringbilling_getsslservercertsubjectaltnames(void* lpObj);
char* inpay_recurringbilling_getsslservercertthumbprintmd5(void* lpObj);
char* inpay_recurringbilling_getsslservercertthumbprintsha1(void* lpObj);
char* inpay_recurringbilling_getsslservercertthumbprintsha256(void* lpObj);
char* inpay_recurringbilling_getsslservercertusage(void* lpObj);
int inpay_recurringbilling_getsslservercertusageflags(void* lpObj);
char* inpay_recurringbilling_getsslservercertversion(void* lpObj);
char* inpay_recurringbilling_getsslservercertsubject(void* lpObj);
int inpay_recurringbilling_getsslservercertencoded(void* lpObj, char** lpSSLServerCertEncoded, int* lenSSLServerCertEncoded);
QString GetSSLServerCertEffectiveDate(); QString GetSSLServerCertExpirationDate(); QString GetSSLServerCertExtendedKeyUsage(); QString GetSSLServerCertFingerprint(); QString GetSSLServerCertFingerprintSHA1(); QString GetSSLServerCertFingerprintSHA256(); QString GetSSLServerCertIssuer(); QString GetSSLServerCertPrivateKey(); bool GetSSLServerCertPrivateKeyAvailable(); QString GetSSLServerCertPrivateKeyContainer(); QString GetSSLServerCertPublicKey(); QString GetSSLServerCertPublicKeyAlgorithm(); int GetSSLServerCertPublicKeyLength(); QString GetSSLServerCertSerialNumber(); QString GetSSLServerCertSignatureAlgorithm(); QByteArray GetSSLServerCertStore(); QString GetSSLServerCertStorePassword(); int GetSSLServerCertStoreType(); QString GetSSLServerCertSubjectAltNames(); QString GetSSLServerCertThumbprintMD5(); QString GetSSLServerCertThumbprintSHA1(); QString GetSSLServerCertThumbprintSHA256(); QString GetSSLServerCertUsage(); int GetSSLServerCertUsageFlags(); QString GetSSLServerCertVersion(); QString GetSSLServerCertSubject(); QByteArray GetSSLServerCertEncoded();
Remarks
This property contains the server certificate for the last established connection.
SSLServerCert is reset every time a new connection is attempted.
This property is read-only.
Data Type
SubscriptionDesc Property (RecurringBilling Class)
Description of recurring subscription.
Syntax
ANSI (Cross Platform) char* GetSubscriptionDesc();
int SetSubscriptionDesc(const char* lpszSubscriptionDesc); Unicode (Windows) LPWSTR GetSubscriptionDesc();
INT SetSubscriptionDesc(LPCWSTR lpszSubscriptionDesc);
char* inpay_recurringbilling_getsubscriptiondesc(void* lpObj);
int inpay_recurringbilling_setsubscriptiondesc(void* lpObj, const char* lpszSubscriptionDesc);
QString GetSubscriptionDesc();
int SetSubscriptionDesc(QString qsSubscriptionDesc);
Default Value
""
Remarks
This field contains a description of the recurring subscription. Please see the RecurringBilling Gateway Setup and Required Properties page to determine if this is a required or optional field for the gateway you are using.
Data Type
String
SubscriptionDetails Property (RecurringBilling Class)
Contains the recurring subscription details.
Syntax
InPayEPSubscriptionDetails* GetSubscriptionDetails();
int inpay_recurringbilling_getsubscriptiondetailscardexpmonth(void* lpObj);
int inpay_recurringbilling_getsubscriptiondetailscardexpyear(void* lpObj);
char* inpay_recurringbilling_getsubscriptiondetailscardnumber(void* lpObj);
char* inpay_recurringbilling_getsubscriptiondetailsenddate(void* lpObj);
char* inpay_recurringbilling_getsubscriptiondetailsfrequency(void* lpObj);
char* inpay_recurringbilling_getsubscriptiondetailsfrequencyunit(void* lpObj);
char* inpay_recurringbilling_getsubscriptiondetailslastpaymentdate(void* lpObj);
char* inpay_recurringbilling_getsubscriptiondetailsnextpaymentdate(void* lpObj);
char* inpay_recurringbilling_getsubscriptiondetailsrecuramount(void* lpObj);
int inpay_recurringbilling_getsubscriptiondetailsremainingpayments(void* lpObj);
char* inpay_recurringbilling_getsubscriptiondetailsstartdate(void* lpObj);
char* inpay_recurringbilling_getsubscriptiondetailsstatus(void* lpObj);
char* inpay_recurringbilling_getsubscriptiondetailssubscriptionid(void* lpObj);
char* inpay_recurringbilling_getsubscriptiondetailssubscriptionname(void* lpObj);
int inpay_recurringbilling_getsubscriptiondetailstotalpayments(void* lpObj);
int GetSubscriptionDetailsCardExpMonth(); int GetSubscriptionDetailsCardExpYear(); QString GetSubscriptionDetailsCardNumber(); QString GetSubscriptionDetailsEndDate(); QString GetSubscriptionDetailsFrequency(); QString GetSubscriptionDetailsFrequencyUnit(); QString GetSubscriptionDetailsLastPaymentDate(); QString GetSubscriptionDetailsNextPaymentDate(); QString GetSubscriptionDetailsRecurAmount(); int GetSubscriptionDetailsRemainingPayments(); QString GetSubscriptionDetailsStartDate(); QString GetSubscriptionDetailsStatus(); QString GetSubscriptionDetailsSubscriptionId(); QString GetSubscriptionDetailsSubscriptionName(); int GetSubscriptionDetailsTotalPayments();
Remarks
This property will be populated with the recurring subscription details after a call to GetSubscriptionStatus.
The EPSubscriptionDetails type contains the following fields:
CardExpMonth | The expiration month of the card currently being processed for the recurring payments. |
CardExpYear | The expiration year of the card currently being processed for the recurring payments. |
CardNumber | The card number currently being processed for the recurring payments. |
EndDate | The date in which the recurring payments will stop processing. |
FrequencyUnit | The unit frequency in which the payments will be processed. |
Frequency | The frequency in which payments will occur. |
LastPaymentDate | The date that the last/previous transaction was processed. |
NextPaymentDate | The date of the next upcoming transaction. |
RecurAmount | The amount to be charged on a recurring basis. |
RemainingPayments | The total number of remaining payments until the recurring payments will stop processing. |
StartDate | The date in which the recurring payments will start processing. |
Status | The current status of the recurring subscription. |
SubscriptionId | The Subscription or Profile Identifier for the recurring payment. |
SubscriptionName | The name of the recurring subscription or profile. |
TotalPayments | The total number of payments. |
This property is read-only and not available at design time.
Data Type
SubscriptionName Property (RecurringBilling Class)
The name of the recurring subscription or profile.
Syntax
ANSI (Cross Platform) char* GetSubscriptionName();
int SetSubscriptionName(const char* lpszSubscriptionName); Unicode (Windows) LPWSTR GetSubscriptionName();
INT SetSubscriptionName(LPCWSTR lpszSubscriptionName);
char* inpay_recurringbilling_getsubscriptionname(void* lpObj);
int inpay_recurringbilling_setsubscriptionname(void* lpObj, const char* lpszSubscriptionName);
QString GetSubscriptionName();
int SetSubscriptionName(QString qsSubscriptionName);
Default Value
""
Remarks
This field contains the name of the recurring subscription or profile. Please see the RecurringBilling Gateway Setup and Required Properties page to determine if this is a required or optional field for the gateway you are using.
Data Type
String
TestMode Property (RecurringBilling Class)
Turns test mode on and off for transactions sent to the current Gateway .
Syntax
ANSI (Cross Platform) int GetTestMode();
int SetTestMode(int bTestMode); Unicode (Windows) BOOL GetTestMode();
INT SetTestMode(BOOL bTestMode);
int inpay_recurringbilling_gettestmode(void* lpObj);
int inpay_recurringbilling_settestmode(void* lpObj, int bTestMode);
bool GetTestMode();
int SetTestMode(bool bTestMode);
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 TestMode property to True and the current Gateway does not support it, the class will fails with an error.
Data Type
Boolean
Timeout Property (RecurringBilling Class)
A timeout for the class.
Syntax
ANSI (Cross Platform) int GetTimeout();
int SetTimeout(int iTimeout); Unicode (Windows) INT GetTimeout();
INT SetTimeout(INT iTimeout);
int inpay_recurringbilling_gettimeout(void* lpObj);
int inpay_recurringbilling_settimeout(void* lpObj, int iTimeout);
int GetTimeout();
int SetTimeout(int iTimeout);
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).
Data Type
Integer
TransactionId Property (RecurringBilling Class)
Merchant-generated transaction Id used for all transactions.
Syntax
ANSI (Cross Platform) char* GetTransactionId();
int SetTransactionId(const char* lpszTransactionId); Unicode (Windows) LPWSTR GetTransactionId();
INT SetTransactionId(LPCWSTR lpszTransactionId);
char* inpay_recurringbilling_gettransactionid(void* lpObj);
int inpay_recurringbilling_settransactionid(void* lpObj, const char* lpszTransactionId);
QString GetTransactionId();
int SetTransactionId(QString qsTransactionId);
Default Value
""
Remarks
This property is used to send a merchant-generated transaction id to the Gateway, if the gateway supports that feature.
Data Type
String
AddSpecialField Method (RecurringBilling Class)
Adds a special field name and the corresponding value.
Syntax
ANSI (Cross Platform) int AddSpecialField(const char* lpszName, const char* lpszValue); Unicode (Windows) INT AddSpecialField(LPCWSTR lpszName, LPCWSTR lpszValue);
int inpay_recurringbilling_addspecialfield(void* lpObj, const char* lpszName, const char* lpszValue);
int AddSpecialField(const QString& qsName, const QString& qsValue);
Remarks
Please refer to the Name and Value fields for more information on form variables and how they are managed.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
CancelSubscription Method (RecurringBilling Class)
Cancels or deletes a recurring payment subscription.
Syntax
ANSI (Cross Platform) int CancelSubscription(const char* lpszSubscriptionId); Unicode (Windows) INT CancelSubscription(LPCWSTR lpszSubscriptionId);
int inpay_recurringbilling_cancelsubscription(void* lpObj, const char* lpszSubscriptionId);
int CancelSubscription(const QString& qsSubscriptionId);
Remarks
This method is used to cancel or delete a recurring subscription identified by the specified SubscriptionId.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Config Method (RecurringBilling Class)
Sets or retrieves a configuration setting.
Syntax
ANSI (Cross Platform) char* Config(const char* lpszConfigurationString); Unicode (Windows) LPWSTR Config(LPCWSTR lpszConfigurationString);
char* inpay_recurringbilling_config(void* lpObj, const char* lpszConfigurationString);
QString Config(const QString& qsConfigurationString);
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.
Error Handling (C++)
This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
CreateSubscription Method (RecurringBilling Class)
Creates a new recurring subscription.
Syntax
ANSI (Cross Platform) int CreateSubscription(); Unicode (Windows) INT CreateSubscription();
int inpay_recurringbilling_createsubscription(void* lpObj);
int CreateSubscription();
Remarks
This method is used to create a recurring subscription based upon the payment details entered via PaymentSchedule.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
DoEvents Method (RecurringBilling Class)
This method processes events from the internal message queue.
Syntax
ANSI (Cross Platform) int DoEvents(); Unicode (Windows) INT DoEvents();
int inpay_recurringbilling_doevents(void* lpObj);
int DoEvents();
Remarks
When DoEvents is called, the class processes any available events. If no events are available, it waits for a preset period of time, and then returns.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
GetResponseVar Method (RecurringBilling Class)
Parses additional information out of the response.
Syntax
ANSI (Cross Platform) char* GetResponseVar(const char* lpszName); Unicode (Windows) LPWSTR GetResponseVar(LPCWSTR lpszName);
char* inpay_recurringbilling_getresponsevar(void* lpObj, const char* lpszName);
QString GetResponseVar(const QString& qsName);
Remarks
Due to the fact that this class supports so many gateways, only the most commonly used response variables are parsed into the Response fields. Any additional response information contained within the Data may be retrieved with this GetResponseVar method. There are three formats for the 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 Data field contains name/value pairs, pass the name in the Name parameter and this method will return the value. For instance, if Data contains "ResponseCode=00&FraudScore=53&ApprovalCode=123456&...", calling GetResponseVar("FraudScore") will return "53".
However, if Data contains a delimited list, pass the index of the field you wish to receive. For instance, if Data contains "00|53|123456|...", calling GetResponseVar("1") will return "53".
Finally, if Data contains XML, pass the xpath to the value you wish to receive. For instance, if Data contains "<Response><Code>00</Code><FraudScore>53</FraudScore><ApprovalCode>123456</ApprovalCode></Response>", calling GetResponseVar("/Response/FraudScore") will return "53".
Error Handling (C++)
This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
GetSubscriptionStatus Method (RecurringBilling Class)
Retrieves the status of a recurring payment subscription.
Syntax
ANSI (Cross Platform) int GetSubscriptionStatus(const char* lpszSubscriptionId); Unicode (Windows) INT GetSubscriptionStatus(LPCWSTR lpszSubscriptionId);
int inpay_recurringbilling_getsubscriptionstatus(void* lpObj, const char* lpszSubscriptionId);
int GetSubscriptionStatus(const QString& qsSubscriptionId);
Remarks
This method retrieves the current status of the recurring payment subscription specified via SubscriptionId. SubscriptionDetails will be populated with the details about the subscription.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Interrupt Method (RecurringBilling Class)
Interrupts the current action.
Syntax
ANSI (Cross Platform) int Interrupt(); Unicode (Windows) INT Interrupt();
int inpay_recurringbilling_interrupt(void* lpObj);
int Interrupt();
Remarks
This method interrupts any processing that the class is currently executing.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
ResetSpecialFields Method (RecurringBilling Class)
Resets all special fields to the default settings.
Syntax
ANSI (Cross Platform) int ResetSpecialFields(); Unicode (Windows) INT ResetSpecialFields();
int inpay_recurringbilling_resetspecialfields(void* lpObj);
int ResetSpecialFields();
Remarks
This function resets all special gateway configuration fields to the default settings for the specified Gateway.
Please refer to the Name and Value properties for more information on form variables and how they are managed.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
UpdateSubscription Method (RecurringBilling Class)
Updates a recurring payment subscription.
Syntax
ANSI (Cross Platform) int UpdateSubscription(const char* lpszSubscriptionId); Unicode (Windows) INT UpdateSubscription(LPCWSTR lpszSubscriptionId);
int inpay_recurringbilling_updatesubscription(void* lpObj, const char* lpszSubscriptionId);
int UpdateSubscription(const QString& qsSubscriptionId);
Remarks
This method is used to update a recurring subscription, specified by SubscriptionId. Specify new values via PaymentSchedule before calling this method.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Error Event (RecurringBilling Class)
Information about errors during data delivery.
Syntax
ANSI (Cross Platform) virtual int FireError(RecurringBillingErrorEventParams *e);
typedef struct {
int ErrorCode;
const char *Description; int reserved; } RecurringBillingErrorEventParams;
Unicode (Windows) virtual INT FireError(RecurringBillingErrorEventParams *e);
typedef struct {
INT ErrorCode;
LPCWSTR Description; INT reserved; } RecurringBillingErrorEventParams;
#define EID_RECURRINGBILLING_ERROR 1 virtual INT INPAY_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);
class RecurringBillingErrorEventParams { public: int ErrorCode(); const QString &Description(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Error(RecurringBillingErrorEventParams *e);
// Or, subclass RecurringBilling and override this emitter function. virtual int FireError(RecurringBillingErrorEventParams *e) {...}
Remarks
The 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.
SSLServerAuthentication Event (RecurringBilling Class)
Fired after the server presents its certificate to the client.
Syntax
ANSI (Cross Platform) virtual int FireSSLServerAuthentication(RecurringBillingSSLServerAuthenticationEventParams *e);
typedef struct {
const char *CertEncoded; int lenCertEncoded;
const char *CertSubject;
const char *CertIssuer;
const char *Status;
int Accept; int reserved; } RecurringBillingSSLServerAuthenticationEventParams;
Unicode (Windows) virtual INT FireSSLServerAuthentication(RecurringBillingSSLServerAuthenticationEventParams *e);
typedef struct {
LPCSTR CertEncoded; INT lenCertEncoded;
LPCWSTR CertSubject;
LPCWSTR CertIssuer;
LPCWSTR Status;
BOOL Accept; INT reserved; } RecurringBillingSSLServerAuthenticationEventParams;
#define EID_RECURRINGBILLING_SSLSERVERAUTHENTICATION 2 virtual INT INPAY_CALL FireSSLServerAuthentication(LPSTR &lpCertEncoded, INT &lenCertEncoded, LPSTR &lpszCertSubject, LPSTR &lpszCertIssuer, LPSTR &lpszStatus, BOOL &bAccept);
class RecurringBillingSSLServerAuthenticationEventParams { public: const QByteArray &CertEncoded(); const QString &CertSubject(); const QString &CertIssuer(); const QString &Status(); bool Accept(); void SetAccept(bool bAccept); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void SSLServerAuthentication(RecurringBillingSSLServerAuthenticationEventParams *e);
// Or, subclass RecurringBilling and override this emitter function. virtual int FireSSLServerAuthentication(RecurringBillingSSLServerAuthenticationEventParams *e) {...}
Remarks
During this event, the client can decide whether or not to continue with the connection process. 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 or not to continue.
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.
SSLStatus Event (RecurringBilling Class)
Fired when secure connection progress messages are available.
Syntax
ANSI (Cross Platform) virtual int FireSSLStatus(RecurringBillingSSLStatusEventParams *e);
typedef struct {
const char *Message; int reserved; } RecurringBillingSSLStatusEventParams;
Unicode (Windows) virtual INT FireSSLStatus(RecurringBillingSSLStatusEventParams *e);
typedef struct {
LPCWSTR Message; INT reserved; } RecurringBillingSSLStatusEventParams;
#define EID_RECURRINGBILLING_SSLSTATUS 3 virtual INT INPAY_CALL FireSSLStatus(LPSTR &lpszMessage);
class RecurringBillingSSLStatusEventParams { public: const QString &Message(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void SSLStatus(RecurringBillingSSLStatusEventParams *e);
// Or, subclass RecurringBilling and override this emitter function. virtual int FireSSLStatus(RecurringBillingSSLStatusEventParams *e) {...}
Remarks
The event is fired for informational and logging purposes only. This event tracks the progress of the connection.
CCCard Type
Contains the customer's credit card information.
Syntax
InPayCCCard (declared in inpay.h)
Remarks
This type contains the customer's credit card information. If you are processing transactions where the customer and his credit card are physically present, set the MagneticStripe field with the data read from the card reader. You may set either Track1 or Track2 data (but not both). You must also set the EntryDataSource to indicate which track is stored in the MagneticStripe field.
Example: Setting the Fields
CCCard card = new CCCard();
card.MagneticStripe = "B4012000033330026^FDMS TEST CARD /VISA^090410054321000000000000000 150 A";
card.EntryDataSource = edsTrack1;
Example: Using a Constructor
CCCard card = new CCCard("B4012000033330026^FDMS TEST CARD /VISA^090410054321000000000000000 150 A", edsTrack1);
If you are processing a transaction where the credit card is not physically present (eCommerce, mail/order, etc) or if the magstripe on the back of the card cannot be read by the card reader, you must set the Number, ExpMonth, and ExpYear fields, and EntryDataSource must be set to one of the manually entered enumerations.
Example: Setting the Fields
CCCard card = new CCCard();
card.Number = "4788250000028291";
card.ExpMonth = 12;
card.ExpYear = 2010;
card.EntryDataSource = edsManualEntryNoCardReader;
Example: Using a Constructor
CCCard card = new CCCard("4012000033330026", 04, 2009);
Note that the constructor in the previous example automatically sets the EntryDataSource to edsManualEntryNoCardReader. If you wish to set any
other value for the EntryDataSource, you must set it yourself before authorizing the transaction.
When authorizing a transaction, the fields used by the class are solely dependant on the value of EntryDataSource. If you set the Number, ExpMonth, and ExpYear fields, but EntryDataSource is set to edsTrack2, the class will look for MagneticStripe data when authorizing the transaction, and will fails with an error because none is present.
Fields
CardType
int
Default Value: 0
Type of credit card being used in this transaction. This field contains the customer's credit card type. This is automatically computed after the 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) |
CVVData
char*
Default Value: ""
Three digit security code on back of card (optional).
This alphanumeric field 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 field which can be used to determine if the customer is actually in possession of the credit card.
Even if the CVVData is incorrect, the transaction may still be authorized. It is up to the merchant to examine the ResponseCVVResult field and decide whether to honor the transaction or not.
Note: When set to a non-empty value, CVVPresence will be automatically set to cvpProvided. If set to empty string (""), CVVPresence will be automatically set to cvpNotProvided.
CVVPresence
int
Default Value: 0
Indicates the presence of the card verification value.
This field is used to indicate the presence of CVVData.
The class will automatically set this value to cvpProvided when a CVVData value is specified. You can explicitly specify the CVVPresence indicator by setting this property.
Available values are:
- cvpNotProvided (0)
- cvpProvided (1)
- cvpIllegible (2)
- cvpNotOnCard (3)
EntryDataSource
int
Default Value: 0
This field contains a 1-character code identifying the source of the customer data. The table below shows all supported values for this field.
edsTrack1 (0) | Full Magnetic stripe read and transmit, Track 1. |
edsTrack2 (1) | Full magnetic stripe read and transmit, Track 2. |
edsManualEntryTrack1Capable (2) | Manually keyed, Track 1 capable. |
edsManualEntryTrack2Capable (3) | Manually keyed, Track 2 capable. |
edsManualEntryNoCardReader (4) | Manually keyed, terminal has no card reading capability (use this for e-commerce and MOTO transactions). |
edsTrack2Contactless (6) | Full magnetic stripe read (Track 2 only), Chip Card capable terminal (Visa, Mastercard, and JCB Transactions only). |
edsManualEntryContactlessCapable (7) | Manually keyed, Chip Card read capable terminal (Visa, MasterCard, and JCB transactions only). |
ExpMonth
int
Default Value: 1
Expiration month of the credit card specified in Number.
This field contains the expiration date of the customer's credit card, and must be in the range 1 - 12.
ExpYear
int
Default Value: 2000
Expiration year of the credit card specified in Number.
This field contains the expiration date of the customer's credit card. This field must be in the range 0 - 99, or 2000 - 2099. Any date before the year 2000 or after 2099 cannot be specified.
IsEncrypted
int
Default Value: FALSE
Determines whether data set to the Number or MagneticStripe fields is validated.
By default, when the Number or MagneticStripe fields are set, the value will be validated and normalized. For instance, "4444-33332222 1111" will be normalized as "4444333322221111" and MagneticStripe data will be parsed for the track specified by EntryDataSource. 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 Number or MagneticStripe fields, and this can be accomplished by setting IsEncrypted to true. However, please note that in doing so automatic calculation of the CardType may be affected, and the card number will not be verified.
MagneticStripe
char*
Default Value: ""
Track data read off of the card's magnetic stripe.
If EntryDataSource is not one of the manually entered enumerations, then this field must be set with the track1 or track2 data from the magnetic stripe on the back of the customer's credit card. This includes everything after but not including the start sentinel (% or ;) and up to but not including the end sentinel (?) and LRC check character. You may only set this field with track 1 or track 2 data, and may not pass both. Use the EntryDataSource field to indicate which track you are sending.
The following example shows how to set the MagneticStripe and EntryDataSource fields if the data read off the card is "%B4788250000028291^TSYS^05121015432112345678?;4788250000028291=05121015432112345678?"
class.CardMagneticStripe = "B4788250000028291^TSYS^05121015432112345678"
class.CardEntryDataSource = edsTrack1
or
class.CardMagneticStripe = "4788250000028291=05121015432112345678"
class.CardEntryDataSource = edsTrack2
Industry regulations do not allow merchants or processors to store track data in any form of persistent storage. Failure to abide by this regulation can result in significant fines and other penalties.
Number
char*
Default Value: ""
Customer's credit card number for the transaction.
If you're sending the transaction with MagneticStripe data, this field should be left empty.
Constructors
CCCard()
CCCard(const char* lpszNumber, int iExpMonth, int iExpYear)
CCCard(const char* lpszMagneticStripe, int iEntryDataSource)
Certificate Type
This is the digital certificate being used.
Syntax
InPayCertificate (declared in inpay.h)
Remarks
This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.
- EffectiveDate
- ExpirationDate
- ExtendedKeyUsage
- Fingerprint
- FingerprintSHA1
- FingerprintSHA256
- Issuer
- PrivateKey
- PrivateKeyAvailable
- PrivateKeyContainer
- PublicKey
- PublicKeyAlgorithm
- PublicKeyLength
- SerialNumber
- SignatureAlgorithm
- Store
- StorePassword
- StoreType
- SubjectAltNames
- ThumbprintMD5
- ThumbprintSHA1
- ThumbprintSHA256
- Usage
- UsageFlags
- Version
- Subject
- Encoded
Fields
EffectiveDate
char* (read-only)
Default Value: ""
The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2000 15:00:00.
ExpirationDate
char* (read-only)
Default Value: ""
The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2001 15:00:00.
ExtendedKeyUsage
char* (read-only)
Default Value: ""
A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).
Fingerprint
char* (read-only)
Default Value: ""
The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02
FingerprintSHA1
char* (read-only)
Default Value: ""
The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84
FingerprintSHA256
char* (read-only)
Default Value: ""
The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53
Issuer
char* (read-only)
Default Value: ""
The issuer of the certificate. This field contains a string representation of the name of the issuing authority for the certificate.
PrivateKey
char* (read-only)
Default Value: ""
The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.
Note: The PrivateKey may be available but not exportable. In this case, PrivateKey returns an empty string.
PrivateKeyAvailable
int (read-only)
Default Value: FALSE
Whether a PrivateKey is available for the selected certificate. If PrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).
PrivateKeyContainer
char* (read-only)
Default Value: ""
The name of the PrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.
PublicKey
char* (read-only)
Default Value: ""
The public key of the certificate. The key is provided as PEM/Base64-encoded data.
PublicKeyAlgorithm
char* (read-only)
Default Value: ""
The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.
PublicKeyLength
int (read-only)
Default Value: 0
The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.
SerialNumber
char* (read-only)
Default Value: ""
The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.
SignatureAlgorithm
char* (read-only)
Default Value: ""
The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.
Store
char*
Default Value: "MY"
The name of the certificate store for the client certificate.
The StoreType field denotes the type of the certificate store specified by Store. If the store is password-protected, specify the password in StorePassword.
Store is used in conjunction with the Subject field to specify client certificates. If Store has a value, and Subject or Encoded is set, a search for a certificate is initiated. Please see the Subject field for details.
Designations of certificate stores are platform dependent.
The following designations are 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 cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).
StorePassword
char*
Default Value: ""
If the type of certificate store requires a password, this field is used to specify the password needed to open the certificate store.
StoreType
int
Default Value: 0
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 field 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 (PKCS#12) file containing certificates. |
3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) 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 PKCS#7 file containing certificates. |
12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 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 PKCS#11 interface.
To use a security key, the necessary data must first be collected using the CertMgr class. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the Store and set StorePassword 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. |
SubjectAltNames
char* (read-only)
Default Value: ""
Comma-separated lists of alternative subject names for the certificate.
ThumbprintMD5
char* (read-only)
Default Value: ""
The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
ThumbprintSHA1
char* (read-only)
Default Value: ""
The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
ThumbprintSHA256
char* (read-only)
Default Value: ""
The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
Usage
char* (read-only)
Default Value: ""
The text description of UsageFlags.
This value will be one or more of the following strings and will be separated by commas:
- Digital Signature
- Non-Repudiation
- Key Encipherment
- Data Encipherment
- Key Agreement
- Certificate Signing
- CRL Signing
- Encipher Only
If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.
UsageFlags
int (read-only)
Default Value: 0
The flags that show intended use for the certificate. The value of UsageFlags is a combination of the following flags:
0x80 | Digital Signature |
0x40 | Non-Repudiation |
0x20 | Key Encipherment |
0x10 | Data Encipherment |
0x08 | Key Agreement |
0x04 | Certificate Signing |
0x02 | CRL Signing |
0x01 | Encipher Only |
Please see the Usage field for a text representation of UsageFlags.
This functionality currently is not available when the provider is OpenSSL.
Version
char* (read-only)
Default Value: ""
The certificate's version number. The possible values are the strings "V1", "V2", and "V3".
Subject
char*
Default Value: ""
The subject of the certificate used for client authentication.
This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.
If a matching certificate is found, the field 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 as follows:
Field | Meaning |
CN | Common Name. This is commonly a hostname 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.
Encoded
char*
Default Value: ""
The certificate (PEM/Base64 encoded). This field is used to assign a specific certificate. The Store and Subject fields also may be used to specify a certificate.
When Encoded is set, a search is initiated in the current Store for the private key of the certificate. If the key is found, Subject is updated to reflect the full subject of the selected certificate; otherwise, Subject is set to an empty string.
Constructors
Certificate()
Creates a instance whose properties can be set. This is useful for use with when generating new certificates.
Certificate(const char* lpEncoded, int lenEncoded)
Parses Encoded as an X.509 public key.
Certificate(int iStoreType, const char* lpStore, int lenStore, const char* lpszStorePassword, const char* lpszSubject)
StoreType identifies the type of certificate store to use. See for descriptions of the different certificate stores. Store is a byte array containing the certificate data. StorePassword is the password used to protect the store.
After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The Subject parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.
EPBank Type
Contains the customer's bank routing and account information.
Syntax
InPayEPBank (declared in inpay.h)
Remarks
This type contains the customer's bank account information, and is used for electronic check transactions authorized by the ECheck class. The information contained by this type includes the customer's AccountNumber, the RoutingNumber (or ABA number) to his bank, the Name of the bank, and the AccountType (Checking or Savings). These may be set using the fields, or via the constructors.
Example: Setting the Fields
EPBank bank = new EPBank();
bank.AccountNumber = "9999967";
bank.RoutingNumber = "005300065";
bank.AccountType = acctChecking;
bank.Name = "Wachovia";
bank.AccountHolderName = "John Smith"
ECheck1.Bank = bank;
Example: Using the Constructors:
ECheck1.Bank = new EPBank("9999967", "005300065", acctChecking, "Wachovia", "John Smith");
Fields
AccountClass
int
Default Value: 0
Indicates whether a personal or business account is used for this transaction.
Available values:
Value | Definition |
acPersonal (0) | Personal Account. |
acBusiness (1) | Business Account. |
AccountHolderName
char*
Default Value: ""
Account holder's name. This field contains the customer's name as it appears on their account. Many gateways use this field in addition to, or instead of, the Customer Firsts and Last name fields. Note that if this field is not specified, the FullName field from the EPCustomer type will be used instead.
AccountNumber
char*
Default Value: ""
Bank account number for ACH transactions. This field contains the customer's bank account number, which along with the RoutingNumber identify the location of the account where funds are to be drawn from for ACH transactions. This field is required for all ACH transactions.
AccountType
int
Default Value: 0
Indicates whether a checking or savings account is used for this transaction. For gateways that support it, this field allows funds to be withdrawn (or added in the case of a Credit) from either the customer's Checking or Savings account.
Available values:
Value | Definition |
atChecking (0) | Checking Account. |
atSavings (1) | Savings Account. |
Name
char*
Default Value: ""
Name of the account holder's bank. For example, Citibank, Wells-Fargo, Wachovia, etc. This field contains the name of the bank associated with the RoutingNumber.
RoutingNumber
char*
Default Value: ""
Routing number for ACH transactions. This field contains the routing number to the customer's bank (Also known as an ABA code). This number indicates at which bank the AccountNumber is located, and is used to identify the location of the account where funds are to be drawn from for ACH transactions. This field is required for all ACH transactions.
Note: When using ACHPayments gateway, a leading zero must be added for Canadian bank accounts.
Constructors
EPBank()
EPBank(const char* lpszRoutingNumber, const char* lpszAccountNumber, int iAccountClass, int iAccountType)
EPBank(const char* lpszRoutingNumber, const char* lpszAccountNumber, int iAccountClass, int iAccountType, const char* lpszName, const char* lpszAccountHolderName)
EPCustomer Type
Contains customer information.
Syntax
InPayEPCustomer (declared in inpay.h)
Remarks
This type contains information about the customer which the merchant has collected. At the minimum, this should include the customer's name and address. You may also optionally include a merchant-generated customer Id, the customer's Email address, Phone number, and Fax number. This type is used by both the ICharge and ECheck classs.
Example:
EPCustomer cust = new EPCustomer();
cust.FirstName = "John"
cust.LastName = "Smith"
cust.FullName = "John M. Smith"
cust.Address = "123 Nowhere Ln."
cust.City = "Beverly Hills"
cust.State = "CA"
cust.Zip = "90210"
cust.Country = "USA"
cust.Phone = "555-555-5555"
cust.Email = "jsmith@fake.com"
cust.Id = "123456"
ICharge1.Customer = cust;
Fields
Address
char*
Default Value: ""
Customer's street address. This field 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 field. City, state, and zip code are set in the City, State, and Zip fields.
The length of this field varies by gateway. If the customer's address is very long, it is admissible to include only the street number in This field.
NOTE: For the Moneris gateway, this field should contain only the customer's street number. The street name should be added via the AddSpecialField method. For example:
class.CustomerAddress = "123"
class.AddSpecialField("avs_street_name", "Nowhere Ln")
Address2
char*
Default Value: ""
A specific detail on the customer's shipping address (such as building, suite, apartment, floor number etc.).
Aggregate
char*
Default Value: ""
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>
City
char*
Default Value: ""
Customer's city. This field 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 fields include Address, State, and Zip.
Country
char*
Default Value: ""
Customer's country. This field 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 field with the PayFuse gateway, this field should contain the ISO-3166 numeric code instead of the standard two-letter code. For example, the ISO code for the US is "840".
Email
char*
Default Value: ""
Customer's email address. This optional field contains the customer's email address.
Fax
char*
Default Value: ""
Customer's fax number. This optional field contains the customer's fax number.
FirstName
char*
Default Value: ""
Customer's first name. This field contains the customer's first name.
FullName
char*
Default Value: ""
Customer's full name. This field contains the customer's full name as it appears on the credit card or bank account. Many gateways use this field in addition to, or instead of, the FirstName and LastName fields. If a gateway requires a FullName and the field is empty, FullName will be constructed using the contents of FirstName and LastName.
Id
char*
Default Value: ""
Merchant-generated customer Id. This field contains a merchant-generated customer identification number. This number should be unique for each different customer that places an order with the merchant.
LastName
char*
Default Value: ""
Customer's last name. This field contains the customer's last name as it appears on their credit card.
Phone
char*
Default Value: ""
Customer's phone number. This optional field contains the customer's phone number.
State
char*
Default Value: ""
Customer's state. This field 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 fields include Address, City, and Zip.
Zip
char*
Default Value: ""
Customer's zip code (or postal code if outside of the USA). This field 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 fields include Address, City, and State.
Constructors
EPCustomer()
EPPaymentSchedule Type
Contains the recurring payment schedule.
Syntax
InPayEPPaymentSchedule (declared in inpay.h)
Remarks
This type contains the payment schedule information which the merchant has specified in agreement with the customer. This type is used by the RecurringBilling classs.
Please see the "Recurring Gateway Setup and Required Properties" page for further information about the applicable properties for each gateway.
Fields
EndDate
char*
Default Value: ""
The end date of the subscription.
The default format is "MM/dd/yyyy" and is controlled by DateFormat, or GetSubscriptionStatus.
Frequency
char*
Default Value: ""
The frequency of payments.
Possible values are:
- "None"
- "Daily"
- "Weekly"
- "BiWeekly"
- "FourWeeks"
- "SemiMonthly"
- "Monthly"
- "BiMonthly"
- "Quarterly"
- "SemiAnnually"
- "Annually"
Gateway specific values not covered by the above values may also be set. Please refer to RecurringBilling Gateway Setup and Required Properties for more information pertaining to gateway specific values.
If FrequencyUnit is applicable to the gateway, this field specifies the length of time between charges. This is used in combination with FrequencyUnit to specify the frequency of the billing. For instance if FrequencyUnit is set to "Days" and Frequency is set to "5", payments will occur every 5 days.
FrequencyUnit
char*
Default Value: ""
The unit of time to be used when calculating the frequency of payments.
Possible values are:
- "D" or "Days"
- "M" or "Months"
- "Y" or "Years"
InitialAmount
char*
Default Value: ""
The initial amount to be charged (such as a trial period or setup fee). This amount can vary from RecurAmount.
RecurAmount
char*
Default Value: ""
The amount to be charged on a recurring basis. This amount can vary from InitialAmount.
StartDate
char*
Default Value: ""
The date on which the recurring payments will start processing.
This property specifies the start date. The default format is "MM/dd/yyyy" and is controlled by DateFormat, or GetSubscriptionStatus.
TotalPayments
int
Default Value: 0
The total number of payments. Valid values differ between gateways. See RecurringBilling Gateway Setup and Required Properties for details.
TrialPayments
int
Default Value: 0
The total number of trial payments.
Constructors
EPPaymentSchedule()
EPRecurringResponse Type
Contains the response to the recurring transaction.
Syntax
InPayEPRecurringResponse (declared in inpay.h)
Remarks
This type contains the results of a transaction made with the RecurringBilling class. The fields contained by this type are listed below.
- ApprovalCode
- Approved
- AVSResult
- Code
- CVVResult
- Data
- ErrorCode
- ErrorText
- InvoiceNumber
- ProcessorCode
- SubscriptionId
- Text
- TransactionId
Fields
ApprovalCode
char* (read-only)
Default Value: ""
Contains an authorization code when a transaction has been approved. This field contains an authorization code when a transaction has been approved. If the Code returned indicates that the transaction is not approved, then the contents of this field should be ignored.
Approved
int (read-only)
Default Value: FALSE
Indicates the status of the last transaction. This field 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 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.
AVSResult
char* (read-only)
Default Value: ""
Contains the Address Verification System result code. This one character field 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).
AVSResult | 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 field 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 field 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 field 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 field will contain a 3-character string (if AVS checks were done), which contains the AVS checks for the following fields:
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 field 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 field 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 AVSResult field 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 AVSResult of "Fail,Pass" means that the street address failed validation, but the zip code passed.
DataCash
For DataCash, the field 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 field 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 field will contain a 4-character string, which contains the AVS checks for the following fields:
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 field 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 |
Code
char* (read-only)
Default Value: ""
Indicates the status of the authorization request. This field contains the actual response code as returned by the Gateway. Unlike the Approved field, this Code field may provide more details about why a transaction was declined. Therefore, it is recommended that developers check the Code as well as the Approved field. The Point of Sale system should evaluate this response code and NOT the 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.
CVVResult
char* (read-only)
Default Value: ""
Contains the returned CVV2 result code if it was requested. This field 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 field 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 field 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 field 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 field 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 field 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 field 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 field 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 |
Data
char* (read-only)
Default Value: ""
The entire response returned from the gateway processor. This field 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 fields.
ErrorCode
char* (read-only)
Default Value: ""
Additional error code returned by some gateways. If a gateway returns it, this field will contain an additional code that may explain why the transaction was declined. You may also wish to inspect ErrorText for a human-readable description of this ErrorCode.
ErrorText
char* (read-only)
Default Value: ""
Additional error description returned by some gateways. If a gateway returns it, this field will contain a human-readable description of the error which occurred (if any). You may also wish to inspect ErrorCode for an accompanying code which may be parsed and used by your application.
InvoiceNumber
char* (read-only)
Default Value: ""
Invoice number submitted in authorization request (if applicable). This field contains the Invoice Number submitted in the original transaction, echoed back by the Gateway host.
ProcessorCode
char* (read-only)
Default Value: ""
Response code from the underlying processor. Often times a Gateway will return a 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 field 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.
SubscriptionId
char* (read-only)
Default Value: ""
Contains the Subscription or Profile Identifier for the recurring payment. This field contains a subscription identifier or profile number used to reference a recurring payment. This field is used when performing subsequent actions on a recurring payment.
Text
char* (read-only)
Default Value: ""
Text information that describes each response code. This field 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).
TransactionId
char* (read-only)
Default Value: ""
Contains the Visa Transaction Identifier or MasterCard Reference Number. This field 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 field. Data returned in this field (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).
Constructors
EPRecurringResponse()
EPShipInfo Type
Contains shipping information.
Syntax
InPayEPShipInfo (declared in inpay.h)
Remarks
This type contains the shipping information which the merchant has collected. Shipping information is typically optional data. This type is used by the ICharge classs.
Example:
EPShipInfo shipInfo = new EPShipInfo();
shipInfo.FirstName = "John"
shipInfo.LastName = "Smith"
shipInfo.Address = "123 Nowhere Ln."
shipInfo.City = "Beverly Hills"
shipInfo.State = "CA"
shipInfo.Zip = "90210"
shipInfo.Country = "USA"
shipInfo.Phone = "555-555-5555"
ICharge1.ShippingInfo = shipInfo;
Fields
Address
char*
Default Value: ""
Customer's shipping street address.
Address2
char*
Default Value: ""
A specific detail on the customer's shipping address (such as building, suite, apartment, floor number etc.).
City
char*
Default Value: ""
Customer's shipping city.
Country
char*
Default Value: ""
Customer's shipping country. This field contains the country in which the customer is located. Most gateways use a two-letter country code, specified in ISO-3166.
Email
char*
Default Value: ""
Customer's email address.
FirstName
char*
Default Value: ""
Customer's first name.
LastName
char*
Default Value: ""
Customer's last name.
Phone
char*
Default Value: ""
Customer's phone number.
State
char*
Default Value: ""
Customer's shipping state.
Zip
char*
Default Value: ""
Customer's shipping zip code (or postal code if outside of the USA).
Constructors
EPShipInfo()
EPSpecialField Type
Additional name/value pairs which can be added to a transaction.
Syntax
InPayEPSpecialField (declared in inpay.h)
Remarks
This type contains a Name and Value which may contain any additional information you wish to send to your gateway that this class does not currently send. You must know the field name in the gateway integration guide available from your gateway. For instance, the code below shows how to add a customer IP Address for the Authorize.Net gateway:
ICharge1.SpecialFields.add(new EPSpecialField("x_customer_ip", "255.123.456.78"));
Fields
Name
char*
Default Value: ""
Name of special configuration field to submit in this transaction. The Name and Value fields can be used to send special gateway configuration and transaction fields for each transaction. These fields can also be used to extend the functionality of this class by submitting additional information to the gateway.
This field is not applicable for the LinkPoint, FirstData, YourPay, PayFuse, or Orbital gateways.
Value
char*
Default Value: ""
Value of special configuration field to submit in this transaction. The Name and Value fields can be used to send special gateway configuration and transaction fields for each transaction. These fields can also be used to extend the functionality of this class by submitting additional information to the gateway.
Note: This field is not applicable for the LinkPoint, FirstData, YourPay, PayFuse, or Orbital gateways.
Constructors
EPSpecialField()
EPSpecialField(const char* lpszName, const char* lpszValue)
EPSubscriptionDetails Type
Contains the recurring subscription details.
Syntax
InPayEPSubscriptionDetails (declared in inpay.h)
Remarks
This type contains the details about a recurring subscription. This type is used by the RecurringBilling classs.
- CardExpMonth
- CardExpYear
- CardNumber
- EndDate
- Frequency
- FrequencyUnit
- LastPaymentDate
- NextPaymentDate
- RecurAmount
- RemainingPayments
- StartDate
- Status
- SubscriptionId
- SubscriptionName
- TotalPayments
Fields
CardExpMonth
int (read-only)
Default Value: 0
The expiration month of the card currently being processed for the recurring payments.
CardExpYear
int (read-only)
Default Value: 0
The expiration year of the card currently being processed for the recurring payments.
CardNumber
char* (read-only)
Default Value: ""
The card number currently being processed for the recurring payments.
EndDate
char* (read-only)
Default Value: ""
The date in which the recurring payments will stop processing.
The date is returned in the format specified within the DateFormat config.
Frequency
char* (read-only)
Default Value: ""
The frequency in which payments will occur.
If FrequencyUnit is applicable, this field will contain the length of the corresponding FrequencyUnit in which payments will occur.
This component uses pre-defined Frequency values which are listed below. If a gateway returns any value not contained within the pre-defined list, the raw value will be returned.
- None
- Daily
- Weekly
- BiWeekly
- FourWeeks
- SemiMonthly
- Monthly
- BiMonthly
- Quarterly
- SemiAnnually
- Annually
FrequencyUnit
char* (read-only)
Default Value: ""
The unit frequency in which the payments will be processed.
This component uses pre-defined FrequencyUnit values which are listed below. If a gateway returns any value not contained within the pre-defined list, the raw value will be returned.
- Days
- Weeks
- Months
- Years
LastPaymentDate
char* (read-only)
Default Value: ""
The date that the last/previous transaction was processed.
The date is returned in the format specified within the DateFormat config.
NextPaymentDate
char* (read-only)
Default Value: ""
The date of the next upcoming transaction.
The date is returned in the format specified within the DateFormat config.
RecurAmount
char* (read-only)
Default Value: ""
The amount being charged on a recurring basis.
RemainingPayments
int (read-only)
Default Value: 0
The total number of remaining payments until the recurring payments will stop processing.
StartDate
char* (read-only)
Default Value: ""
The date in which the recurring payments started processing.
The date is returned in the format specified within the DateFormat config.
Status
char* (read-only)
Default Value: ""
The current status of the recurring subscription.
SubscriptionId
char* (read-only)
Default Value: ""
Contains the Subscription or Profile Identifier for the recurring payment.
This field contains a subscription identifier or profile number used to reference a recurring payment.
SubscriptionName
char* (read-only)
Default Value: ""
Contains the name of the recurring subscription or profile.
TotalPayments
int (read-only)
Default Value: 0
The total number of payments.
Constructors
EPSubscriptionDetails()
Proxy Type
The proxy the component will connect to.
Syntax
InPayProxy (declared in inpay.h)
Remarks
When connecting through a proxy, this type is used to specify different properties of the proxy, such as the Server and the AuthScheme.
Fields
AuthScheme
int
Default Value: 0
The type of authorization to perform when connecting to the proxy. This is used only when the User and Password fields are set.
AuthScheme should be set to authNone (3) when no authentication is expected.
By default, AuthScheme is authBasic (0), and if the User and Password fields are set, the class will attempt basic authentication.
If AuthScheme is set to authDigest (1), digest authentication will be attempted instead.
If AuthScheme 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 AuthScheme is set to authNtlm (4), NTLM authentication will be used.
For security reasons, setting this field will clear the values of User and Password.
AutoDetect
int
Default Value: FALSE
Whether to automatically detect and use proxy system settings, if available. The default value is false.
Password
char*
Default Value: ""
A password if authentication is to be used for the proxy.
If AuthScheme is set to Basic Authentication, the User and Password fields are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].
If AuthScheme is set to Digest Authentication, the User and Password fields are used to respond to the Digest Authentication challenge from the server.
If AuthScheme is set to NTLM Authentication, the User and Password fields are used to authenticate through NTLM negotiation.
Port
int
Default Value: 80
The Transmission Control Protocol (TCP) port for the proxy Server (default 80). See the description of the Server field for details.
Server
char*
Default Value: ""
If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
If the Server field is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the Server field is set to the corresponding address. If the search is not successful, an error is returned.
SSL
int
Default Value: 0
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. |
User
char*
Default Value: ""
A username if authentication is to be used for the proxy.
If AuthScheme is set to Basic Authentication, the User and Password fields are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].
If AuthScheme is set to Digest Authentication, the User and Password fields are used to respond to the Digest Authentication challenge from the server.
If AuthScheme is set to NTLM Authentication, the User and Password fields are used to authenticate through NTLM negotiation.
Constructors
Proxy()
Proxy(const char* lpszServer, int iPort)
Proxy(const char* lpszServer, int iPort, const char* lpszUser, const char* lpszPassword)
InPayList Type
Syntax
InPayList<T> (declared in inpay.h)
Remarks
InPayList is a generic class that is used to hold a collection of objects of type T, where T is one of the custom types supported by the RecurringBilling class.
Methods | |
GetCount |
This method returns the current size of the collection.
int GetCount() {}
|
SetCount |
This method sets the size of the collection. This method returns 0 if setting the size was successful; or -1 if the collection is ReadOnly. When adding additional objects to a collection call this method to specify the new size. Increasing the size of the collection preserves existing objects in the collection.
int SetCount(int count) {}
|
Get |
This method gets the item at the specified position. The index parameter specifies the index of the item in the collection. This method returns NULL if an invalid index is specified.
T* Get(int index) {}
|
Set |
This method sets the item at the specified position. The index parameter specifies the index of the item in the collection that is being set. This method returns -1 if an invalid index is specified. Note: Objects created using the new operator must be freed using the delete operator; they will not be automatically freed by the class.
T* Set(int index, T* value) {}
|
Config Settings (RecurringBilling Class)
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.RecurringBilling Config Settings
Value | Format |
0 | Unspecified (default) |
1 | Dollars (1.00) |
2 | Cents (100) |
When updating a payment profile, this masked card number will be re-submitted if real card information is not specified, which prevents Authorize.Net from changing the card information on file. This makes it possible to update just the billing information associated with a payment profile without affecting the stored card information. This configuration setting can also be used when updating a subscription with the Authorize.NET gateway.
The available request types are:
Value | Description |
0 (default) | Profile - Used to perform a profile activity |
1 | Payment Profile - Used to perform a payment profile activity (card/bank and billing info) which is linked to a profile. |
2 | Shipping Address - Used to perform a shipping address activity which is linked to a profile. |
This setting is only valid with the gwAuthorizeNetXML and gwAuthorizeNetCIM gateways, it cannot be used with the gwAuthorizeNet gateway.
This setting is only valid with the gwAuthorizeNetXML and gwAuthorizeNetCIM gateways, it cannot be used with the gwAuthorizeNet gateway.
Possible values are:
Value | Description |
0 | Active |
1 | Inactive |
2 | Pending |
3 | Clsoed |
Note: If only the billing date is to be updated, it is better to set the BASYSRequestType configuration setting to 4 and set the BASYSNumberOfDays configuration setting to the number of days to be added to the billing date.
Possible values are:
Value | Description |
0 | Credit Card |
1 | Check/ACH |
See RecurringBilling Gateway Setup and Required Properties for details.
Possible values are:
Value | Description |
0 | Customer Profile: Used to create a customer profile. This is the first step towards successfully storing and initiating recurring payments. |
1 | Credit Card Info: Used to to store a credit card number. The Customer Key must be specified via BASYSCustomerKey configuration setting. |
2 | Check Info: Used to store a checking account number. The Customer Key must be specified via BASYSCustomerKey configuration setting. |
3 | Recurring Payment: Used to create a payment schedule. The Customer Key must be specified via BASYSCustomerKey configuration setting. |
4 | Next Bill Date: Used to update the next billing date in the event that a payment was declined and a contract suspended. The Customer Key and Contract Key must be specified via BASYSCustomerKey, and BASYSContractKey configuration settings. |
5 | Get Token: Used to generate a Token based on the Credit Card information. The Customer Key must be specified via BASYSCustomerKey configuration setting. |
Possible values are:
Value | Description |
0 | Default (BASYS Gateway Default Format). |
1 | Card Format. |
Important: Be sure to call GetSubscriptionStatus after setting BlueSnapRequestType (or after calling UpdateSubscription with it already set) in order to ensure that you have retrieved the most recent data!
To add a new card payment source, set this to -1, which will cause the class to reset the populated fields to their default values.
To update an existing card payment source (be it the card expiration date or its billing information), first set this to the desired card's index, modify the fields you wish to change, and set the full card number and security code, and then call UpdateSubscription. (The update request will fail if you do not set the full card number and security code first, they are not returned when the vaulted shopper is retrieved.)
Note that the BlueSnap API makes no guarantee about the order of the card payment sources when it returns a vaulted shopper response. As such, it is important that you never assume that you know which card is at a particular index right after you call GetSubscriptionStatus or UpdateSubscription.
Important: Be sure to call GetSubscriptionStatus after setting BlueSnapRequestType (or after calling UpdateSubscription with it already set) in order to ensure that you have retrieved the most recent data!
{"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".
When you set the value of this setting, the class resets the properties, special fields, and configuration settings it uses to map to BlueSnap vaulted shopper fields. Only the following retain their values: Gateway, MerchantLogin, MerchantPassword, TestMode, BlueSnapVaultedShopperId, and Response fields (other than CVVResult and AVSResult, which are reset).
It is expected that you will call GetSubscriptionStatus to retrieve and populate the class with the latest vaulted shopper details after setting this (unless you plan to create a new vaulted shopper, or keep in mind that any fields not sent in an update request may be cleared by BlueSnap).
See RecurringBilling Gateway Setup and Required Properties for details.
Possible values are:
Value | Description |
0 | Create vaulted shopper with basic information |
1 | Retrieve/Update basic vaulted shopper information |
2 | Retrieve/Add/Update a Card payment source |
3 | Retrieve/Update the ECheck payment source |
The other request types require you to set the Vaulted Shopper ID via the BlueSnapVaultedShopperId configuration setting, after which you may use the GetSubscriptionStatus and UpdateSubscription methods to retrieve and add/update vaulted shopper data (note that any method parameters are ignored).
Note that all basic information is automatically retrieved and then re-sent when adding/updating any payment source in order to prevent BlueSnap from clearing those fields.
This config is currently applicable to the Heartland gateway.
Note that this is only valid when the Gateway property is set to gwNuvei or gwSquare.
The available card types are:
Value | Description |
0 | Invalid or unknown prefix, card type not known |
1 | Visa or Delta Card |
2 | MasterCard |
3 | American Express Card |
4 | Discover Card |
5 | Diners Club or Carte Blanche Card |
6 | JCB Card |
7 | Visa Electron Card (runs as a Visa for most gateways) |
8 | Maestro Card |
10 | Laser Card (Ireland) |
By default this setting is False; calling CancelSubscription will cause a subscription to be cancelled, but it will remain in the CyberSource Business Center.
Applicable format values are:
Format | Description |
'Y' or 'y' | Year |
'M' | Month |
'd' | Day Of Month |
Value | Description |
0 | Rebill Event: Used to create a defined payment plan for a customer. The customer Id must be specified via TransactionId. |
1 | Customer: Used to create a customer. A customer must be created before creating a recurring transaction (Rebill Event). |
Value | Description |
0 | Recurring Transaction: Used to create a defined payment plan for a generated registration. The Registration Id must be specified via TransactionId. |
1 | Registration: Used to create a registration for card, billing, and shipping information. A registration must be created before creating a recurring transaction. |
Value | Algorithm |
0 | MD5 (default) |
1 | SHA-1 |
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 MerchantLogin, TransactionId, and TransactionAmount. 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.
Possible values are:
Value | Description |
"signature" (default) | Customer signature obtained. |
"pin" | PIN Number. |
"nopin" | Unattended terminal - no PIN pad. |
"directmarket" | Mail, telephone, or online. |
Value | Description |
0 | Plan: Used to create a defined payment plan. This is applicable when calling CreateSubscription or UpdateSubscription. |
1 | Subscription: Used to enroll a customer in recurring billing based on a specified payment plan. This is applicable when calling CreateSubscription, UpdateSubscription, or CancelSubscription. |
- "MONTH" (Trial interval of one month)
- "DAY" (Trial interval of one day).
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 MerchantLogin (e.g., when processing AMEX transactions, or when supporting multiple currencies).
Valid Values:
Value | Description |
1 | Magtek Udynamo |
2 | Magtek IPAD |
3 | All IDTech Devices |
4 | Specific Ingenico Devices |
Value | Description |
0 | Recurring Transaction: Used to create or modify a recurring transaction. The customer Id must be specified via Id, and the account Id must be specified via TransactionId. |
1 | Customer: Used to create, modify, or retrieve information about a customer. A customer must be created before creating an account or recurring transaction. |
2 | Account: Used to create, modify, or retrieve information about an account. The customer Id must be specified via Id. An account must be created before creating a recurring transaction. |
"A" | Auto Generate the CustomerRefNum (Id) |
"S" | Use CustomerRefNum (Id) sent in the request. |
"0" | Use OrderID (InvoiceNumber) sent in the request. |
"D" | Use Comments (TransactionDesc) sent in the request. |
"NO" | No mapping to order data. |
"OI" | Pre-populate OrderId (InvoiceNumber) with the Customer Reference Number (Id). |
"OD" | Pre-populate the Comments field (TransactionDesc) with the Customer Reference Number (Id). |
"OA" | Pre-populate the OrderId (InvoiceNumber) and Comments (TransactionDesc) fields with the Customer Reference Number (Id). |
The available transaction types are:
Value | Description |
0 (default) | Stored Credit Card - Used to perform a stored credit card operations. |
1 | Customer - Used to perform customer operations. |
Value | Description |
0 | Customer: Used to create a customer. A customer must be created before creating a recurring payment. |
1 | Recurring Payment: Used to create a recurring payment for a customer. The customer Id must be specified via TransactionId. |
Structure of PayWiserPlanPattern and PayWiserRetryPattern:
For daily recurrence:
Meaning | Length | Example | Description | |
Type designator | 1 | D | D - Daily | |
Start date | 8 | 20160301 | Recurring schedule start date in YYYYMMdi format | |
End date | 8 | ZZZZZZZZ | Recurring schedule end date in YYYYMMdi format. If you do not wish to limit recurring payments with end date, this part should be >>ZZZZZZZ<< | |
Number of occurrences | 4 | 0010 | Number of occurrences | |
Predefined | 2 | 02 | Predefined | |
Regenerate every X days | 3 | 003 | Number of days in between payments |
Example: D20160301ZZZZZZZZ001002003
Explanation: Starting from 1.3.2016, there will be payment every three days and there will be 10 repetitions. If you wish to make a payment every day, pattern would be D20160301ZZZZZZZZ001002001.
For weekly recurrence:
Meaning | Length | Example | Description | |
Type designator | 1 | W | W - Weekly | |
Start date | 8 | 20160301 | Recurring schedule start date in YYYYMMdi format | |
End date | 8 | ZZZZZZZZ | Recurring schedule end date in YYYYMMdi format. If you do not wish to limit recurring payments with end date, this part should be >>ZZZZZZZ<< | |
Number of occurrences | 4 | 0010 | Number of occurrences | |
Predefined | 2 | 02 | Predefined | |
Regenerate on Sunday | 1 | N | Y for true, N for false | |
Regenerate on Monday | 1 | Y | Y for true, N for false | |
Regenerate on Tuesday | 1 | N | Y for true, N for false | |
Regenerate on Wednesday | 1 | N | Y for true, N for false | |
Regenerate on Thursday | 1 | N | Y for true, N for false | |
Regenerate on Friday | 1 | N | Y for true, N for false | |
Regenerate on Saturday | 1 | N | Y for true, N for false | |
Regenerate every X weeks | 3 | 003 | Number of weeks in between payments |
Example: W20160301ZZZZZZZZ001002NYNNNNN001
Explanation: Starting from 1.3.2016, there will be payment every Monday and there will be 10 repetitions. If you wish to make a payment every 2 weeks, pattern would be W20160301ZZZZZZZZ001002NYNNNNN002.
For For monthly recurrence:
Meaning | Length | Example | Description | |
Type designator | 1 | M | M - Monthly | |
Start date | 8 | 20160301 | Recurring schedule start date in YYYYMMdi format | |
End date | 8 | ZZZZZZZZ | Recurring schedule end date in YYYYMMdi format. If you do not wish to limit recurring payments with end date, this part should be >>ZZZZZZZ<< | |
Number of occurrences | 4 | 0010 | Number of occurrences | |
Regeneration type | 1 | 0 | Regeneration type | |
End date type | 1 | 2 | End date type | |
Regenerate on specific day | 2 | 22 | Day of the month when payment is to be made | |
Custom date part one | 1 | Z | A - first, B - second, C - third, D - fourth, E - last | |
Custom date part two | 1 | Z | A - day, B - weekday, C - weekend day, D - Sunday, E - Monday, F - Tuesday, G - Wednesday, H - Thursday, I - Friday, J - Saturday | |
Adjustment value | 3 | 000 | Adjustment value | |
Regenerate every X months | 3 | 003 | Number of months in between payments |
Example: M20160301ZZZZZZZZ00100229ZZ000001
Explanation: Starting from 1.3.2016, there will be payment on every 22nd of the month and there will be 10 repetitions. If you wish to make a payment every 2 months with 10 repetitions, pattern would be M20160301ZZZZZZZZ00100229ZZ000002.
For For Yearly recurrence:
Meaning | Length | Example | Description | |
Type designator | 1 | Y | Y - Yearly | |
Start date | 8 | 20160301 | Recurring schedule start date in YYYYMMdi format | |
End date | 8 | ZZZZZZZZ | Recurring schedule end date in YYYYMMdi format. If you do not wish to limit recurring payments with end date, this part should be >>ZZZZZZZ<< | |
Number of occurrences | 4 | 0010 | Number of occurrences | |
Regeneration type | 1 | 0 | Regeneration type | |
End date type | 1 | 2 | End date type | |
Regenerate on specific day | 2 | 22 | Day of the month when payment is to be made | |
Regenerate on specific month | 2 | 03 | Month of the year when payment is to be made | |
Custom date part one | 1 | Z | A - first, B - second, C - third, D - fourth, E - last | |
Custom date part two | 1 | Z | A - day, B - weekday, C - weekend day, D - Sunday, E - Monday, F - Tuesday, G - Wednesday, H - Thursday, I - Friday, J - Saturday | |
Custom date part three | 1 | Z | A - January, B - February, C - March, D - April, E - May, F - June, G - July, H - August, I - September, J - October, K - November, L - December | |
Adjustment value | 3 | 000 | Adjustment value |
Example: Y20160301ZZZZZZZZ0010022203ZZZ000
Explanation: Starting from 1.3.2016, there will be payment on every March 22nd and there will be 10 repetitions. If you wish to make a payment every first day of December with 10 repetitions, pattern would be Y20160301ZZZZZZZZ0010120000AAL000.
See RecurringBilling Gateway Setup and Required Properties for details.
Possible values are:
Value | Description |
0 | CreateRecurringPlan: Used to create new recurring plan, which can later on be used to start new recurring payments. |
1 | Tokenize: Used to generate a Token based on the Credit Card information, which can later on be used to start new recurring payments. |
2 | StartRecurringPayment: Used to create and start a new recurring payment for previously tokenized card. The Card Token must be specified via PayWiserCardToken configuration setting. |
3 | TerminateRecurringPlan: Used to terminate a recurring plan. |
4 | TerminateRecurringPayment: Used to terminate (end) recurring payment schedule immediately. |
The default value is 0 (Customer Profile). Option 0, 1 and 2 are only valid when CreateSubscription method is called. Option 3 and 4 are only valid when calling CancelSubscription method.
Note if this configuration setting is set, MaxRetryCount filed must be also set using the AddSpecialField method. For example:
recurring.AddSpecialField("MaxRetryCount", "1");
recurring.Config("PayWiserRetryPattern=W20160901ZZZZZZZZ010002NNYYYYN002");
Possible values are:
Value | Description |
0 | Active |
1 | Inactive |
2 | Pending |
3 | Clsoed |
Note: If only the billing date is to be updated, it is better to set the PhoeniXGateRequestType configuration setting to 4 and set the PhoeniXGateNumberOfDays configuration setting to the number of days to be added to the billing date.
Possible values are:
Value | Description |
0 | Credit Card |
1 | Check/ACH |
See RecurringBilling Gateway Setup and Required Properties for details.
Possible values are:
Value | Description |
0 | Customer Profile: Used to create a customer profile. This is the first step towards successfully storing and initiating recurring payments. |
1 | Credit Card Info: Used to to store a credit card number. The Customer Key must be specified via PhoeniXGateCustomerKey configuration setting. |
2 | Check Info: Used to store a checking account number. The Customer Key must be specified via PhoeniXGateCustomerKey configuration setting. |
3 | Recurring Payment: Used to create a payment schedule. The Customer Key must be specified via PhoeniXGateCustomerKey configuration setting. |
4 | Next Bill Date: Used to update the next billing date in the event that a payment was declined and a contract suspended. The Customer Key and Contract Key must be specified via PhoeniXGateCustomerKey, and PhoeniXGateContractKey configuration settings. |
5 | Get Token: Used to generate a Token based on the Credit Card information. The Customer Key must be specified via PhoeniXGateCustomerKey configuration setting. |
Possible values are:
Value | Description |
0 | Default (PhoeniXGate Gateway Default Format). |
1 | Card Format. |
Value | Description |
SUN | Schedule runs on Sunday. |
MON | Schedule runs on Monday. |
TUE | Schedule runs on Tuesday. |
WED | Schedule runs on Wednesday. |
THU | Schedule runs on Thursday. |
FRI | Schedule runs on Friday. |
SAT | Schedule runs on Saturday. |
DAY | Schedule runs on the FIRST or LAST day. |
WEEKDAY | Schedule runs on the FIRST or LAST weekday. |
Possible types are:
Type | Description |
FIRST | Schedule runs on First FrequencyDay. |
SECOND | Schedule runs on Second FrequencyDay. |
THIRD | Schedule runs on Third FrequencyDay. |
FOURTH | Schedule runs on Fourth FrequencyDay. |
LAST | Schedule runs on Last FrequencyDay. |
Value | Description |
JAN | Schedule runs in January. |
FEB | Schedule runs in February. |
MAR | Schedule runs in March. |
APR | Schedule runs in April. |
MAY | Schedule runs in May. |
JUN | Schedule runs in June. |
JUL | Schedule runs in July. |
AUG | Schedule runs in August. |
SEP | Schedule runs in September. |
OCT | Schedule runs in October. |
NOV | Schedule runs in November. |
DEC | Schedule runs in December. |
Value | Description |
0 | Wallet: Used to create a wallet entry. A wallet must be created before creating a scheduled billing event. |
1 | Scheduled Billing: Used to create a scheduled billing event. The wallet Id must be specified via TransactionId. |
component.Sale()
MyString = component.Config("RawRequest")
component.Sale()
MyString = component.Config("RawResponse")
Possible values are:
Value | Description |
0 | Active |
1 | Inactive |
2 | Pending |
3 | Clsoed |
Note: If only the billing date is to be updated, it is better to set the RepayRequestType configuration setting to 4 and set the RepayNumberOfDays configuration setting to the number of days to be added to the billing date.
Possible values are:
Value | Description |
0 | Credit Card |
1 | Check/ACH |
See RecurringBilling Gateway Setup and Required Properties for details.
Possible values are:
Value | Description |
0 | Customer Profile: Used to create a customer profile. This is the first step towards successfully storing and initiating recurring payments. |
1 | Credit Card Info: Used to to store a credit card number. The Customer Key must be specified via RepayCustomerKey configuration setting. |
2 | Check Info: Used to store a checking account number. The Customer Key must be specified via RepayCustomerKey configuration setting. |
3 | Recurring Payment: Used to create a payment schedule. The Customer Key must be specified via RepayCustomerKey configuration setting. |
4 | Next Bill Date: Used to update the next billing date in the event that a payment was declined and a contract suspended. The Customer Key and Contract Key must be specified via RepayCustomerKey, and RepayContractKey configuration settings. |
5 | Get Token: Used to generate a Token based on the Credit Card information. The Customer Key must be specified via RepayCustomerKey configuration setting. |
Possible values are:
Value | Description |
0 | Default (Repay Gateway Default Format). |
1 | Card Format. |
This setting is automatically populated after creating a new card-on-file, or when SquareCustomerCardIndex is set after retrieving a Square customer profile.
This setting must be set before attempting to delete a card-on-file.
Valid values are -1 to (SquareCustomerCardCount - 1). Setting to -1 causes the class to reset/remove any currently populated Square customer card data.
- 0: Customer Details (default)
- 1: Customer Cards
When set to 0, the CreateSubscription and CancelSubscription methods will create and delete Square customer profiles.
When set to 1, the CreateSubscription and CancelSubscription methods will create and delete credit cards on the Square customer whose Id is specified by Id.
Note that, regardless of this setting:
- The GetSubscriptionStatus method will always retrieve all information associated with the Square customer profile whose Id is specified by Id. (This includes all cards-on-file for that profile, refer to the SquareCustomerCardCount and SquareCustomerCardIndex configuration settings for more information.)
- The UpdateSubscription method will always update the customer details using the information currently held by the class. (Square does not allow updating cards-on-file.)
The available values for the CyberSource gateway are (If not specified, the component will set the value to either '2' or '3' based on the specified EntryDataSource.):
Value | Description |
1 | Terminal has a magnetic stripe reader only. |
2 | Terminal has a magnetic stripe reader and manual entry capability. |
3 | Terminal has manual entry capability only. |
The available values for the Litle gateway are (If not specified, the component will set the value to 'magstripe'.):
Value | Description |
notused | Terminal not used. |
magstripe | Magnetic stripe reader capability. |
keyedonly | Keyed entry only capability. |
The available values for Chase, First Data, LinkPoint, and YourPay are (required):
Value | Description |
StandAlone | Point-of-Sale Credit Card Terminal |
POS | Electronic Cash Register |
Unattended | Unattended Terminal (i.e. Gas Pump) |
Unspecified | Used for all other applications |
The current element is specified via the XPath configuration option.
This configuration option is read-only.
The current element is specified via the XPath configuration option.
This configuration option is read-only.
The current element is specified via the XPath configuration option.
This configuration option is read-only.
This configuration option is read-only.
'name' | A particular element name |
name[i] | The i-th subelement of the current element with the given name |
[i] | The i-th subelement of the current element |
[last()] | The last subelement of the current element |
[last()-i] | The subelement located at the last location minus i in the current element |
name[@attrname="attrvalue"] | The subelement containing a particular value for a given attribute (supports single AND double quotes). Not available for JSON responses. |
.. | The parent of the current element |
Example (Setting XPath for XML)
Document root | Charge.XPath = "/" |
Specific Element | Charge.XPath = "/root/SubElement1/SubElement2/" |
i-th Child | Charge.XPath = "/root/SubElement1[i]" |
Document root | Charge.XPath = "/" |
Specific Element | Charge.XPath = "/root/SubElement1/SubElement2/" |
i-th Child | Charge.XPath = "/root/SubElement1/[i]" |
This configuration option is read-only.
HTTP Config Settings
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.
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.
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 AuthScheme 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]".
The default value is False.
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 Redirect event is fired for every URL the product is redirected to. In the case of automatic redirections, the 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:
- 0 - Never
- 1 - Always
- 2 - Same Scheme
- "1.0"
- "1.1" (default)
- "2.0"
- "3.0"
When using HTTP/2 ("2.0") or HTTP/3 ("3.0"), additional restrictions apply. Please see the following notes for details.
HTTP/2 Notes
When 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 Notes
HTTP/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.
The format of the date value for IfModifiedSince is detailed in the HTTP specs. For example:
Sat, 29 Oct 2017 19:43:31 GMT.
The default value for KeepAlive is false.
0 (None) | No events are logged. |
1 (Info - default) | Informational events are logged. |
2 (Verbose) | Detailed data are logged. |
3 (Debug) | Debug data are logged. |
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).
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.
.NET
Http http = new Http();
http.Config("TransferredRequest=on");
http.PostData = "body";
http.Post("http://someserver.com");
Console.WriteLine(http.Config("TransferredRequest"));
C++
HTTP http;
http.Config("TransferredRequest=on");
http.SetPostData("body", 5);
http.Post("http://someserver.com");
printf("%s\r\n", http.Config("TransferredRequest"));
Note: Some servers (such as the ASP.NET Development Server) may not support chunked encoding.
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.
Note: This setting is applicable only to Mac/iOS editions.
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.
Override the default with the name and version of your software.
TCPClient Config Settings
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.
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
Note: This configuration setting is provided for use by classs that do not directly expose Firewall properties.
0 | No firewall (default setting). |
1 | Connect through a tunneling proxy. FirewallPort is set to 80. |
2 | Connect through a SOCKS4 Proxy. FirewallPort is set to 1080. |
3 | Connect through a SOCKS5 Proxy. FirewallPort is set to 1080. |
10 | Connect through a SOCKS4A Proxy. FirewallPort is set to 1080. |
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
Note: This value is not applicable in macOS.
Note: This configuration setting is only available in the Unix platform. It is not supported in masOS or FreeBSD.
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.
In multihomed 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 LocalHost 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 multihomed hosts (machines with more than one IP interface).
Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by LocalPort after the connection is established.
LocalPort cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error.
This configuration setting is useful when trying to connect to services that require a trusted port on the client side. An example is the remote shell (rsh) service in UNIX systems.
If an EOL string is found in the input stream before MaxLineLength bytes are received, the DataIn 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 DataIn 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.
www.google.com;www.nsoftware.com
Note: This value is not applicable in Java.
By default, this configuration setting is set to False.
0 | IPv4 only |
1 | IPv6 only |
2 | IPv6 with IPv4 fallback |
SSL Config Settings
When enabled, SSL packet logs are output using the SSLStatus event, which will fire each time an SSL packet is sent or received.
Enabling this configuration setting has no effect if SSLProvider is set to Platform.
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). OpenSSL recommends the use of the c_rehash utility to create the necessary links. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.
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 the following sequences:
-----BEGIN CERTIFICATE-----
... (CA certificate in base64 encoding) ...
-----END CERTIFICATE-----
Before, between, and after the certificate text is allowed, which can be used, for example, for descriptions of the certificates. Refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.
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".
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.
If set to True, the class will reuse the context if and only if the following criteria are met:
- The target host name is the same.
- The system cache entry has not expired (default timeout is 10 hours).
- The application process that calls the function is the same.
- The logon session is the same.
- The instance of the class is the same.
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 as follows:
/etc/ssl/ca-bundle.pem;/etc/pki/tls/certs/ca-bundle.crt;/etc/ssl/certs/ca-certificates.crt;/etc/pki/tls/cacert.pem
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert ... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
Note: This configuration setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the SSLStatus event.
Use this configuration 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 configuration setting.
The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert ... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
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 SSLProvider is set to Platform include the following:
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=CALG_AES_256");
obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES");
Possible values when SSLProvider is set to Platform include the following:
- CALG_3DES
- CALG_3DES_112
- CALG_AES
- CALG_AES_128
- CALG_AES_192
- CALG_AES_256
- CALG_AGREEDKEY_ANY
- CALG_CYLINK_MEK
- CALG_DES
- CALG_DESX
- CALG_DH_EPHEM
- CALG_DH_SF
- CALG_DSS_SIGN
- CALG_ECDH
- CALG_ECDH_EPHEM
- CALG_ECDSA
- CALG_ECMQV
- CALG_HASH_REPLACE_OWF
- CALG_HUGHES_MD5
- CALG_HMAC
- CALG_KEA_KEYX
- CALG_MAC
- CALG_MD2
- CALG_MD4
- CALG_MD5
- CALG_NO_SIGN
- CALG_OID_INFO_CNG_ONLY
- CALG_OID_INFO_PARAMETERS
- CALG_PCT1_MASTER
- CALG_RC2
- CALG_RC4
- CALG_RC5
- CALG_RSA_KEYX
- CALG_RSA_SIGN
- CALG_SCHANNEL_ENC_KEY
- CALG_SCHANNEL_MAC_KEY
- CALG_SCHANNEL_MASTER_HASH
- CALG_SEAL
- CALG_SHA
- CALG_SHA1
- CALG_SHA_256
- CALG_SHA_384
- CALG_SHA_512
- CALG_SKIPJACK
- CALG_SSL2_MASTER
- CALG_SSL3_MASTER
- CALG_SSL3_SHAMD5
- CALG_TEK
- CALG_TLS1_MASTER
- CALG_TLS1PRF
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_ECDH_RSA_WITH_AES_128_CBC_SHA");
Possible values when SSLProvider is set to Internal include the following:
- TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
- TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
- TLS_RSA_WITH_AES_256_GCM_SHA384
- TLS_RSA_WITH_AES_128_GCM_SHA256
- TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_DSS_WITH_AES_256_GCM_SHA384
- TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_DSS_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
- TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
- TLS_DHE_DSS_WITH_AES_256_CBC_SHA256
- TLS_RSA_WITH_AES_256_CBC_SHA256
- TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
- TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
- TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
- TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
- TLS_RSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
- TLS_DHE_DSS_WITH_AES_128_CBC_SHA256
- TLS_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
- TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
- TLS_DHE_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
- TLS_DHE_DSS_WITH_AES_256_CBC_SHA
- TLS_RSA_WITH_AES_128_CBC_SHA
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
- TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
- TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
- TLS_DHE_RSA_WITH_AES_128_CBC_SHA
- TLS_DHE_DSS_WITH_AES_128_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA
- TLS_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_RSA_WITH_DES_CBC_SHA
- TLS_DHE_RSA_WITH_DES_CBC_SHA
- TLS_DHE_DSS_WITH_DES_CBC_SHA
- TLS_RSA_WITH_RC4_128_MD5
- TLS_RSA_WITH_RC4_128_SHA
When TLS 1.3 is negotiated (see SSLEnabledProtocols), only the following cipher suites are supported:
- TLS_AES_256_GCM_SHA384
- TLS_CHACHA20_POLY1305_SHA256
- TLS_AES_128_GCM_SHA256
SSLEnabledCipherSuites is used together with SSLCipherStrength.
Not all supported protocols are enabled by default. The default value is 4032 for client components, and 3072 for server components. To specify a combination of enabled protocol versions set this config to the binary OR of one or more of the following values:
TLS1.3 | 12288 (Hex 3000) |
TLS1.2 | 3072 (Hex C00) (Default - Client and Server) |
TLS1.1 | 768 (Hex 300) (Default - Client) |
TLS1 | 192 (Hex C0) (Default - Client) |
SSL3 | 48 (Hex 30) |
SSL2 | 12 (Hex 0C) |
Note that only TLS 1.2 is enabled for server components that accept incoming connections. This adheres to industry standards to ensure a secure connection. Client components enable TLS 1.0, TLS 1.1, and TLS 1.2 by default and will negotiate the highest mutually supported version when connecting to a server, which should be TLS 1.2 in most cases.
SSLEnabledProtocols: Transport Layer Security (TLS) 1.3 Notes:
By default when TLS 1.3 is enabled, the class will use the internal TLS implementation when the SSLProvider is set to Automatic for all editions.
In editions that are designed to run on Windows, SSLProvider 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 supported only 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:
- The platform provider is available only on Windows 11/Windows Server 2022 and up.
- SSLEnabledCipherSuites and other similar SSL configuration settings are not supported.
- If SSLEnabledProtocols includes both TLS 1.3 and TLS 1.2, these restrictions are still applicable even if TLS 1.2 is negotiated. Enabling TLS 1.3 with the platform provider changes the implementation used for all TLS versions.
SSLEnabledProtocols: SSL2 and SSL3 Notes:
SSL 2.0 and 3.0 are not supported by the class when the SSLProvider is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and SSLProvider needs to be set to platform.
This configuration setting is applicable only when SSLProvider is set to Internal.
If set to True, all certificates returned by the server will be present in the Encoded parameter of the SSLServerAuthentication event. This includes the leaf certificate, any intermediate certificate, and the root certificate.
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 traffic for debugging purposes. When writing to this file, the class will only append, it will not overwrite previous values.
Note: This configuration setting is applicable only when SSLProvider is set to Internal.
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipher[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherStrength[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherSuite[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchange[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchangeStrength[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedVersion[connId]");
0x00000001 | Ignore time validity status of certificate. |
0x00000002 | Ignore time validity status of CTL. |
0x00000004 | Ignore non-nested certificate times. |
0x00000010 | Allow unknown certificate authority. |
0x00000020 | Ignore wrong certificate usage. |
0x00000100 | Ignore unknown certificate revocation status. |
0x00000200 | Ignore unknown CTL signer revocation status. |
0x00000400 | Ignore unknown certificate authority revocation status. |
0x00000800 | Ignore unknown root revocation status. |
0x00008000 | Allow test root certificate. |
0x00004000 | Trust test root certificate. |
0x80000000 | Ignore non-matching CN (certificate CN non-matching server name). |
This functionality is currently not available when the provider is OpenSSL.
The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
When specified the class will verify that the server certificate signature algorithm is among the values specified in this configuration 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:
component.SSLProvider = TCPClientSSLProviders.sslpInternal;
component.Config("SSLEnabledProtocols=3072"); //TLS 1.2
component.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa");
The default value for this configuration setting is sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-dsa.
To not restrict the server's certificate signature algorithm, specify an empty string as the value for this configuration setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent.
The default value is ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1.
When using TLS 1.2 and SSLProvider is set to Internal, the values refer to the supported groups for ECC. The following values are supported:
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1" (default)
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 configuration setting.
Note: All supported groups can always be used during the handshake even if not listed here, but if a group is used that is not present in this list, it will incur an additional roundtrip and time to generate the key share for that group.
In most cases, this configuration setting does not need to be modified. This should be modified only 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:
- "ecdhe_x25519" (default)
- "ecdhe_x448"
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1"
- "ffdhe_2048" (default)
- "ffdhe_3072" (default)
- "ffdhe_4096"
- "ffdhe_6144"
- "ffdhe_8192"
- "ed25519" (default)
- "ed448" (default)
- "ecdsa_secp256r1_sha256" (default)
- "ecdsa_secp384r1_sha384" (default)
- "ecdsa_secp521r1_sha512" (default)
- "rsa_pkcs1_sha256" (default)
- "rsa_pkcs1_sha384" (default)
- "rsa_pkcs1_sha512" (default)
- "rsa_pss_sha256" (default)
- "rsa_pss_sha384" (default)
- "rsa_pss_sha512" (default)
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:
- "ecdhe_x25519" (default)
- "ecdhe_x448" (default)
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1" (default)
- "ffdhe_2048" (default)
- "ffdhe_3072" (default)
- "ffdhe_4096" (default)
- "ffdhe_6144" (default)
- "ffdhe_8192" (default)
Socket Config Settings
Note: This option is not valid for User Datagram Protocol (UDP) ports.
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.
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
The following is a list of valid code page identifiers:
Identifier | Name |
037 | IBM EBCDIC - U.S./Canada |
437 | OEM - United States |
500 | IBM EBCDIC - International |
708 | Arabic - ASMO 708 |
709 | Arabic - ASMO 449+, BCON V4 |
710 | Arabic - Transparent Arabic |
720 | Arabic - Transparent ASMO |
737 | OEM - Greek (formerly 437G) |
775 | OEM - Baltic |
850 | OEM - Multilingual Latin I |
852 | OEM - Latin II |
855 | OEM - Cyrillic (primarily Russian) |
857 | OEM - Turkish |
858 | OEM - Multilingual Latin I + Euro symbol |
860 | OEM - Portuguese |
861 | OEM - Icelandic |
862 | OEM - Hebrew |
863 | OEM - Canadian-French |
864 | OEM - Arabic |
865 | OEM - Nordic |
866 | OEM - Russian |
869 | OEM - Modern Greek |
870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) |
874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) |
875 | IBM EBCDIC - Modern Greek |
932 | ANSI/OEM - Japanese, Shift-JIS |
936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) |
949 | ANSI/OEM - Korean (Unified Hangul Code) |
950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) |
1026 | IBM EBCDIC - Turkish (Latin-5) |
1047 | IBM EBCDIC - Latin 1/Open System |
1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) |
1141 | IBM EBCDIC - Germany (20273 + Euro symbol) |
1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) |
1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) |
1144 | IBM EBCDIC - Italy (20280 + Euro symbol) |
1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) |
1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) |
1147 | IBM EBCDIC - France (20297 + Euro symbol) |
1148 | IBM EBCDIC - International (500 + Euro symbol) |
1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) |
1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) |
1201 | Unicode UCS-2 Big-Endian |
1250 | ANSI - Central European |
1251 | ANSI - Cyrillic |
1252 | ANSI - Latin I |
1253 | ANSI - Greek |
1254 | ANSI - Turkish |
1255 | ANSI - Hebrew |
1256 | ANSI - Arabic |
1257 | ANSI - Baltic |
1258 | ANSI/OEM - Vietnamese |
1361 | Korean (Johab) |
10000 | MAC - Roman |
10001 | MAC - Japanese |
10002 | MAC - Traditional Chinese (Big5) |
10003 | MAC - Korean |
10004 | MAC - Arabic |
10005 | MAC - Hebrew |
10006 | MAC - Greek I |
10007 | MAC - Cyrillic |
10008 | MAC - Simplified Chinese (GB 2312) |
10010 | MAC - Romania |
10017 | MAC - Ukraine |
10021 | MAC - Thai |
10029 | MAC - Latin II |
10079 | MAC - Icelandic |
10081 | MAC - Turkish |
10082 | MAC - Croatia |
12000 | Unicode UCS-4 Little-Endian |
12001 | Unicode UCS-4 Big-Endian |
20000 | CNS - Taiwan |
20001 | TCA - Taiwan |
20002 | Eten - Taiwan |
20003 | IBM5550 - Taiwan |
20004 | TeleText - Taiwan |
20005 | Wang - Taiwan |
20105 | IA5 IRV International Alphabet No. 5 (7-bit) |
20106 | IA5 German (7-bit) |
20107 | IA5 Swedish (7-bit) |
20108 | IA5 Norwegian (7-bit) |
20127 | US-ASCII (7-bit) |
20261 | T.61 |
20269 | ISO 6937 Non-Spacing Accent |
20273 | IBM EBCDIC - Germany |
20277 | IBM EBCDIC - Denmark/Norway |
20278 | IBM EBCDIC - Finland/Sweden |
20280 | IBM EBCDIC - Italy |
20284 | IBM EBCDIC - Latin America/Spain |
20285 | IBM EBCDIC - United Kingdom |
20290 | IBM EBCDIC - Japanese Katakana Extended |
20297 | IBM EBCDIC - France |
20420 | IBM EBCDIC - Arabic |
20423 | IBM EBCDIC - Greek |
20424 | IBM EBCDIC - Hebrew |
20833 | IBM EBCDIC - Korean Extended |
20838 | IBM EBCDIC - Thai |
20866 | Russian - KOI8-R |
20871 | IBM EBCDIC - Icelandic |
20880 | IBM EBCDIC - Cyrillic (Russian) |
20905 | IBM EBCDIC - Turkish |
20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) |
20932 | JIS X 0208-1990 & 0121-1990 |
20936 | Simplified Chinese (GB2312) |
21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) |
21027 | Extended Alpha Lowercase |
21866 | Ukrainian (KOI8-U) |
28591 | ISO 8859-1 Latin I |
28592 | ISO 8859-2 Central Europe |
28593 | ISO 8859-3 Latin 3 |
28594 | ISO 8859-4 Baltic |
28595 | ISO 8859-5 Cyrillic |
28596 | ISO 8859-6 Arabic |
28597 | ISO 8859-7 Greek |
28598 | ISO 8859-8 Hebrew |
28599 | ISO 8859-9 Latin 5 |
28605 | ISO 8859-15 Latin 9 |
29001 | Europa 3 |
38598 | ISO 8859-8 Hebrew |
50220 | ISO 2022 Japanese with no halfwidth Katakana |
50221 | ISO 2022 Japanese with halfwidth Katakana |
50222 | ISO 2022 Japanese JIS X 0201-1989 |
50225 | ISO 2022 Korean |
50227 | ISO 2022 Simplified Chinese |
50229 | ISO 2022 Traditional Chinese |
50930 | Japanese (Katakana) Extended |
50931 | US/Canada and Japanese |
50933 | Korean Extended and Korean |
50935 | Simplified Chinese Extended and Simplified Chinese |
50936 | Simplified Chinese |
50937 | US/Canada and Traditional Chinese |
50939 | Japanese (Latin) Extended and Japanese |
51932 | EUC - Japanese |
51936 | EUC - Simplified Chinese |
51949 | EUC - Korean |
51950 | EUC - Traditional Chinese |
52936 | HZ-GB2312 Simplified Chinese |
54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) |
57002 | ISCII Devanagari |
57003 | ISCII Bengali |
57004 | ISCII Tamil |
57005 | ISCII Telugu |
57006 | ISCII Assamese |
57007 | ISCII Oriya |
57008 | ISCII Kannada |
57009 | ISCII Malayalam |
57010 | ISCII Gujarati |
57011 | ISCII Punjabi |
65000 | Unicode UTF-7 |
65001 | Unicode UTF-8 |
Identifier | Name |
1 | ASCII |
2 | NEXTSTEP |
3 | JapaneseEUC |
4 | UTF8 |
5 | ISOLatin1 |
6 | Symbol |
7 | NonLossyASCII |
8 | ShiftJIS |
9 | ISOLatin2 |
10 | Unicode |
11 | WindowsCP1251 |
12 | WindowsCP1252 |
13 | WindowsCP1253 |
14 | WindowsCP1254 |
15 | WindowsCP1250 |
21 | ISO2022JP |
30 | MacOSRoman |
10 | UTF16String |
0x90000100 | UTF16BigEndian |
0x94000100 | UTF16LittleEndian |
0x8c000100 | UTF32String |
0x98000100 | UTF32BigEndian |
0x9c000100 | UTF32LittleEndian |
65536 | Proprietary |
- Product: The product the license is for.
- Product Key: The key the license was generated from.
- License Source: Where the license was found (e.g., RuntimeLicense, License File).
- License Type: The type of license installed (e.g., Royalty Free, Single Server).
- Last Valid Build: The last valid build number for which the license will work.
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.
Setting this configuration 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.
Trappable Errors (RecurringBilling Class)
Error Handling (C++)
Call the GetLastErrorCode() method to obtain the last called method's result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
RecurringBilling 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 |
The class may also return one of the following error codes, which are inherited from other classes.
HTTP Errors
118 | Firewall error. The error description contains the 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 URLScheme is invalid. |
155 | Range operation is not supported by server. |
156 | Invalid cookie index (out of range). |
301 | Interrupted. |
302 | Cannot open AttachedFile. |
The class may also return one of the following error codes, which are inherited from other classes.
TCPClient Errors
100 | You cannot change the RemotePort at this time. A connection is in progress. |
101 | You cannot change the RemoteHost (Server) at this time. A connection is in progress. |
102 | The RemoteHost 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 LocalPort at this time. A connection is in progress. |
107 | You cannot change the LocalHost at this time. A connection is in progress. |
112 | You cannot change MaxLineLength at this time. A connection is in progress. |
116 | RemotePort 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 nonsocket. |
10039 | [10039] Destination address required. |
10040 | [10040] Message is too long. |
10041 | [10041] Protocol wrong type for socket. |
10042 | [10042] Bad protocol option. |
10043 | [10043] Protocol is not supported. |
10044 | [10044] Socket type is not supported. |
10045 | [10045] Operation is not supported on socket. |
10046 | [10046] Protocol family is not supported. |
10047 | [10047] Address family is not supported by protocol family. |
10048 | [10048] Address already in use. |
10049 | [10049] Cannot 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] Cannot send after socket shutdown. |
10059 | [10059] Too many references, cannot splice. |
10060 | [10060] Connection timed out. |
10061 | [10061] Connection refused. |
10062 | [10062] Too many levels of symbolic links. |
10063 | [10063] File name is too long. |
10064 | [10064] Host is down. |
10065 | [10065] No route to host. |
10066 | [10066] Directory is 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 is not loaded yet. |
11001 | [11001] Host not found. |
11002 | [11002] Nonauthoritative 'Host not found' (try again or check DNS setup). |
11003 | [11003] Nonrecoverable errors: FORMERR, REFUSED, NOTIMP. |
11004 | [11004] Valid name, no data record (check DNS setup). |