RecurringBilling Class

Properties   Methods   Events   Configuration Settings   Errors  

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

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, $val);
 inpay_recurringbilling_do_cancelsubscription($res, $subscriptionid);
 inpay_recurringbilling_do_config($res, $configurationstring);
 inpay_recurringbilling_do_createsubscription($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: