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.

Class Name

InPay_RecurringBilling

Procedural Interface

 inpay_recurringbilling_open();
 inpay_recurringbilling_close($res);
 inpay_recurringbilling_register_callback($res, $id, $function);
 inpay_recurringbilling_get_last_error($res);
 inpay_recurringbilling_get_last_error_code($res);
 inpay_recurringbilling_set($res, $id, $index, $value);
 inpay_recurringbilling_get($res, $id, $index);
 inpay_recurringbilling_do_addspecialfield($res, $name, $value);
 inpay_recurringbilling_do_cancelsubscription($res, $subscriptionid);
 inpay_recurringbilling_do_config($res, $configurationstring);
 inpay_recurringbilling_do_createsubscription($res);
 inpay_recurringbilling_do_doevents($res);
 inpay_recurringbilling_do_getresponsevar($res, $name);
 inpay_recurringbilling_do_getsubscriptionstatus($res, $subscriptionid);
 inpay_recurringbilling_do_interrupt($res);
 inpay_recurringbilling_do_resetspecialfields($res);
 inpay_recurringbilling_do_updatesubscription($res, $subscriptionid);

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 CustomerAddress, CustomerFirstName, CustomerLastName, 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:

Property List

---

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

Method List

---

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

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.

Config Settings

---

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

CardType Property (InPay_RecurringBilling Class)

Type of credit card being used in this transaction.

Object Oriented Interface

public function getCardType();
public function setCardType($value);

Procedural Interface

inpay_recurringbilling_get($res, 1 );
inpay_recurringbilling_set($res, 1, $value );

Default Value

0

Remarks

Type of credit card being used in this transaction. This property contains the customer's credit card type. This is automatically computed after the CardNumber is set, but it can also be changed manually. A list of valid card types is included below.

This property is not available at design time.

Data Type

Integer

CardCVVData Property (InPay_RecurringBilling Class)

Three digit security code on back of card (optional).

Object Oriented Interface

public function getCardCVVData();
public function setCardCVVData($value);

Procedural Interface

inpay_recurringbilling_get($res, 2 );
inpay_recurringbilling_set($res, 2, $value );

Default Value

''

Remarks

Three digit security code on back of card (optional).

This alphanumeric property contains the three digit Visa "Card Verification Value" (CVV), MasterCard "Card Verification Code" (CVC), or four-digit American Express "Card Identification Number" (CID). This value appears as additional characters embossed on the card signature line following the credit card account number on the back of the credit card. This is an optional property which can be used to determine if the customer is actually in possession of the credit card.

Even if the CardCVVData is incorrect, the transaction may still be authorized. It is up to the merchant to examine the ResponseCVVResult property and decide whether to honor the transaction or not.

Note: When set to a non-empty value, CardCVVPresence will be automatically set to cvpProvided. If set to empty string (""), CardCVVPresence will be automatically set to cvpNotProvided.

This property is not available at design time.

Data Type

String

CardCVVPresence Property (InPay_RecurringBilling Class)

Indicates the presence of the card verification value.

Object Oriented Interface

public function getCardCVVPresence();
public function setCardCVVPresence($value);

Procedural Interface

inpay_recurringbilling_get($res, 3 );
inpay_recurringbilling_set($res, 3, $value );

Default Value

0

Remarks

Indicates the presence of the card verification value.

This property is used to indicate the presence of CardCVVData.

The class will automatically set this value to cvpProvided when a CardCVVData value is specified. You can explicitly specify the CardCVVPresence indicator by setting this property.

Available values are:

• cvpNotProvided (0)
• cvpProvided (1)
• cvpIllegible (2)
• cvpNotOnCard (3)

This property is not available at design time.

Data Type

Integer

CardEntryDataSource Property (InPay_RecurringBilling Class)

This property contains a 1-character code identifying the source of the customer data.

Object Oriented Interface

public function getCardEntryDataSource();
public function setCardEntryDataSource($value);

Procedural Interface

inpay_recurringbilling_get($res, 4 );
inpay_recurringbilling_set($res, 4, $value );

Default Value

0

Remarks

This property contains a 1-character code identifying the source of the customer data. The table below shows all supported values for this property.

This property is not available at design time.

Data Type

Integer

CardExpMonth Property (InPay_RecurringBilling Class)

Expiration month of the credit card specified in Number .

Object Oriented Interface

public function getCardExpMonth();
public function setCardExpMonth($value);

Procedural Interface

inpay_recurringbilling_get($res, 5 );
inpay_recurringbilling_set($res, 5, $value );

Default Value

1

Remarks

Expiration month of the credit card specified in CardNumber.

This property contains the expiration date of the customer's credit card, and must be in the range 1 - 12.

This property is not available at design time.

Data Type

Integer

CardExpYear Property (InPay_RecurringBilling Class)

Expiration year of the credit card specified in Number .

Object Oriented Interface

public function getCardExpYear();
public function setCardExpYear($value);

Procedural Interface

inpay_recurringbilling_get($res, 6 );
inpay_recurringbilling_set($res, 6, $value );

Default Value

2000

Remarks

Expiration year of the credit card specified in CardNumber.

This property contains the expiration date of the customer's credit card. This property must be in the range 0 - 99, or 2000 - 2099. Any date before the year 2000 or after 2099 cannot be specified.

This property is not available at design time.

Data Type

Integer

CardIsEncrypted Property (InPay_RecurringBilling Class)

Determines whether data set to the Number or MagneticStripe properties is validated.

Object Oriented Interface

public function getCardIsEncrypted();
public function setCardIsEncrypted($value);

Procedural Interface

inpay_recurringbilling_get($res, 7 );
inpay_recurringbilling_set($res, 7, $value );

Default Value

false

Remarks

Determines whether data set to the CardNumber or CardMagneticStripe fields is validated.

By default, when the CardNumber or CardMagneticStripe fields are set, the value will be validated and normalized. For instance, "4444-33332222 1111" will be normalized as "4444333322221111" and CardMagneticStripe data will be parsed for the track specified by CardEntryDataSource. 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 CardNumber or CardMagneticStripe 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.

This property is not available at design time.

Data Type

Boolean

CardMagneticStripe Property (InPay_RecurringBilling Class)

Track data read off of the card's magnetic stripe.

Object Oriented Interface

public function getCardMagneticStripe();
public function setCardMagneticStripe($value);

Procedural Interface

inpay_recurringbilling_get($res, 8 );
inpay_recurringbilling_set($res, 8, $value );

Default Value

''

Remarks

Track data read off of the card's magnetic stripe.

If CardEntryDataSource is not one of the manually entered enumerations, then this property 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 property with track 1 or track 2 data, and may not pass both. Use the CardEntryDataSource property to indicate which track you are sending.

The following example shows how to set the CardMagneticStripe and CardEntryDataSource properties 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.

This property is not available at design time.

Data Type

String

CardNumber Property (InPay_RecurringBilling Class)

Customer's credit card number for the transaction.

Object Oriented Interface

public function getCardNumber();
public function setCardNumber($value);

Procedural Interface

inpay_recurringbilling_get($res, 9 );
inpay_recurringbilling_set($res, 9, $value );

Default Value

''

Remarks

Customer's credit card number for the transaction.

If you're sending the transaction with CardMagneticStripe data, this property should be left empty.

This property is not available at design time.

Data Type

String

CustomerAddress Property (InPay_RecurringBilling Class)

Customer's street address.

Object Oriented Interface

public function getCustomerAddress();
public function setCustomerAddress($value);

Procedural Interface

inpay_recurringbilling_get($res, 10 );
inpay_recurringbilling_set($res, 10, $value );

Default Value

''

Remarks

Customer's street address. This property is used as part of the Address Verification Service (AVS) and contains the customer's street address as it appears on their monthly statement. Only the street number, street name, and apartment number are required in This property. City, state, and zip code are set in the CustomerCity, CustomerState, and CustomerZip properties.

The length of this property varies by gateway. If the customer's address is very long, it is admissible to include only the street number in This property.

NOTE: For the Moneris gateway, this property should contain only the customer's street number. The street name should be added via the AddSpecialField method. For example:

class.CustomerAddress = "123" class.AddSpecialField("avs_street_name", "Nowhere Ln")

This property is not available at design time.

Data Type

String

CustomerAddress2 Property (InPay_RecurringBilling Class)

A specific detail on the customer's shipping address (such as building, suite, apartment, floor number etc.

Object Oriented Interface

public function getCustomerAddress2();
public function setCustomerAddress2($value);

Procedural Interface

inpay_recurringbilling_get($res, 11 );
inpay_recurringbilling_set($res, 11, $value );

Default Value

''

Remarks

A specific detail on the customer's shipping address (such as building, suite, apartment, floor number etc.).

This property is not available at design time.

Data Type

String

CustomerAggregate Property (InPay_RecurringBilling Class)

This property allows you to get or set an XML aggregate built from all of the Customer properties.

Object Oriented Interface

public function getCustomerAggregate();
public function setCustomerAggregate($value);

Procedural Interface

inpay_recurringbilling_get($res, 12 );
inpay_recurringbilling_set($res, 12, $value );

Default Value

''

Remarks

This property allows you to get or set an XML aggregate built from all of the Customer properties. "EPCustomer" is the root element. The Customer properties make up the tags under the root, but without the beginning "Customer". For instance: <EPCustomer> <Address>123 Nowhere Ln.</Address> <Address2>Apt 3B.</Address2> <City>Beverly Hills</City> ... </EPCustomer>

This property is not available at design time.

Data Type

String

CustomerCity Property (InPay_RecurringBilling Class)

Customer's city.

Object Oriented Interface

public function getCustomerCity();
public function setCustomerCity($value);

Procedural Interface

inpay_recurringbilling_get($res, 13 );
inpay_recurringbilling_set($res, 13, $value );

Default Value

''

Remarks

Customer's city. This property is used as part of the Address Verification Service (AVS) and contains the customer's city as it appears on their monthly statement. Other AVS properties include CustomerAddress, CustomerState, and CustomerZip.

