E-Payment Integrator 2020 .NET Edition

Questions / Feedback?

RecurringBilling Component

Properties   Methods   Events   Configuration Settings   Errors  

The RecurringBilling component is used to authorize and set up recurring transactions with any of the supported Internet Payment Gateways.




The RecurringBilling component allows you to use multiple Internet Payment Gateways through one interface and one component. 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 component 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 component'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 component, 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 component.

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 component:

GatewayHome 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 component with short descriptions. Click on the links for further details.

CardContains the customer's credit card information.
CustomerContains the customer's name, address, and other identifying information.
ECheckBankBank account and routing information for an electronic check transaction.
ECheckPaymentTypeThe type of check payment request (commonly referred to as SEC Code).
GatewayGateway to process transactions with.
GatewayURLDefault URL for a specific Gateway .
InvoiceNumberMerchant-generated invoice number.
MerchantLoginMerchant's Gateway login.
MerchantPasswordMerchant's Gateway password.
PaymentScheduleThis property is used to specify the payment schedule for a recurring billing.
ProxyA set of properties related to proxy access.
ResponseContains the response to the recurring transaction.
ShippingInfoContains the customer's shipping name, address, and other identifying information.
SpecialFieldsA list of additional fields to send in the request.
SSLAcceptServerCertInstructs the component to unconditionally accept the server certificate that matches the supplied certificate.
SSLCertThe certificate to be used during SSL negotiation.
SSLServerCertThe server certificate for the last established connection.
SubscriptionDescDescription of recurring subscription.
SubscriptionDetailsContains the recurring subscription details.
SubscriptionNameThe name of the recurring subscription or profile.
TestModeTurns test mode on and off for transactions sent to the current Gateway .
TimeoutA timeout for the component.
TransactionIdMerchant-generated transaction Id used for all transactions.

Method List

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

AddSpecialFieldAdds a special field name and the corresponding value.
CancelSubscriptionCancels or deletes a recurring payment subscription.
ConfigSets or retrieves a configuration setting.
CreateSubscriptionCreates a new recurring subscription.
DoEventsProcesses events from the internal message queue.
GetResponseVarParses additional information out of the response.
GetSubscriptionStatusRetrieves the status of a recurring payment subscription.
InterruptInterrupts the current action.
ResetSpecialFieldsResets all special fields to the default settings.
UpdateSubscriptionUpdates a recurring payment subscription.

Event List

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

ErrorInformation about errors during data delivery.
SSLServerAuthenticationFired after the server presents its certificate to the client.
SSLStatusShows the progress of the secure connection.

Configuration Settings

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