This property is not available at design time.

Data Type

String

CustomerCountry Property (InPay_RecurringBilling Class)

Customer's country.

Object Oriented Interface

public function getCustomerCountry();
public function setCustomerCountry($value);

Procedural Interface

inpay_recurringbilling_get($res, 14 );
inpay_recurringbilling_set($res, 14, $value );

Default Value

''

Remarks

Customer's country. This property contains the country in which the customer is located. Most gateways use a two-letter country code, specified in ISO-3166.

Note: If using this property with the PayFuse gateway, this property should contain the ISO-3166 numeric code instead of the standard two-letter code. For example, the ISO code for the US is "840".

This property is not available at design time.

Data Type

String

CustomerEmail Property (InPay_RecurringBilling Class)

Customer's email address.

Object Oriented Interface

public function getCustomerEmail();
public function setCustomerEmail($value);

Procedural Interface

inpay_recurringbilling_get($res, 15 );
inpay_recurringbilling_set($res, 15, $value );

Default Value

''

Remarks

Customer's email address. This optional property contains the customer's email address.

This property is not available at design time.

Data Type

String

CustomerFax Property (InPay_RecurringBilling Class)

Customer's fax number.

Object Oriented Interface

public function getCustomerFax();
public function setCustomerFax($value);

Procedural Interface

inpay_recurringbilling_get($res, 16 );
inpay_recurringbilling_set($res, 16, $value );

Default Value

''

Remarks

Customer's fax number. This optional property contains the customer's fax number.

This property is not available at design time.

Data Type

String

CustomerFirstName Property (InPay_RecurringBilling Class)

Customer's first name.

Object Oriented Interface

public function getCustomerFirstName();
public function setCustomerFirstName($value);

Procedural Interface

inpay_recurringbilling_get($res, 17 );
inpay_recurringbilling_set($res, 17, $value );

Default Value

''

Remarks

Customer's first name. This property contains the customer's first name.

This property is not available at design time.

Data Type

String

CustomerFullName Property (InPay_RecurringBilling Class)

Customer's full name.

Object Oriented Interface

public function getCustomerFullName();
public function setCustomerFullName($value);

Procedural Interface

inpay_recurringbilling_get($res, 18 );
inpay_recurringbilling_set($res, 18, $value );

Default Value

''

Remarks

Customer's full name. This property contains the customer's full name as it appears on the credit card or bank account. Many gateways use this property in addition to, or instead of, the CustomerFirstName and CustomerLastName properties. If a gateway requires a CustomerFullName and the property is empty, CustomerFullName will be constructed using the contents of CustomerFirstName and CustomerLastName.

This property is not available at design time.

Data Type

String

CustomerId Property (InPay_RecurringBilling Class)

Merchant-generated customer Id.

Object Oriented Interface

public function getCustomerId();
public function setCustomerId($value);

Procedural Interface

inpay_recurringbilling_get($res, 19 );
inpay_recurringbilling_set($res, 19, $value );

Default Value

''

Remarks

Merchant-generated customer Id. This property contains a merchant-generated customer identification number. This number should be unique for each different customer that places an order with the merchant.

This property is not available at design time.

Data Type

String

CustomerLastName Property (InPay_RecurringBilling Class)

Customer's last name.

Object Oriented Interface

public function getCustomerLastName();
public function setCustomerLastName($value);

Procedural Interface

inpay_recurringbilling_get($res, 20 );
inpay_recurringbilling_set($res, 20, $value );

Default Value

''

Remarks

Customer's last name. This property contains the customer's last name as it appears on their credit card.

This property is not available at design time.

Data Type

String

CustomerPhone Property (InPay_RecurringBilling Class)

Customer's phone number.

Object Oriented Interface

public function getCustomerPhone();
public function setCustomerPhone($value);

Procedural Interface

inpay_recurringbilling_get($res, 21 );
inpay_recurringbilling_set($res, 21, $value );

Default Value

''

Remarks

Customer's phone number. This optional property contains the customer's phone number.

This property is not available at design time.

Data Type

String

CustomerState Property (InPay_RecurringBilling Class)

Customer's state.

Object Oriented Interface

public function getCustomerState();
public function setCustomerState($value);

Procedural Interface

inpay_recurringbilling_get($res, 22 );
inpay_recurringbilling_set($res, 22, $value );

Default Value

''

Remarks

Customer's state. This property is used as part of the Address Verification Service (AVS) and contains the two character postal abbreviation of the customer's state as it appears on their monthly statement. Other AVS properties include CustomerAddress, CustomerCity, and CustomerZip.

This property is not available at design time.

Data Type

String

CustomerZip Property (InPay_RecurringBilling Class)

Customer's zip code (or postal code if outside of the USA).

Object Oriented Interface

public function getCustomerZip();
public function setCustomerZip($value);

Procedural Interface

inpay_recurringbilling_get($res, 23 );
inpay_recurringbilling_set($res, 23, $value );

Default Value

''

Remarks

Customer's zip code (or postal code if outside of the USA). This property is used as part of the Address Verification Service (AVS), and contains the customer's zip code as it appears on their monthly statement. Other AVS properties include CustomerAddress, CustomerCity, and CustomerState.

This property is not available at design time.

Data Type

String

BankAccountClass Property (InPay_RecurringBilling Class)

Indicates whether a personal or business account is used for this transaction.

Object Oriented Interface

public function getBankAccountClass();
public function setBankAccountClass($value);

Procedural Interface

inpay_recurringbilling_get($res, 24 );
inpay_recurringbilling_set($res, 24, $value );

Default Value

0

Remarks

Indicates whether a personal or business account is used for this transaction.

Available values:

This property is not available at design time.

Data Type

Integer

BankAccountHolderName Property (InPay_RecurringBilling Class)

Account holder's name.

Object Oriented Interface

public function getBankAccountHolderName();
public function setBankAccountHolderName($value);

Procedural Interface

inpay_recurringbilling_get($res, 25 );
inpay_recurringbilling_set($res, 25, $value );

Default Value

''

Remarks

Account holder's name. This property contains the customer's name as it appears on their account. Many gateways use this property in addition to, or instead of, the Customer Firsts and Last name properties. Note that if this property is not specified, the FullName property from the EPCustomer type will be used instead.

This property is not available at design time.

Data Type

String

BankAccountNumber Property (InPay_RecurringBilling Class)

Bank account number for ACH transactions.

Object Oriented Interface

public function getBankAccountNumber();
public function setBankAccountNumber($value);

Procedural Interface

inpay_recurringbilling_get($res, 26 );
inpay_recurringbilling_set($res, 26, $value );

Default Value

''

Remarks

Bank account number for ACH transactions. This property contains the customer's bank account number, which along with the BankRoutingNumber identify the location of the account where funds are to be drawn from for ACH transactions. This property is required for all ACH transactions.

This property is not available at design time.

Data Type

String

BankAccountType Property (InPay_RecurringBilling Class)

Indicates whether a checking or savings account is used for this transaction.

Object Oriented Interface

public function getBankAccountType();
public function setBankAccountType($value);

Procedural Interface

inpay_recurringbilling_get($res, 27 );
inpay_recurringbilling_set($res, 27, $value );

Default Value

0

Remarks

Indicates whether a checking or savings account is used for this transaction. For gateways that support it, this property allows funds to be withdrawn (or added in the case of a Credit) from either the customer's Checking or Savings account.

Available values:

This property is not available at design time.

Data Type

Integer

BankName Property (InPay_RecurringBilling Class)

Name of the account holder's bank.

Object Oriented Interface

public function getBankName();
public function setBankName($value);

Procedural Interface

inpay_recurringbilling_get($res, 28 );
inpay_recurringbilling_set($res, 28, $value );

Default Value

''

Remarks

Name of the account holder's bank. For example, Citibank, Wells-Fargo, Wachovia, etc. This property contains the name of the bank associated with the BankRoutingNumber.

This property is not available at design time.

Data Type

String

BankRoutingNumber Property (InPay_RecurringBilling Class)

Routing number for ACH transactions.

Object Oriented Interface

public function getBankRoutingNumber();
public function setBankRoutingNumber($value);

Procedural Interface

inpay_recurringbilling_get($res, 29 );
inpay_recurringbilling_set($res, 29, $value );

Default Value

''

Remarks

Routing number for ACH transactions. This property contains the routing number to the customer's bank (Also known as an ABA code). This number indicates at which bank the BankAccountNumber is located, and is used to identify the location of the account where funds are to be drawn from for ACH transactions. This property is required for all ACH transactions.

Note: When using ACHPayments gateway, a leading zero must be added for Canadian bank accounts.

This property is not available at design time.

Data Type

String

ECheckPaymentType Property (InPay_RecurringBilling Class)

The type of check payment request (commonly referred to as SEC Code).

Object Oriented Interface

public function getECheckPaymentType();
public function setECheckPaymentType($value);

Procedural Interface

inpay_recurringbilling_get($res, 30 );
inpay_recurringbilling_set($res, 30, $value );

Default Value

0

Remarks

This property is used to specify the payment type of the check transaction.

Available values:

Data Type

Integer

Gateway Property (InPay_RecurringBilling Class)

Gateway to process transactions with.

Object Oriented Interface

public function getGateway();
public function setGateway($value);

Procedural Interface

inpay_recurringbilling_get($res, 31 );
inpay_recurringbilling_set($res, 31, $value );

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, SpecialFieldName, and SpecialFieldValue 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.

Data Type

Integer

GatewayURL Property (InPay_RecurringBilling Class)

Default URL for a specific Gateway .

Object Oriented Interface

public function getGatewayURL();
public function setGatewayURL($value);

Procedural Interface

inpay_recurringbilling_get($res, 32 );
inpay_recurringbilling_set($res, 32, $value );

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 (InPay_RecurringBilling Class)

Merchant-generated invoice number.

Object Oriented Interface

public function getInvoiceNumber();
public function setInvoiceNumber($value);

Procedural Interface

inpay_recurringbilling_get($res, 33 );
inpay_recurringbilling_set($res, 33, $value );

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 (InPay_RecurringBilling Class)

Merchant's Gateway login.

Object Oriented Interface

public function getMerchantLogin();
public function setMerchantLogin($value);

Procedural Interface

inpay_recurringbilling_get($res, 34 );
inpay_recurringbilling_set($res, 34, $value );

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 (InPay_RecurringBilling Class)

Merchant's Gateway password.

Object Oriented Interface

public function getMerchantPassword();
public function setMerchantPassword($value);

Procedural Interface

inpay_recurringbilling_get($res, 35 );
inpay_recurringbilling_set($res, 35, $value );

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

PaymentScheduleEndDate Property (InPay_RecurringBilling Class)

The end date of the subscription.

Object Oriented Interface

public function getPaymentScheduleEndDate();
public function setPaymentScheduleEndDate($value);

Procedural Interface

inpay_recurringbilling_get($res, 36 );
inpay_recurringbilling_set($res, 36, $value );

Default Value

''

Remarks

The end date of the subscription.

The default format is "MM/dd/yyyy" and is controlled by DateFormat, or GetSubscriptionStatus.

This property is not available at design time.

Data Type

String

PaymentScheduleFrequency Property (InPay_RecurringBilling Class)

The frequency of payments.

Object Oriented Interface

public function getPaymentScheduleFrequency();
public function setPaymentScheduleFrequency($value);

Procedural Interface

inpay_recurringbilling_get($res, 37 );
inpay_recurringbilling_set($res, 37, $value );

Default Value

''

Remarks

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 PaymentScheduleFrequencyUnit is applicable to the gateway, this property specifies the length of time between charges. This is used in combination with PaymentScheduleFrequencyUnit to specify the frequency of the billing. For instance if PaymentScheduleFrequencyUnit is set to "Days" and PaymentScheduleFrequency is set to "5", payments will occur every 5 days.

This property is not available at design time.

Data Type

String

PaymentScheduleFrequencyUnit Property (InPay_RecurringBilling Class)

The unit of time to be used when calculating the frequency of payments.

Object Oriented Interface

public function getPaymentScheduleFrequencyUnit();
public function setPaymentScheduleFrequencyUnit($value);

Procedural Interface

inpay_recurringbilling_get($res, 38 );
inpay_recurringbilling_set($res, 38, $value );

Default Value

''

Remarks

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"

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.

This property is not available at design time.

Data Type

String

PaymentScheduleInitialAmount Property (InPay_RecurringBilling Class)

The initial amount to be charged (such as a trial period or setup fee).

Object Oriented Interface

public function getPaymentScheduleInitialAmount();
public function setPaymentScheduleInitialAmount($value);

Procedural Interface

inpay_recurringbilling_get($res, 39 );
inpay_recurringbilling_set($res, 39, $value );

Default Value

''

Remarks

The initial amount to be charged (such as a trial period or setup fee). This amount can vary from PaymentScheduleRecurAmount.

This property is not available at design time.

Data Type

String

PaymentScheduleRecurAmount Property (InPay_RecurringBilling Class)

The amount to be charged on a recurring basis.

Object Oriented Interface

public function getPaymentScheduleRecurAmount();
public function setPaymentScheduleRecurAmount($value);

Procedural Interface

inpay_recurringbilling_get($res, 40 );
inpay_recurringbilling_set($res, 40, $value );

Default Value

''

Remarks

The amount to be charged on a recurring basis. This amount can vary from PaymentScheduleInitialAmount.

This property is not available at design time.

Data Type

String

PaymentScheduleStartDate Property (InPay_RecurringBilling Class)

The date on which the recurring payments will start processing.

Object Oriented Interface

public function getPaymentScheduleStartDate();
public function setPaymentScheduleStartDate($value);

Procedural Interface

inpay_recurringbilling_get($res, 41 );
inpay_recurringbilling_set($res, 41, $value );

Default Value

''

Remarks

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.

This property is not available at design time.

Data Type

String

PaymentScheduleTotalPayments Property (InPay_RecurringBilling Class)

The total number of payments.

Object Oriented Interface

public function getPaymentScheduleTotalPayments();
public function setPaymentScheduleTotalPayments($value);

Procedural Interface

inpay_recurringbilling_get($res, 42 );
inpay_recurringbilling_set($res, 42, $value );

Default Value

0

Remarks

The total number of payments. Valid values differ between gateways. See RecurringBilling Gateway Setup and Required Properties for details.

This property is not available at design time.

Data Type

Integer

PaymentScheduleTrialPayments Property (InPay_RecurringBilling Class)

The total number of trial payments.

Object Oriented Interface

public function getPaymentScheduleTrialPayments();
public function setPaymentScheduleTrialPayments($value);

Procedural Interface

inpay_recurringbilling_get($res, 43 );
inpay_recurringbilling_set($res, 43, $value );

Default Value

0

Remarks

The total number of trial payments.

This property is not available at design time.

Data Type

Integer

ProxyAuthScheme Property (InPay_RecurringBilling Class)

The type of authorization to perform when connecting to the proxy.

Object Oriented Interface

public function getProxyAuthScheme();
public function setProxyAuthScheme($value);

Procedural Interface

inpay_recurringbilling_get($res, 44 );
inpay_recurringbilling_set($res, 44, $value );

Default Value

0

Remarks

The type of authorization to perform when connecting to the proxy. This is used only when the ProxyUser and ProxyPassword properties are set.

ProxyAuthScheme should be set to authNone (3) when no authentication is expected.

By default, ProxyAuthScheme is authBasic (0), and if the ProxyUser and ProxyPassword properties are set, the class will attempt basic authentication.

If ProxyAuthScheme is set to authDigest (1), digest authentication will be attempted instead.

If ProxyAuthScheme 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 ProxyAuthScheme is set to authNtlm (4), NTLM authentication will be used.

For security reasons, setting this property will clear the values of ProxyUser and ProxyPassword.

Data Type

Integer

ProxyAutoDetect Property (InPay_RecurringBilling Class)

Whether to automatically detect and use proxy system settings, if available.

Object Oriented Interface

public function getProxyAutoDetect();
public function setProxyAutoDetect($value);

Procedural Interface

inpay_recurringbilling_get($res, 45 );
inpay_recurringbilling_set($res, 45, $value );

Default Value

false

Remarks

Whether to automatically detect and use proxy system settings, if available. The default value is false.

Data Type

Boolean

ProxyPassword Property (InPay_RecurringBilling Class)

A password if authentication is to be used for the proxy.

Object Oriented Interface

public function getProxyPassword();
public function setProxyPassword($value);

Procedural Interface

inpay_recurringbilling_get($res, 46 );
inpay_recurringbilling_set($res, 46, $value );

Default Value

''

Remarks

A password if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

ProxyPort Property (InPay_RecurringBilling Class)

The Transmission Control Protocol (TCP) port for the proxy Server (default 80).

Object Oriented Interface

public function getProxyPort();
public function setProxyPort($value);

Procedural Interface

inpay_recurringbilling_get($res, 47 );
inpay_recurringbilling_set($res, 47, $value );

Default Value

80

Remarks

The Transmission Control Protocol (TCP) port for the proxy ProxyServer (default 80). See the description of the ProxyServer property for details.

Data Type

Integer

ProxyServer Property (InPay_RecurringBilling Class)

If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

Object Oriented Interface

public function getProxyServer();
public function setProxyServer($value);

Procedural Interface

inpay_recurringbilling_get($res, 48 );
inpay_recurringbilling_set($res, 48, $value );

Default Value

''

Remarks

If a proxy ProxyServer is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

If the ProxyServer property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the ProxyServer property is set to the corresponding address. If the search is not successful, an error is returned.

Data Type

String

ProxySSL Property (InPay_RecurringBilling Class)

When to use a Secure Sockets Layer (SSL) for the connection to the proxy.

Object Oriented Interface

public function getProxySSL();
public function setProxySSL($value);

Procedural Interface

inpay_recurringbilling_get($res, 49 );
inpay_recurringbilling_set($res, 49, $value );

Default Value

0

Remarks

When to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:

Data Type

Integer

ProxyUser Property (InPay_RecurringBilling Class)

A username if authentication is to be used for the proxy.

Object Oriented Interface

public function getProxyUser();
public function setProxyUser($value);

Procedural Interface

inpay_recurringbilling_get($res, 50 );
inpay_recurringbilling_set($res, 50, $value );

Default Value

''

Remarks

A username if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

ResponseApprovalCode Property (InPay_RecurringBilling Class)

Contains an authorization code when a transaction has been approved.

Object Oriented Interface

public function getResponseApprovalCode();

Procedural Interface

inpay_recurringbilling_get($res, 51 );

Default Value

''

Remarks

Contains an authorization code when a transaction has been approved. This property contains an authorization code when a transaction has been approved. If the ResponseCode returned indicates that the transaction is not approved, then the contents of this property should be ignored.

This property is read-only and not available at design time.

Data Type

String

ResponseApproved Property (InPay_RecurringBilling Class)

Indicates the status of the last transaction.

Object Oriented Interface

public function getResponseApproved();

Procedural Interface

inpay_recurringbilling_get($res, 52 );

Default Value

false

Remarks

Indicates the status of the last transaction. This property will be True if the last transaction was approved. However, you should not rely solely on the value contained in this property. After every transaction, the ResponseCode should be inspected and evaluated according to the specifications of the Gateway in use. A list of response codes for each gateway is listed in the table of contents. However, it is recommended that the developer acquire the current list from the Gateway which is being used.

This property is read-only and not available at design time.

Data Type

Boolean

ResponseAVSResult Property (InPay_RecurringBilling Class)

Contains the Address Verification System result code.

Object Oriented Interface

public function getResponseAVSResult();

Procedural Interface

inpay_recurringbilling_get($res, 53 );

Default Value

''

Remarks