3DSECIElectronic Commerce Indicator.
AmountFormatUsed to set the input format for TransactionAmount.
AuthNetCIMGuestProfileSpecifies whether a profile is a guest profile or a normal profile.
AuthNetCIMMaskedCardNumberThe masked card number returned for the payment profile at the specified index.
AuthNetCIMPaymentProfileCountThe number of Payment Profiles assigned to a customer profile within the Authorize.NET CIM gateway.
AuthNetCIMPaymentProfileIdThe Payment Profile ID assigned by Authorize.NET CIM gateway.
AuthNetCIMPaymentProfileIndexParses the Payment Profile contained at the specified index within a GetSusbcriptionStatus response.
AuthNetCIMRequestTypeThe request type to send for the Authorize.NET CIM gateway.
AuthNetCIMShippingAddressCountThe number of Shipping Addresses assigned to a customer profile within the Authorize.NET CIM gateway.
AuthNetCIMShippingAddressIdThe Shipping Address ID assigned by Authorize.NET CIM gateway.
AuthNetCIMShippingAddressIndexParses the Shipping Address contained at the specified index within a GetSusbcriptionStatus response.
AuthNetGetSubscriptionDetailsSpecifies whether a call to GetSubscriptionStatus will return the details of the subscription or just the status.
AuthNetOpaqueDescriptorAn Authorize.Net opaque data descriptor.
AuthNetOpaqueValueAn Authorize.Net opaque data value.
AuthNetShipToCompanyThe name of the company associated with the customer's shipping address.
BamboraUsernameThe Username used for authentication with the Bambora gateway.
BASYSCardInfoKeyBASYS Gateway Credit Card Info Key.
BASYSCheckInfoKeyBASYS Gateway Check Info Key.
BASYSContractIDBASYS Gateway Contract ID.
BASYSContractKeyBASYS Gateway Contract Key.
BASYSCustomerKeyBASYS Gateway Customer Key.
BASYSCustomerStatusIndicates the Customer Status.
BASYSNextBillingDateBASYS Gateway Next Billing Date.
BASYSNumberOfDaysNumber of days to be added to the next billing date.
BASYSPaymentTypeIndicates the Payment Type.
BASYSRequestTypeThe request type for the BASYS gateway.
BASYSTokenBASYS Gateway Token Value.
BASYSTokenModeIndicates the Token Type.
BlueSnapCardCountHow many card payment sources the last retrieved vaulted shopper has.
BlueSnapCardIndexDetermines which card payment source the component's fields are populated for currently.
BlueSnapEnterpriseUdfsUser-Defined Fields (UDFs) to send when updating a BlueSnap vaulted shopper.
BlueSnapGetTokenRetrieves a new hosted payment fields token (pfToken) from BlueSnap.
BlueSnapRequestTypeThe request type for the BlueSnap gateway.
BlueSnapVaultedShopperIdBlueSnap gateway vaulted shopper ID.
CardIssueNumberSpecial Issue Number used for Switch and Solo cards.
CardLast4DigitsThe last 4 digits of a credit card.
CardPresentSpecifies whether the card is present during the transaction.
CardStartMonthUsed for some international cards.
CardStartYearUsed for some international cards.
CardTokenThe credit card token.
CardTypeType of credit card being used in this transaction.
CheckNumberCheck Number.
CheckRoutingNumberDetermines whether to perform a checksum test on the RoutingNumber.
COFPermissionIndicates if the customer gave permission to make a Card On File transaction.
CompanyNameThe Customer's Company Name.
ConvenienceFeeThe total convenience fee charged for a transaction.
CustomerPasswordThe Customer's Password.
CustomerUsernameThe Customer's Username.
CyberSourceDeleteSubscriptionWhether subscriptions should be deleted when CancelSubscription is called.
CyberSourceXMLEscapeDetermines whether to XML escape the CyberSource gateway request field values.
DateFormatThe format of the date properties.
EscapeXMLAutomatically escape data within XML tags.
EwayCustomerIdThe Customer Id used to authenticate with the Eway gateway.
EwayInitialDateThe date of the initial payment for the Eway gateway.
EwayTransactionTypeThe Transaction Type for the Eway gateway.
FirstDataPayPointAgreedToTermsSpecifies whether the customer has approved the registration process and agreed to the terms for the FirstDataPayPoint gateway.
FirstDataPayPointTransactionTypeThe Transaction Type for the FirstDataPayPoint gateway.
HashAlgorithmAlgorithm used for hashing.
HashSecretSecurity key used to generate a hash for gateways supporting such functionality.
LicenseDOBCustomer's Date of Birth as indicated on his drivers license.
LicenseNumberCustomer's driver's license number.
LicenseStateState in which customer's driver's license was issued.
LitleCardholderIdDescribes the method used to identify the cardholder at the point of sale for the Litle gateway.
LitleSubscriptionAggregateUsed to specify an XML aggregate for Subscription Create and Update transactions within the Litle gateway.
LitleTransactionTypeThe Transaction Type for the Litle gateway.
LitleTrialFrequencyUsed to specify a trial frequency for the Litle gateway.
MerchantCodeA gateway-supplied merchant number, code, or Id.
MerchantPartnersLast4DigitsThe last 4 digits of the account number for a transaction processed via the MerchantPartners or WorldPay Link gateways.
MerchantPartnersReaderTypeThe reader type used to read and encrypt a swiped card for the MerchantPartners or WorldPay Link gateways.
MITFlagFor the MIT framework - Used to indicate that a transaction is merchant initiated.
MITPriorTransIdFor the MIT framework - Used to specify a prior transaction id to be referenced in a merchant initiated transaction.
MITTypeFor the MIT framework - Indicates the type of transaction being requested in a Merchant-Initiated Transaction (MIT).
MyVirtualMerchantUserIdThe MyVirtualMerchant user Id as configured on VirtualMerchant.
NetBillingVersionThe Version to be sent in the User-Agent heading of a NetBilling gateway request.
NuveiPermittedTerminalsA list of the terminals permitted to use a Nuvei secure card.
OmniFundTransactionTypeThe Transaction Type for the OmniFund gateway.
OrbitalConnectionPasswordOrbital Connection Password field used by the Orbital gateway.
OrbitalConnectionUsernameOrbital Connection Username field used by the Orbital gateway.
OrbitalCustomerProfileFromOrderIndCustomer Profile Number generation Options for the Orbital gateway.
OrbitalCustomerProfileOrderOverrideIndIndicator to specify how the CustomerId is leveraged to populate other data sets for the Orbital gateway.
PayerIPThe IP address of the payer.
PaymentWorkSuiteClientCodeThe 3DSI assigned client code sent in a request to the PaymentWorksuite gateway.
PaymentWorkSuiteLocationCodeThe 3DSI assigned location code sent in a request to the PaymentWorksuite gateway.
PaymentWorkSuiteMerchantCodeThe 3DSI assigned merchant code sent in a request to the PaymentWorksuite gateway.
PaymentWorkSuiteTransactionTypeThe transaction type to send for the Payment WorkSuite gateway.
PayTraceIntegratorIdUsed to specify the Integrator Id value assigned by the PayTrace gateway.
PayTraceTransactionTypeThe Transaction Type for the PayTrace gateway.
PayWiserCardTokenPayWiser Gateway Card Token Value.
PayWiserPaymentHourPayment hour.
PayWiserPlanPatternPayWiser plan pattern for creating a recurring plan.
PayWiserRecurringPlanIdPayWiser Recurring Plan Id.
PayWiserRequestTypeThe request type for the PayWiser gateway.
PayWiserRetryPatternPayWiser retry pattern for retrying failed payments.
PayWiserTokenReferenceIdPayWiser Gateway Token Reference Id.
PhoeniXGateCardInfoKeyPhoeniXGate Gateway Credit Card Info Key.
PhoeniXGateCheckInfoKeyPhoeniXGate Gateway Check Info Key.
PhoeniXGateContractIDPhoeniXGate Gateway Contract ID.
PhoeniXGateContractKeyPhoeniXGate Gateway Contract Key.
PhoeniXGateCustomerKeyPhoeniXGate Gateway Customer Key.
PhoeniXGateCustomerStatusIndicates the Customer Status.
PhoeniXGateNextBillingDatePhoeniXGate Gateway Next Billing Date.
PhoeniXGateNumberOfDaysNumber of days to be added to the next billing date.
PhoeniXGatePaymentTypeIndicates the Payment Type.
PhoeniXGateRequestTypeThe request type for the PhoeniXGate gateway.
PhoeniXGateTokenPhoeniXGate Gateway Token Value.
PhoeniXGateTokenModeIndicates the Token Type.
PlanetPaymentFrequencyDateThe date of the month that a recurring payment should occur for the Planet Payment gateway.
PlanetPaymentFrequencyDayThe day that a recurring payment should occur for the Planet Payment gateway.
PlanetPaymentFrequencyMonthThe month that a recurring payment should occur for the Planet Payment gateway.
QBMSTransactionTypeThe Transaction Type for the QBMS gateway.
RawRequestReturns the data that was sent to the gateway.
RawResponseReturns the data that was received from the gateway.
RepayCardInfoKeyRepay Gateway Credit Card Info Key.
RepayCheckInfoKeyRepay Gateway Check Info Key.
RepayContractIDRepay Gateway Contract ID.
RepayContractKeyRepay Gateway Contract Key.
RepayCustomerKeyRepay Gateway Customer Key.
RepayCustomerStatusIndicates the Customer Status.
RepayNextBillingDateRepay Gateway Next Billing Date.
RepayNumberOfDaysNumber of days to be added to the next billing date.
RepayPaymentTypeIndicates the Payment Type.
RepayRequestTypeThe request type for the Repay gateway.
RepayTokenRepay Gateway Token Value.
RepayTokenModeIndicates the Token Type.
SkipJackStatusIndexGets subscription details at the specified status index.
SquareCustomerCardCountThe number of cards saved to the Square customer profile.
SquareCustomerCardIdThe Id of a card saved to a Square customer profile.
SquareCustomerCardIndexWhich card's details to populate the component with from the retreived Square customer profile.
SquareRequestTypeWhat type of Square customer data to create or delete.
StoreCardOnFileFor the Stored Credentials framework - Used to indicate that the merchant will be storing the customer's card on file (COF).
TaxIdCompany's Tax Id or a Customer's Social Security Number.
TerminalCapabilityThe capability of the terminal that is used to submit the transaction.
TerminalIdTerminal Id value sent in the transaction.
TerminalTypeThe terminal type that is used to submit the transaction.
UseCardOnFileFor the Stored Credentials framework - Used to indicate that the merchant is using stored card on file (COF) information for the request.
XChildrenCountThe 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.
XElementThe name of the current element.
XPathProvides a way to point to a specific element in the returned XML or JSON response.
XTextThe text of the current element.
AcceptEncodingUsed to tell the server which types of content encodings the client supports.
AllowHTTPCompressionThis property enables HTTP compression for receiving data.
AllowHTTPFallbackWhether HTTP/2 connections are permitted to fallback to HTTP/1.1.
AllowNTLMFallbackWhether to allow fallback from Negotiate to NTLM when authenticating.
AppendWhether to append data to LocalFile.
AuthorizationThe Authorization string to be sent to the server.
BytesTransferredContains the number of bytes transferred in the response data.
ChunkSizeSpecifies the chunk size in bytes when using chunked encoding.
CompressHTTPRequestSet to true to compress the body of a PUT or POST request.
EncodeURLIf set to true the URL will be encoded by the component.
FollowRedirectsDetermines what happens when the server issues a redirect.
GetOn302RedirectIf set to true the component will perform a GET on the new location.
HTTP2HeadersWithoutIndexingHTTP2 headers that should not update the dynamic header table with incremental indexing.
HTTPVersionThe version of HTTP used by the component.
IfModifiedSinceA date determining the maximum age of the desired document.
KeepAliveDetermines whether the HTTP connection is closed after completion of the request.
KerberosSPNThe Service Principal Name for the Kerberos Domain Controller.
LogLevelThe level of detail that is logged.
MaxHeadersInstructs component to save the amount of headers specified that are returned by the server after a Header event has been fired.
MaxHTTPCookiesInstructs component to save the amount of cookies specified that are returned by the server when a SetCookie event is fired.
MaxRedirectAttemptsLimits the number of redirects that are followed in a request.
NegotiatedHTTPVersionThe negotiated HTTP version.
OtherHeadersOther headers as determined by the user (optional).
ProxyAuthorizationThe authorization string to be sent to the proxy server.
ProxyAuthSchemeThe authorization scheme to be used for the proxy.
ProxyPasswordA password if authentication is to be used for the proxy.
ProxyPortPort for the proxy server (default 80).
ProxyServerName or IP address of a proxy server (optional).
ProxyUserA user name if authentication is to be used for the proxy.
SentHeadersThe full set of headers as sent by the client.
StatusLineThe first line of the last response from the server.
TransferredDataThe contents of the last response from the server.
TransferredDataLimitThe maximum number of incoming bytes to be stored by the component.
TransferredHeadersThe full set of headers as received from the server.
TransferredRequestThe full request as sent by the client.
UseChunkedEncodingEnables or Disables HTTP chunked encoding for transfers.
UseIDNsWhether to encode hostnames to internationalized domain names.
UsePlatformDeflateWhether to use the platform implementation to decompress compressed responses.
UsePlatformHTTPClientWhether or not to use the platform HTTP client.
UserAgentInformation about the user agent (browser).
CloseStreamAfterTransferIf true, the component will close the upload or download stream after the transfer.
ConnectionTimeoutSets a separate timeout value for establishing a connection.
FirewallAutoDetectTells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallHostName or IP address of firewall (optional).
FirewallListenerIf true, the component binds to a SOCKS firewall as a server (IPPort only).
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall.
FirewallPortThe TCP port for the FirewallHost;.
FirewallTypeDetermines the type of firewall to connect through.
FirewallUserA user name if authentication is to be used connecting through a firewall.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
LingerWhen set to True, connections are terminated gracefully.
LingerTimeTime in seconds to have the connection linger.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe port in the local host where the component binds.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
MaxTransferRateThe transfer rate limit in bytes per second.
ProxyExceptionsListA semicolon separated list of hosts and IPs to bypass when using a proxy.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
TcpNoDelayWhether or not to delay when sending packets.
UseIPv6Whether to use IPv6.
UseNTLMv2Whether to use NTLM V2.
CACertFilePathsThe paths to CA certificate files when using Mono on Unix/Linux.
LogSSLPacketsControls whether SSL packets are logged when using the internal security API.
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCACertsA newline separated list of CA certificate to use during SSL client authentication.
SSLCheckCRLWhether to check the Certificate Revocation List for the server certificate.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledCipherSuitesThe cipher suite to be used in an SSL negotiation.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLEnableRenegotiationWhether the renegotiation_info SSL extension is supported.
SSLIncludeCertChainWhether the entire certificate chain is included in the SSLServerAuthentication event.
SSLNegotiatedCipherReturns the negotiated ciphersuite.
SSLNegotiatedCipherStrengthReturns the negotiated ciphersuite strength.
SSLNegotiatedCipherSuiteReturns the negotiated ciphersuite.
SSLNegotiatedKeyExchangeReturns the negotiated key exchange algorithm.
SSLNegotiatedKeyExchangeStrengthReturns the negotiated key exchange algorithm strength.
SSLNegotiatedProtocolReturns the negotiated protocol version.
SSLProviderThe name of the security provider to use.
SSLSecurityFlagsFlags that control certificate verification.
SSLServerCACertsA newline separated list of CA certificate to use during SSL server certificate validation.
TLS12SignatureAlgorithmsDefines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True.
TLS12SupportedGroupsThe supported groups for ECC.
TLS13KeyShareGroupsThe groups for which to pregenerate key shares.
TLS13SignatureAlgorithmsThe allowed certificate signature algorithms.
TLS13SupportedGroupsThe supported groups for (EC)DHE key exchange.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
BuildInfoInformation about the product's build.
GUIAvailableTells the component whether or not a message loop is available for processing events.
LicenseInfoInformation about the current license.
UseInternalSecurityAPITells the component whether or not to use the system security libraries or an internal implementation.

Copyright (c) 2022 4D Payments Inc. - All rights reserved.
E-Payment Integrator 2020 .NET Edition - Version 20.0 [Build 8153]