Contains the Address Verification System result code. This one character property contains the Address Verification Service (AVS) result code. An AVS result code can provide additional information concerning the authentication of a particular transaction for which cardholder address verification was requested. An AVS result code of "0" will be returned in the response message when no address verification has been requested. The value returned should be stored for later retrieval, as it may be required when voiding or refunding a transaction. Valid AVS response codes are listed below, and are identical across all Gateway (note that some gateways do not return an AVS response).

Note: Some gateways use their own response codes instead of those in the above table; those response codes are detailed below for such gateways.

Adyen

For Adyen, this property will contain the following possible values:

American Payment Solutions

For American Payment Solutions, this property will contain the following possible values:

Barclay

For Barclay, the property will contain the following possible values:

BlueSnap

For BlueSnap, the property will contain a 3-character string (if AVS checks were done), which contains the AVS checks for the following properties:

The possible values for each result character are:

HSBC

For HSBC, the property will contain the following possible values:

PayTrace / PayTraceJSON

For PayTrace / PayTraceJSON, the property will contain the following possible values:

QBMS

For the QBMS gateway, the ResponseAVSResult property will contain the result for the street address, a comma, and then the result for the zip code. The values returned are "Pass", "Fail", and "NotAvailable". Therefore, an ResponseAVSResult of "Fail,Pass" means that the street address failed validation, but the zip code passed.

DataCash

For DataCash, the property will contain the following possible values (of which correspond to both AVS and CVV checks):

Stripe

For Stripe, the property will contain the following possible values:

Worldpay

For Worldpay, the property will contain a 4-character string, which contains the AVS checks for the following properties:

The possible values for each result character are:

Worldpay Online

For Worldpay Online, the property will contain one of the following:

This property is read-only and not available at design time.

Data Type

String

ResponseCode Property (InPay_RecurringBilling Class)

Indicates the status of the authorization request.

Object Oriented Interface

public function getResponseCode();

Procedural Interface

inpay_recurringbilling_get($res, 54 );

Default Value

''

Remarks

Indicates the status of the authorization request. This property contains the actual response code as returned by the Gateway. Unlike the ResponseApproved property, this ResponseCode property may provide more details about why a transaction was declined. Therefore, it is recommended that developers check the ResponseCode as well as the ResponseApproved property. The Point of Sale system should evaluate this response code and NOT the ResponseText to determine nature of a response message. The current (at the time of this release) response codes for the supported Gateways are listed in the table of contents to your left.

This property is read-only and not available at design time.

Data Type

String

ResponseCVVResult Property (InPay_RecurringBilling Class)

Contains the returned CVV2 result code if it was requested.

Object Oriented Interface

public function getResponseCVVResult();

Procedural Interface

inpay_recurringbilling_get($res, 55 );

Default Value

''

Remarks

Contains the returned CVV2 result code if it was requested. This property contains the host returned CVV2 result code (if CVV data was sent in the request). The following is a list of current result codes:

A gateway may also support custom codes or human-readable response messages in this property. Please consult your gateway documentation to determine if CVV2 codes are supported.

Note: Some gateways use their own response codes instead of those in the above table; those response codes are detailed below for such gateways.

HSBC

For HSBC, the property will contain:

Adyen

For Adyen, the property will contain:

Barclay

For Barclay, the property will contain:

BlueSnap

For BlueSnap, the property will contain:

(Note: There are some scenarios in which the property will be empty instead, refer to BlueSnap's documentation for more details.)

DataCash

For DataCash, the property will contain the following possible values (of which correspond to both AVS and CVV checks):

Stripe

For Stripe, the property will contain the following possible values:

Worldpay Online

For Worldpay Online, the property will contain one of the following:

This property is read-only and not available at design time.

Data Type

String

ResponseData Property (InPay_RecurringBilling Class)

The entire response returned from the gateway processor.

Object Oriented Interface

public function getResponseData();

Procedural Interface

inpay_recurringbilling_get($res, 56 );

Default Value

''

Remarks

The entire response returned from the gateway processor. This property contains the entire response returned from the gateway processor. You may use this to parse additional information that is not returned in the standard response properties.

This property is read-only and not available at design time.

Data Type

String

ResponseErrorCode Property (InPay_RecurringBilling Class)

Additional error code returned by some gateways.

Object Oriented Interface

public function getResponseErrorCode();

Procedural Interface

inpay_recurringbilling_get($res, 57 );

Default Value

''

Remarks

Additional error code returned by some gateways. If a gateway returns it, this property will contain an additional code that may explain why the transaction was declined. You may also wish to inspect ResponseErrorText for a human-readable description of this ResponseErrorCode.

This property is read-only and not available at design time.

Data Type

String

ResponseErrorText Property (InPay_RecurringBilling Class)

Additional error description returned by some gateways.

Object Oriented Interface

public function getResponseErrorText();

Procedural Interface

inpay_recurringbilling_get($res, 58 );

Default Value

''

Remarks

Additional error description returned by some gateways. If a gateway returns it, this property will contain a human-readable description of the error which occurred (if any). You may also wish to inspect ResponseErrorCode for an accompanying code which may be parsed and used by your application.

This property is read-only and not available at design time.

Data Type

String

ResponseInvoiceNumber Property (InPay_RecurringBilling Class)

Invoice number submitted in authorization request (if applicable).

Object Oriented Interface

public function getResponseInvoiceNumber();

Procedural Interface

inpay_recurringbilling_get($res, 59 );

Default Value

''

Remarks

Invoice number submitted in authorization request (if applicable). This property contains the Invoice Number submitted in the original transaction, echoed back by the Gateway host.

This property is read-only and not available at design time.

Data Type

String

ResponseProcessorCode Property (InPay_RecurringBilling Class)

Response code from the underlying processor.

Object Oriented Interface

public function getResponseProcessorCode();

Procedural Interface

inpay_recurringbilling_get($res, 60 );

Default Value

''

Remarks

Response code from the underlying processor. Often times a Gateway will return a ResponseCode that indicates only whether the transaction is approved or declined. Many of these also include a secondary code that provides more details as to why the transaction was declined.

Note, for the PayFlowPro Gateway this property will contain a "1" if the transaction was a duplicate, a "-1" if duplicate checking service is unavailable, and will be blank for a successfully authorized transaction.

This property is read-only and not available at design time.

Data Type

String

ResponseSubscriptionId Property (InPay_RecurringBilling Class)

Contains the Subscription or Profile Identifier for the recurring payment.

Object Oriented Interface

public function getResponseSubscriptionId();

Procedural Interface

inpay_recurringbilling_get($res, 61 );

Default Value

''

Remarks

Contains the Subscription or Profile Identifier for the recurring payment. This property contains a subscription identifier or profile number used to reference a recurring payment. This property is used when performing subsequent actions on a recurring payment.

This property is read-only and not available at design time.

Data Type

String

ResponseText Property (InPay_RecurringBilling Class)

Text information that describes each response code.

Object Oriented Interface

public function getResponseText();

Procedural Interface

inpay_recurringbilling_get($res, 62 );

Default Value

''

Remarks

Text information that describes each response code. This property contains a response or display text message. This message can be used by the terminal to display the authorization result. The display text must not be used to determine the nature of a response message. A Gateway may translate the response according to the language indicated in the merchant account setup (if applicable).

This property is read-only and not available at design time.

Data Type

String

ResponseTransactionId Property (InPay_RecurringBilling Class)

Contains the Visa Transaction Identifier or MasterCard Reference Number.

Object Oriented Interface

public function getResponseTransactionId();

Procedural Interface

inpay_recurringbilling_get($res, 63 );

Default Value

''

Remarks

Contains the Visa Transaction Identifier or MasterCard Reference Number. This property contains a transaction identifier or reference number. The Point of Sale (POS) device should not attempt to interpret the meaning of any data appearing in this property. Data returned in this property (if any) should be recorded and used to submit a modification of this transaction at a later time (such as voiding the transaction or capturing an authorization-only transaction, if applicable).

This property is read-only and not available at design time.

Data Type

String

ShippingAddress Property (InPay_RecurringBilling Class)

Customer's shipping street address.

Object Oriented Interface

public function getShippingAddress();
public function setShippingAddress($value);

Procedural Interface

inpay_recurringbilling_get($res, 64 );
inpay_recurringbilling_set($res, 64, $value );

Default Value

''

Remarks

Customer's shipping street address.

This property is not available at design time.

Data Type

String

ShippingAddress2 Property (InPay_RecurringBilling Class)

A specific detail on the customer's shipping address (such as building, suite, apartment, floor number etc.

Object Oriented Interface

public function getShippingAddress2();
public function setShippingAddress2($value);

Procedural Interface

inpay_recurringbilling_get($res, 65 );
inpay_recurringbilling_set($res, 65, $value );

Default Value

''

Remarks

A specific detail on the customer's shipping address (such as building, suite, apartment, floor number etc.).

This property is not available at design time.

Data Type

String

ShippingCity Property (InPay_RecurringBilling Class)

Customer's shipping city.

Object Oriented Interface

public function getShippingCity();
public function setShippingCity($value);

Procedural Interface

inpay_recurringbilling_get($res, 66 );
inpay_recurringbilling_set($res, 66, $value );

Default Value

''

Remarks

Customer's shipping city.

This property is not available at design time.

Data Type

String

ShippingCountry Property (InPay_RecurringBilling Class)

Customer's shipping country.

Object Oriented Interface

public function getShippingCountry();
public function setShippingCountry($value);

Procedural Interface

inpay_recurringbilling_get($res, 67 );
inpay_recurringbilling_set($res, 67, $value );

Default Value

''

Remarks

Customer's shipping country. This property contains the country in which the customer is located. Most gateways use a two-letter country code, specified in ISO-3166.

This property is not available at design time.

Data Type

String

ShippingEmail Property (InPay_RecurringBilling Class)

Customer's email address.

Object Oriented Interface

public function getShippingEmail();
public function setShippingEmail($value);

Procedural Interface

inpay_recurringbilling_get($res, 68 );
inpay_recurringbilling_set($res, 68, $value );

Default Value

''

Remarks

Customer's email address.

This property is not available at design time.

Data Type

String

ShippingFirstName Property (InPay_RecurringBilling Class)

Customer's first name.

Object Oriented Interface

public function getShippingFirstName();
public function setShippingFirstName($value);

Procedural Interface

inpay_recurringbilling_get($res, 69 );
inpay_recurringbilling_set($res, 69, $value );

Default Value

''

Remarks

Customer's first name.

This property is not available at design time.

Data Type

String

ShippingLastName Property (InPay_RecurringBilling Class)

Customer's last name.

Object Oriented Interface

public function getShippingLastName();
public function setShippingLastName($value);

Procedural Interface

inpay_recurringbilling_get($res, 70 );
inpay_recurringbilling_set($res, 70, $value );

Default Value

''

Remarks

Customer's last name.

This property is not available at design time.

Data Type

String

ShippingPhone Property (InPay_RecurringBilling Class)

Customer's phone number.

Object Oriented Interface

public function getShippingPhone();
public function setShippingPhone($value);

Procedural Interface

inpay_recurringbilling_get($res, 71 );
inpay_recurringbilling_set($res, 71, $value );

Default Value

''

Remarks

Customer's phone number.

This property is not available at design time.

Data Type

String

ShippingState Property (InPay_RecurringBilling Class)

Customer's shipping state.

Object Oriented Interface

public function getShippingState();
public function setShippingState($value);

Procedural Interface

inpay_recurringbilling_get($res, 72 );
inpay_recurringbilling_set($res, 72, $value );

Default Value

''

Remarks

Customer's shipping state.

This property is not available at design time.

Data Type

String

ShippingZip Property (InPay_RecurringBilling Class)

Customer's shipping zip code (or postal code if outside of the USA).

Object Oriented Interface

public function getShippingZip();
public function setShippingZip($value);

Procedural Interface

inpay_recurringbilling_get($res, 73 );
inpay_recurringbilling_set($res, 73, $value );

Default Value

''

Remarks

Customer's shipping zip code (or postal code if outside of the USA).

This property is not available at design time.

Data Type

String

SpecialFieldCount Property (InPay_RecurringBilling Class)

The number of records in the SpecialField arrays.

Object Oriented Interface

public function getSpecialFieldCount();
public function setSpecialFieldCount($value);

Procedural Interface

inpay_recurringbilling_get($res, 74 );
inpay_recurringbilling_set($res, 74, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• SpecialFieldName
• SpecialFieldValue

The array indices start at 0 and end at SpecialFieldCount - 1.

This property is not available at design time.

Data Type

Integer

SpecialFieldName Property (InPay_RecurringBilling Class)

Name of special configuration property to submit in this transaction.

Object Oriented Interface

public function getSpecialFieldName($fieldindex);
public function setSpecialFieldName($fieldindex, $value);

Procedural Interface

inpay_recurringbilling_get($res, 75 , $fieldindex);
inpay_recurringbilling_set($res, 75, $value , $fieldindex);

Default Value

''

Remarks

Name of special configuration field to submit in this transaction. The SpecialFieldName and SpecialFieldValue properties can be used to send special gateway configuration and transaction properties for each transaction. These properties can also be used to extend the functionality of this class by submitting additional information to the gateway.

This property is not applicable for the LinkPoint, FirstData, YourPay, PayFuse, or Orbital gateways.

The $fieldindex parameter specifies the index of the item in the array. The size of the array is controlled by the SpecialFieldCount property.

This property is not available at design time.

Data Type

String

SpecialFieldValue Property (InPay_RecurringBilling Class)

Value of special configuration property to submit in this transaction.

Object Oriented Interface

public function getSpecialFieldValue($fieldindex);
public function setSpecialFieldValue($fieldindex, $value);

Procedural Interface

inpay_recurringbilling_get($res, 76 , $fieldindex);
inpay_recurringbilling_set($res, 76, $value , $fieldindex);

Default Value

''

Remarks

Value of special configuration field to submit in this transaction. The SpecialFieldName and SpecialFieldValue properties can be used to send special gateway configuration and transaction properties for each transaction. These properties can also be used to extend the functionality of this class by submitting additional information to the gateway.

Note: This property is not applicable for the LinkPoint, FirstData, YourPay, PayFuse, or Orbital gateways.

The $fieldindex parameter specifies the index of the item in the array. The size of the array is controlled by the SpecialFieldCount property.

This property is not available at design time.

Data Type

String

SSLAcceptServerCertEffectiveDate Property (InPay_RecurringBilling Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLAcceptServerCertEffectiveDate();

Procedural Interface

inpay_recurringbilling_get($res, 77 );

Default Value

''

Remarks

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.

This property is read-only.

Data Type

String

SSLAcceptServerCertExpirationDate Property (InPay_RecurringBilling Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLAcceptServerCertExpirationDate();

Procedural Interface

inpay_recurringbilling_get($res, 78 );

Default Value

''

Remarks

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.

This property is read-only.

Data Type

String

SSLAcceptServerCertExtendedKeyUsage Property (InPay_RecurringBilling Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLAcceptServerCertExtendedKeyUsage();

Procedural Interface

inpay_recurringbilling_get($res, 79 );

Default Value

''

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprint Property (InPay_RecurringBilling Class)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertFingerprint();

Procedural Interface

inpay_recurringbilling_get($res, 80 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprintSHA1 Property (InPay_RecurringBilling Class)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertFingerprintSHA1();

Procedural Interface

inpay_recurringbilling_get($res, 81 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprintSHA256 Property (InPay_RecurringBilling Class)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertFingerprintSHA256();

Procedural Interface

inpay_recurringbilling_get($res, 82 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertIssuer Property (InPay_RecurringBilling Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertIssuer();

Procedural Interface

inpay_recurringbilling_get($res, 83 );

Default Value

''

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLAcceptServerCertPrivateKey Property (InPay_RecurringBilling Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKey();

Procedural Interface

inpay_recurringbilling_get($res, 84 );

Default Value

''

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSLAcceptServerCertPrivateKey may be available but not exportable. In this case, SSLAcceptServerCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLAcceptServerCertPrivateKeyAvailable Property (InPay_RecurringBilling Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKeyAvailable();

Procedural Interface

inpay_recurringbilling_get($res, 85 );

Default Value

false

Remarks

Whether a SSLAcceptServerCertPrivateKey is available for the selected certificate. If SSLAcceptServerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLAcceptServerCertPrivateKeyContainer Property (InPay_RecurringBilling Class)

The name of the PrivateKey container for the certificate (if available).

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKeyContainer();

Procedural Interface

inpay_recurringbilling_get($res, 86 );

Default Value

''

Remarks

The name of the SSLAcceptServerCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKey Property (InPay_RecurringBilling Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertPublicKey();

Procedural Interface

inpay_recurringbilling_get($res, 87 );

Default Value

''

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKeyAlgorithm Property (InPay_RecurringBilling Class)

The textual description of the certificate's public key algorithm.

Object Oriented Interface

public function getSSLAcceptServerCertPublicKeyAlgorithm();

Procedural Interface

inpay_recurringbilling_get($res, 88 );

Default Value

''

Remarks

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.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKeyLength Property (InPay_RecurringBilling Class)

The length of the certificate's public key (in bits).

Object Oriented Interface

public function getSSLAcceptServerCertPublicKeyLength();

Procedural Interface

inpay_recurringbilling_get($res, 89 );

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSLAcceptServerCertSerialNumber Property (InPay_RecurringBilling Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLAcceptServerCertSerialNumber();

Procedural Interface

inpay_recurringbilling_get($res, 90 );

Default Value

''

Remarks

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.

This property is read-only.

Data Type

String

SSLAcceptServerCertSignatureAlgorithm Property (InPay_RecurringBilling Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLAcceptServerCertSignatureAlgorithm();

Procedural Interface

inpay_recurringbilling_get($res, 91 );

Default Value

''

Remarks

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.

This property is read-only.

Data Type

String

SSLAcceptServerCertStore Property (InPay_RecurringBilling Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLAcceptServerCertStore();
public function setSSLAcceptServerCertStore($value);

Procedural Interface

inpay_recurringbilling_get($res, 92 );
inpay_recurringbilling_set($res, 92, $value );

Default Value

'MY'

Remarks

The name of the certificate store for the client certificate.

The SSLAcceptServerCertStoreType property denotes the type of the certificate store specified by SSLAcceptServerCertStore. If the store is password-protected, specify the password in SSLAcceptServerCertStorePassword.

SSLAcceptServerCertStore is used in conjunction with the SSLAcceptServerCertSubject property to specify client certificates. If SSLAcceptServerCertStore has a value, and SSLAcceptServerCertSubject or SSLAcceptServerCertEncoded is set, a search for a certificate is initiated. Please see the SSLAcceptServerCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

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).

Data Type

Binary String

SSLAcceptServerCertStorePassword Property (InPay_RecurringBilling Class)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Object Oriented Interface

public function getSSLAcceptServerCertStorePassword();
public function setSSLAcceptServerCertStorePassword($value);

Procedural Interface

inpay_recurringbilling_get($res, 93 );
inpay_recurringbilling_set($res, 93, $value );

Default Value

''

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

SSLAcceptServerCertStoreType Property (InPay_RecurringBilling Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLAcceptServerCertStoreType();
public function setSSLAcceptServerCertStoreType($value);

Procedural Interface

inpay_recurringbilling_get($res, 94 );
inpay_recurringbilling_set($res, 94, $value );

Default Value

0

Remarks

The type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

Data Type

Integer

SSLAcceptServerCertSubjectAltNames Property (InPay_RecurringBilling Class)

Comma-separated lists of alternative subject names for the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertSubjectAltNames();

Procedural Interface

inpay_recurringbilling_get($res, 95 );

Default Value

''

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintMD5 Property (InPay_RecurringBilling Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintMD5();

Procedural Interface

inpay_recurringbilling_get($res, 96 );

Default Value

''

Remarks

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.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintSHA1 Property (InPay_RecurringBilling Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintSHA1();

Procedural Interface

inpay_recurringbilling_get($res, 97 );

Default Value

''

Remarks

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.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintSHA256 Property (InPay_RecurringBilling Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintSHA256();

Procedural Interface

inpay_recurringbilling_get($res, 98 );

Default Value

''

Remarks

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.

This property is read-only.

Data Type

String

SSLAcceptServerCertUsage Property (InPay_RecurringBilling Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLAcceptServerCertUsage();

Procedural Interface

inpay_recurringbilling_get($res, 99 );

Default Value

''

Remarks

The text description of SSLAcceptServerCertUsageFlags.

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.

This property is read-only.

Data Type

String

SSLAcceptServerCertUsageFlags Property (InPay_RecurringBilling Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertUsageFlags();

Procedural Interface

inpay_recurringbilling_get($res, 100 );

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLAcceptServerCertUsageFlags is a combination of the following flags:

Please see the SSLAcceptServerCertUsage property for a text representation of SSLAcceptServerCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

SSLAcceptServerCertVersion Property (InPay_RecurringBilling Class)

The certificate's version number.

Object Oriented Interface

public function getSSLAcceptServerCertVersion();

Procedural Interface

inpay_recurringbilling_get($res, 101 );

Default Value

''

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSLAcceptServerCertSubject Property (InPay_RecurringBilling Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLAcceptServerCertSubject();
public function setSSLAcceptServerCertSubject($value);

Procedural Interface

inpay_recurringbilling_get($res, 102 );
inpay_recurringbilling_set($res, 102, $value );

Default Value

''

Remarks

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 property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

SSLAcceptServerCertEncoded Property (InPay_RecurringBilling Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLAcceptServerCertEncoded();
public function setSSLAcceptServerCertEncoded($value);

Procedural Interface

inpay_recurringbilling_get($res, 103 );
inpay_recurringbilling_set($res, 103, $value );

Default Value

''

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLAcceptServerCertStore and SSLAcceptServerCertSubject properties also may be used to specify a certificate.

When SSLAcceptServerCertEncoded is set, a search is initiated in the current SSLAcceptServerCertStore for the private key of the certificate. If the key is found, SSLAcceptServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLAcceptServerCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

SSLCertEffectiveDate Property (InPay_RecurringBilling Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLCertEffectiveDate();

Procedural Interface

inpay_recurringbilling_get($res, 104 );

Default Value

''

Remarks

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.

This property is read-only.

Data Type

String

SSLCertExpirationDate Property (InPay_RecurringBilling Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLCertExpirationDate();

Procedural Interface

inpay_recurringbilling_get($res, 105 );

Default Value

''

Remarks

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.

This property is read-only.

Data Type

String

SSLCertExtendedKeyUsage Property (InPay_RecurringBilling Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLCertExtendedKeyUsage();

Procedural Interface

inpay_recurringbilling_get($res, 106 );

Default Value

''

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSLCertFingerprint Property (InPay_RecurringBilling Class)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Object Oriented Interface

public function getSSLCertFingerprint();

Procedural Interface

inpay_recurringbilling_get($res, 107 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLCertFingerprintSHA1 Property (InPay_RecurringBilling Class)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Object Oriented Interface

public function getSSLCertFingerprintSHA1();

Procedural Interface

inpay_recurringbilling_get($res, 108 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLCertFingerprintSHA256 Property (InPay_RecurringBilling Class)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Object Oriented Interface

public function getSSLCertFingerprintSHA256();

Procedural Interface

inpay_recurringbilling_get($res, 109 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLCertIssuer Property (InPay_RecurringBilling Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLCertIssuer();

Procedural Interface

inpay_recurringbilling_get($res, 110 );

Default Value

''

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLCertPrivateKey Property (InPay_RecurringBilling Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLCertPrivateKey();

Procedural Interface

inpay_recurringbilling_get($res, 111 );

Default Value

''

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSLCertPrivateKey may be available but not exportable. In this case, SSLCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLCertPrivateKeyAvailable Property (InPay_RecurringBilling Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLCertPrivateKeyAvailable();

Procedural Interface

inpay_recurringbilling_get($res, 112 );

Default Value

false

Remarks

Whether a SSLCertPrivateKey is available for the selected certificate. If SSLCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLCertPrivateKeyContainer Property (InPay_RecurringBilling Class)

The name of the PrivateKey container for the certificate (if available).

Object Oriented Interface

public function getSSLCertPrivateKeyContainer();

Procedural Interface

inpay_recurringbilling_get($res, 113 );

Default Value

''

Remarks

The name of the SSLCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLCertPublicKey Property (InPay_RecurringBilling Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLCertPublicKey();

Procedural Interface

inpay_recurringbilling_get($res, 114 );

Default Value

''

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSLCertPublicKeyAlgorithm Property (InPay_RecurringBilling Class)

The textual description of the certificate's public key algorithm.

Object Oriented Interface

public function getSSLCertPublicKeyAlgorithm();

Procedural Interface

inpay_recurringbilling_get($res, 115 );

Default Value

''

Remarks

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.

This property is read-only.

Data Type

String

SSLCertPublicKeyLength Property (InPay_RecurringBilling Class)

The length of the certificate's public key (in bits).

Object Oriented Interface

public function getSSLCertPublicKeyLength();

Procedural Interface

inpay_recurringbilling_get($res, 116 );

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSLCertSerialNumber Property (InPay_RecurringBilling Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLCertSerialNumber();

Procedural Interface

inpay_recurringbilling_get($res, 117 );

Default Value

''

Remarks

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.

This property is read-only.

Data Type

String

SSLCertSignatureAlgorithm Property (InPay_RecurringBilling Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLCertSignatureAlgorithm();

Procedural Interface

inpay_recurringbilling_get($res, 118 );

Default Value

''

Remarks

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.

This property is read-only.

Data Type

String

SSLCertStore Property (InPay_RecurringBilling Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLCertStore();
public function setSSLCertStore($value);

Procedural Interface

inpay_recurringbilling_get($res, 119 );
inpay_recurringbilling_set($res, 119, $value );

Default Value

'MY'

Remarks

The name of the certificate store for the client certificate.

The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password-protected, specify the password in SSLCertStorePassword.

SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

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).

Data Type

Binary String

SSLCertStorePassword Property (InPay_RecurringBilling Class)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Object Oriented Interface

public function getSSLCertStorePassword();
public function setSSLCertStorePassword($value);

Procedural Interface

inpay_recurringbilling_get($res, 120 );
inpay_recurringbilling_set($res, 120, $value );

Default Value

''

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

SSLCertStoreType Property (InPay_RecurringBilling Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLCertStoreType();
public function setSSLCertStoreType($value);

Procedural Interface

inpay_recurringbilling_get($res, 121 );
inpay_recurringbilling_set($res, 121, $value );

Default Value

0

Remarks

The type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

Data Type

Integer

SSLCertSubjectAltNames Property (InPay_RecurringBilling Class)

Comma-separated lists of alternative subject names for the certificate.

Object Oriented Interface

public function getSSLCertSubjectAltNames();

Procedural Interface

inpay_recurringbilling_get($res, 122 );

Default Value

''

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLCertThumbprintMD5 Property (InPay_RecurringBilling Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintMD5();

Procedural Interface

inpay_recurringbilling_get($res, 123 );

Default Value

''

Remarks

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.

This property is read-only.

Data Type

String

SSLCertThumbprintSHA1 Property (InPay_RecurringBilling Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintSHA1();

Procedural Interface

inpay_recurringbilling_get($res, 124 );

Default Value

''

Remarks

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.

This property is read-only.

Data Type

String

SSLCertThumbprintSHA256 Property (InPay_RecurringBilling Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintSHA256();

Procedural Interface

inpay_recurringbilling_get($res, 125 );

Default Value

''

Remarks

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.

This property is read-only.

Data Type

String

SSLCertUsage Property (InPay_RecurringBilling Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLCertUsage();

Procedural Interface

inpay_recurringbilling_get($res, 126 );

Default Value

''

Remarks

The text description of SSLCertUsageFlags.

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.

This property is read-only.

Data Type

String

SSLCertUsageFlags Property (InPay_RecurringBilling Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLCertUsageFlags();

Procedural Interface

inpay_recurringbilling_get($res, 127 );

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLCertUsageFlags is a combination of the following flags:

Please see the SSLCertUsage property for a text representation of SSLCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

SSLCertVersion Property (InPay_RecurringBilling Class)

The certificate's version number.

Object Oriented Interface

public function getSSLCertVersion();

Procedural Interface

inpay_recurringbilling_get($res, 128 );

Default Value

''

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSLCertSubject Property (InPay_RecurringBilling Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLCertSubject();
public function setSSLCertSubject($value);

Procedural Interface

inpay_recurringbilling_get($res, 129 );
inpay_recurringbilling_set($res, 129, $value );

Default Value

''

Remarks

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 property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

SSLCertEncoded Property (InPay_RecurringBilling Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLCertEncoded();
public function setSSLCertEncoded($value);

Procedural Interface

inpay_recurringbilling_get($res, 130 );
inpay_recurringbilling_set($res, 130, $value );

Default Value

''

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.

When SSLCertEncoded is set, a search is initiated in the current SSLCertStore for the private key of the certificate. If the key is found, SSLCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

SSLProvider Property (InPay_RecurringBilling Class)

The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.

Object Oriented Interface

public function getSSLProvider();
public function setSSLProvider($value);

Procedural Interface

inpay_recurringbilling_get($res, 131 );
inpay_recurringbilling_set($res, 131, $value );

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:

Additional Notes

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

SSLServerCertEffectiveDate Property (InPay_RecurringBilling Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLServerCertEffectiveDate();

Procedural Interface

inpay_recurringbilling_get($res, 132 );

Default Value

''

Remarks

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.

This property is read-only.

Data Type

String

SSLServerCertExpirationDate Property (InPay_RecurringBilling Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLServerCertExpirationDate();

Procedural Interface

inpay_recurringbilling_get($res, 133 );

Default Value

''

Remarks

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.

This property is read-only.

Data Type

String

SSLServerCertExtendedKeyUsage Property (InPay_RecurringBilling Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLServerCertExtendedKeyUsage();

Procedural Interface

inpay_recurringbilling_get($res, 134 );

Default Value

''

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSLServerCertFingerprint Property (InPay_RecurringBilling Class)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Object Oriented Interface

public function getSSLServerCertFingerprint();

Procedural Interface

inpay_recurringbilling_get($res, 135 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertFingerprintSHA1 Property (InPay_RecurringBilling Class)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Object Oriented Interface

public function getSSLServerCertFingerprintSHA1();

Procedural Interface

inpay_recurringbilling_get($res, 136 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertFingerprintSHA256 Property (InPay_RecurringBilling Class)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Object Oriented Interface

public function getSSLServerCertFingerprintSHA256();

Procedural Interface

inpay_recurringbilling_get($res, 137 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertIssuer Property (InPay_RecurringBilling Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLServerCertIssuer();

Procedural Interface

inpay_recurringbilling_get($res, 138 );

Default Value

''

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLServerCertPrivateKey Property (InPay_RecurringBilling Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLServerCertPrivateKey();

Procedural Interface

inpay_recurringbilling_get($res, 139 );

Default Value

''

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSLServerCertPrivateKey may be available but not exportable. In this case, SSLServerCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLServerCertPrivateKeyAvailable Property (InPay_RecurringBilling Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLServerCertPrivateKeyAvailable();

Procedural Interface

inpay_recurringbilling_get($res, 140 );

Default Value

false

Remarks

Whether a SSLServerCertPrivateKey is available for the selected certificate. If SSLServerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLServerCertPrivateKeyContainer Property (InPay_RecurringBilling Class)

The name of the PrivateKey container for the certificate (if available).

Object Oriented Interface

public function getSSLServerCertPrivateKeyContainer();

Procedural Interface

inpay_recurringbilling_get($res, 141 );

Default Value

''

Remarks

The name of the SSLServerCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLServerCertPublicKey Property (InPay_RecurringBilling Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLServerCertPublicKey();

Procedural Interface

inpay_recurringbilling_get($res, 142 );

Default Value

''

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSLServerCertPublicKeyAlgorithm Property (InPay_RecurringBilling Class)

The textual description of the certificate's public key algorithm.

Object Oriented Interface

public function getSSLServerCertPublicKeyAlgorithm();

Procedural Interface

inpay_recurringbilling_get($res, 143 );

Default Value

''

Remarks

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.

This property is read-only.

Data Type

String

SSLServerCertPublicKeyLength Property (InPay_RecurringBilling Class)

The length of the certificate's public key (in bits).

Object Oriented Interface

public function getSSLServerCertPublicKeyLength();

Procedural Interface

inpay_recurringbilling_get($res, 144 );

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSLServerCertSerialNumber Property (InPay_RecurringBilling Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLServerCertSerialNumber();

Procedural Interface

inpay_recurringbilling_get($res, 145 );

Default Value

''

Remarks

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.

This property is read-only.

Data Type

String

SSLServerCertSignatureAlgorithm Property (InPay_RecurringBilling Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLServerCertSignatureAlgorithm();

Procedural Interface

inpay_recurringbilling_get($res, 146 );

Default Value

''

Remarks

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.

This property is read-only.

Data Type

String

SSLServerCertStore Property (InPay_RecurringBilling Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLServerCertStore();

Procedural Interface

inpay_recurringbilling_get($res, 147 );

Default Value

'MY'

Remarks

The name of the certificate store for the client certificate.

The SSLServerCertStoreType property denotes the type of the certificate store specified by SSLServerCertStore. If the store is password-protected, specify the password in SSLServerCertStorePassword.

SSLServerCertStore is used in conjunction with the SSLServerCertSubject property to specify client certificates. If SSLServerCertStore has a value, and SSLServerCertSubject or SSLServerCertEncoded is set, a search for a certificate is initiated. Please see the SSLServerCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

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).

This property is read-only.

Data Type

Binary String

SSLServerCertStorePassword Property (InPay_RecurringBilling Class)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Object Oriented Interface

public function getSSLServerCertStorePassword();

Procedural Interface

inpay_recurringbilling_get($res, 148 );

Default Value

''

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

This property is read-only.

Data Type

String

SSLServerCertStoreType Property (InPay_RecurringBilling Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLServerCertStoreType();

Procedural Interface

inpay_recurringbilling_get($res, 149 );

Default Value

0

Remarks

The type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

This property is read-only.

Data Type

Integer

SSLServerCertSubjectAltNames Property (InPay_RecurringBilling Class)

Comma-separated lists of alternative subject names for the certificate.

Object Oriented Interface

public function getSSLServerCertSubjectAltNames();

Procedural Interface

inpay_recurringbilling_get($res, 150 );

Default Value

''

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLServerCertThumbprintMD5 Property (InPay_RecurringBilling Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintMD5();

Procedural Interface

inpay_recurringbilling_get($res, 151 );

Default Value

''

Remarks

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.

This property is read-only.

Data Type

String

SSLServerCertThumbprintSHA1 Property (InPay_RecurringBilling Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintSHA1();

Procedural Interface

inpay_recurringbilling_get($res, 152 );

Default Value

''

Remarks

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.

This property is read-only.

Data Type

String

SSLServerCertThumbprintSHA256 Property (InPay_RecurringBilling Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintSHA256();

Procedural Interface

inpay_recurringbilling_get($res, 153 );

Default Value

''

Remarks

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.

This property is read-only.

Data Type

String

SSLServerCertUsage Property (InPay_RecurringBilling Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLServerCertUsage();

Procedural Interface

inpay_recurringbilling_get($res, 154 );

Default Value

''

Remarks

The text description of SSLServerCertUsageFlags.

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.

This property is read-only.

Data Type

String

SSLServerCertUsageFlags Property (InPay_RecurringBilling Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLServerCertUsageFlags();

Procedural Interface

inpay_recurringbilling_get($res, 155 );

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLServerCertUsageFlags is a combination of the following flags:

Please see the SSLServerCertUsage property for a text representation of SSLServerCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

SSLServerCertVersion Property (InPay_RecurringBilling Class)

The certificate's version number.

Object Oriented Interface

public function getSSLServerCertVersion();

Procedural Interface

inpay_recurringbilling_get($res, 156 );

Default Value

''

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSLServerCertSubject Property (InPay_RecurringBilling Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLServerCertSubject();

Procedural Interface

inpay_recurringbilling_get($res, 157 );

Default Value

''

Remarks

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 property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

This property is read-only.

Data Type

String

SSLServerCertEncoded Property (InPay_RecurringBilling Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLServerCertEncoded();

Procedural Interface

inpay_recurringbilling_get($res, 158 );

Default Value

''

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLServerCertStore and SSLServerCertSubject properties also may be used to specify a certificate.

When SSLServerCertEncoded is set, a search is initiated in the current SSLServerCertStore for the private key of the certificate. If the key is found, SSLServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLServerCertSubject is set to an empty string.

This property is read-only and not available at design time.

Data Type

Binary String

SubscriptionDesc Property (InPay_RecurringBilling Class)

Description of recurring subscription.

Object Oriented Interface

public function getSubscriptionDesc();
public function setSubscriptionDesc($value);

Procedural Interface

inpay_recurringbilling_get($res, 159 );
inpay_recurringbilling_set($res, 159, $value );

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

SubscriptionDetailsCardExpMonth Property (InPay_RecurringBilling Class)

The expiration month of the card currently being processed for the recurring payments.

Object Oriented Interface

public function getSubscriptionDetailsCardExpMonth();

Procedural Interface

inpay_recurringbilling_get($res, 160 );

Default Value

0

Remarks

The expiration month of the card currently being processed for the recurring payments.

This property is read-only and not available at design time.

Data Type

Integer

SubscriptionDetailsCardExpYear Property (InPay_RecurringBilling Class)

The expiration year of the card currently being processed for the recurring payments.

Object Oriented Interface

public function getSubscriptionDetailsCardExpYear();

Procedural Interface

inpay_recurringbilling_get($res, 161 );

Default Value

0

Remarks

The expiration year of the card currently being processed for the recurring payments.

This property is read-only and not available at design time.

Data Type

Integer

SubscriptionDetailsCardNumber Property (InPay_RecurringBilling Class)

The card number currently being processed for the recurring payments.

Object Oriented Interface

public function getSubscriptionDetailsCardNumber();

Procedural Interface

inpay_recurringbilling_get($res, 162 );

Default Value

''

Remarks

The card number currently being processed for the recurring payments.

This property is read-only and not available at design time.

Data Type

String

SubscriptionDetailsEndDate Property (InPay_RecurringBilling Class)

The date in which the recurring payments will stop processing.

Object Oriented Interface

public function getSubscriptionDetailsEndDate();

Procedural Interface

inpay_recurringbilling_get($res, 163 );

Default Value

''

Remarks

The date in which the recurring payments will stop processing.

The date is returned in the format specified within the DateFormat config.

This property is read-only and not available at design time.

Data Type

String

SubscriptionDetailsFrequency Property (InPay_RecurringBilling Class)

The frequency in which payments will occur.

Object Oriented Interface

public function getSubscriptionDetailsFrequency();

Procedural Interface

inpay_recurringbilling_get($res, 164 );

Default Value

''

Remarks

The frequency in which payments will occur.

If SubscriptionDetailsFrequencyUnit is applicable, this property will contain the length of the corresponding SubscriptionDetailsFrequencyUnit 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

This property is read-only and not available at design time.

Data Type

String

SubscriptionDetailsFrequencyUnit Property (InPay_RecurringBilling Class)

The unit frequency in which the payments will be processed.

Object Oriented Interface

public function getSubscriptionDetailsFrequencyUnit();

Procedural Interface

inpay_recurringbilling_get($res, 165 );

Default Value

''

Remarks

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

This property is read-only and not available at design time.

Data Type

String

SubscriptionDetailsLastPaymentDate Property (InPay_RecurringBilling Class)

The date that the last/previous transaction was processed.

Object Oriented Interface

public function getSubscriptionDetailsLastPaymentDate();

Procedural Interface

inpay_recurringbilling_get($res, 166 );

Default Value

''

Remarks

The date that the last/previous transaction was processed.

The date is returned in the format specified within the DateFormat config.

This property is read-only and not available at design time.

Data Type

String

SubscriptionDetailsNextPaymentDate Property (InPay_RecurringBilling Class)

The date of the next upcoming transaction.

Object Oriented Interface

public function getSubscriptionDetailsNextPaymentDate();

Procedural Interface

inpay_recurringbilling_get($res, 167 );

Default Value

''

Remarks

The date of the next upcoming transaction.

The date is returned in the format specified within the DateFormat config.

This property is read-only and not available at design time.

Data Type

String

SubscriptionDetailsRecurAmount Property (InPay_RecurringBilling Class)

The amount being charged on a recurring basis.

Object Oriented Interface

public function getSubscriptionDetailsRecurAmount();

Procedural Interface

inpay_recurringbilling_get($res, 168 );

Default Value

''

Remarks

The amount being charged on a recurring basis.

This property is read-only and not available at design time.

Data Type

String

SubscriptionDetailsRemainingPayments Property (InPay_RecurringBilling Class)

The total number of remaining payments until the recurring payments will stop processing.

Object Oriented Interface

public function getSubscriptionDetailsRemainingPayments();

Procedural Interface

inpay_recurringbilling_get($res, 169 );

Default Value

0

Remarks

The total number of remaining payments until the recurring payments will stop processing.

This property is read-only and not available at design time.

Data Type

Integer

SubscriptionDetailsStartDate Property (InPay_RecurringBilling Class)

The date in which the recurring payments started processing.

Object Oriented Interface

public function getSubscriptionDetailsStartDate();

Procedural Interface

inpay_recurringbilling_get($res, 170 );

Default Value

''

Remarks

The date in which the recurring payments started processing.

The date is returned in the format specified within the DateFormat config.

This property is read-only and not available at design time.

Data Type

String

SubscriptionDetailsStatus Property (InPay_RecurringBilling Class)

The current status of the recurring subscription.

Object Oriented Interface

public function getSubscriptionDetailsStatus();

Procedural Interface

inpay_recurringbilling_get($res, 171 );

Default Value

''

Remarks

The current status of the recurring subscription.

This property is read-only and not available at design time.

Data Type

String

SubscriptionDetailsSubscriptionId Property (InPay_RecurringBilling Class)

Contains the Subscription or Profile Identifier for the recurring payment.

Object Oriented Interface

public function getSubscriptionDetailsSubscriptionId();

Procedural Interface

inpay_recurringbilling_get($res, 172 );

Default Value

''

Remarks

Contains the Subscription or Profile Identifier for the recurring payment.

This property contains a subscription identifier or profile number used to reference a recurring payment.

This property is read-only and not available at design time.

Data Type

String

SubscriptionDetailsSubscriptionName Property (InPay_RecurringBilling Class)

Contains the name of the recurring subscription or profile.

Object Oriented Interface

public function getSubscriptionDetailsSubscriptionName();

Procedural Interface

inpay_recurringbilling_get($res, 173 );

Default Value

''

Remarks

Contains the name of the recurring subscription or profile.

This property is read-only and not available at design time.

Data Type

String

SubscriptionDetailsTotalPayments Property (InPay_RecurringBilling Class)

The total number of payments.

Object Oriented Interface

public function getSubscriptionDetailsTotalPayments();

Procedural Interface

inpay_recurringbilling_get($res, 174 );

Default Value

0

Remarks

The total number of payments.

This property is read-only and not available at design time.

Data Type

Integer

SubscriptionName Property (InPay_RecurringBilling Class)

The name of the recurring subscription or profile.

Object Oriented Interface

public function getSubscriptionName();
public function setSubscriptionName($value);

Procedural Interface

inpay_recurringbilling_get($res, 175 );
inpay_recurringbilling_set($res, 175, $value );

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 (InPay_RecurringBilling Class)

Turns test mode on and off for transactions sent to the current Gateway .

Object Oriented Interface

public function getTestMode();
public function setTestMode($value);

Procedural Interface

inpay_recurringbilling_get($res, 176 );
inpay_recurringbilling_set($res, 176, $value );

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 (InPay_RecurringBilling Class)

A timeout for the class.

Object Oriented Interface

public function getTimeout();
public function setTimeout($value);

Procedural Interface

inpay_recurringbilling_get($res, 177 );
inpay_recurringbilling_set($res, 177, $value );

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 (InPay_RecurringBilling Class)

Merchant-generated transaction Id used for all transactions.

Object Oriented Interface

public function getTransactionId();
public function setTransactionId($value);

Procedural Interface

inpay_recurringbilling_get($res, 178 );
inpay_recurringbilling_set($res, 178, $value );

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 (InPay_RecurringBilling Class)

Adds a special field name and the corresponding value.

Object Oriented Interface

public function doAddSpecialField($name, $value);

Procedural Interface

inpay_recurringbilling_do_addspecialfield($res, $name, $value);

Remarks

Please refer to the SpecialFieldName and SpecialFieldValue properties for more information on form variables and how they are managed.

CancelSubscription Method (InPay_RecurringBilling Class)

Cancels or deletes a recurring payment subscription.

Object Oriented Interface

public function doCancelSubscription($subscriptionid);

Procedural Interface

inpay_recurringbilling_do_cancelsubscription($res, $subscriptionid);

Remarks

This method is used to cancel or delete a recurring subscription identified by the specified SubscriptionId.

Config Method (InPay_RecurringBilling Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

inpay_recurringbilling_do_config($res, $configurationstring);

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.

CreateSubscription Method (InPay_RecurringBilling Class)

Creates a new recurring subscription.

Object Oriented Interface

public function doCreateSubscription();

Procedural Interface

inpay_recurringbilling_do_createsubscription($res);

Remarks

This method is used to create a recurring subscription based upon the payment details entered via PaymentSchedule.

DoEvents Method (InPay_RecurringBilling Class)

This method processes events from the internal message queue.

Object Oriented Interface

public function doEvents();

Procedural Interface

inpay_recurringbilling_do_doevents($res);

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.

GetResponseVar Method (InPay_RecurringBilling Class)

Parses additional information out of the response.

Object Oriented Interface

public function doGetResponseVar($name);

Procedural Interface

inpay_recurringbilling_do_getresponsevar($res, $name);

Remarks

Due to the fact that this class supports so many gateways, only the most commonly used response variables are parsed into the Response properties. Any additional response information contained within the ResponseData may be retrieved with this GetResponseVar method. There are three formats for the ResponseData 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 ResponseData property contains name/value pairs, pass the name in the Name parameter and this method will return the value. For instance, if ResponseData contains "ResponseCode=00&FraudScore=53&ApprovalCode=123456&...", calling GetResponseVar("FraudScore") will return "53".

However, if ResponseData contains a delimited list, pass the index of the field you wish to receive. For instance, if ResponseData contains "00|53|123456|...", calling GetResponseVar("1") will return "53".

Finally, if ResponseData contains XML, pass the xpath to the value you wish to receive. For instance, if ResponseData contains "<Response><Code>00</Code><FraudScore>53</FraudScore><ApprovalCode>123456</ApprovalCode></Response>", calling GetResponseVar("/Response/FraudScore") will return "53".

GetSubscriptionStatus Method (InPay_RecurringBilling Class)

Retrieves the status of a recurring payment subscription.

Object Oriented Interface

public function doGetSubscriptionStatus($subscriptionid);

Procedural Interface

inpay_recurringbilling_do_getsubscriptionstatus($res, $subscriptionid);

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.

Interrupt Method (InPay_RecurringBilling Class)

Interrupts the current action.

Object Oriented Interface

public function doInterrupt();

Procedural Interface

inpay_recurringbilling_do_interrupt($res);

Remarks

This method interrupts any processing that the class is currently executing.

ResetSpecialFields Method (InPay_RecurringBilling Class)

Resets all special fields to the default settings.

Object Oriented Interface

public function doResetSpecialFields();

Procedural Interface

inpay_recurringbilling_do_resetspecialfields($res);

Remarks

This function resets all special gateway configuration fields to the default settings for the specified Gateway.

Please refer to the SpecialFieldName and SpecialFieldValue properties for more information on form variables and how they are managed.

UpdateSubscription Method (InPay_RecurringBilling Class)

Updates a recurring payment subscription.

Object Oriented Interface

public function doUpdateSubscription($subscriptionid);

Procedural Interface

inpay_recurringbilling_do_updatesubscription($res, $subscriptionid);

Remarks

This method is used to update a recurring subscription, specified by SubscriptionId. Specify new values via PaymentSchedule before calling this method.

Error Event (InPay_RecurringBilling Class)

Information about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

inpay_recurringbilling_register_callback($res, 1, array($this, 'fireError'));

Parameter List

 'errorcode'
 'description'

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 (InPay_RecurringBilling Class)

Fired after the server presents its certificate to the client.

Object Oriented Interface

public function fireSSLServerAuthentication($param);

Procedural Interface

inpay_recurringbilling_register_callback($res, 2, array($this, 'fireSSLServerAuthentication'));

Parameter List

 'certencoded'
 'certsubject'
 'certissuer'
 'status'
 'accept'

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 (InPay_RecurringBilling Class)

Fired when secure connection progress messages are available.

Object Oriented Interface

public function fireSSLStatus($param);

Procedural Interface

inpay_recurringbilling_register_callback($res, 3, array($this, 'fireSSLStatus'));

Parameter List

 'message'

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

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

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

Socket Config Settings

Base Config Settings

Trappable Errors (RecurringBilling Class)

RecurringBilling Errors

The class may also return one of the following error codes, which are inherited from other classes.

HTTP Errors

The class may also return one of the following error codes, which are inherited from other classes.

TCPClient Errors

SSL Errors

TCP/IP Errors