Module : API


his project provides a set of API modules for conducting transactions via provides a PHP SDK with all of the functions necessary for integrating with it's various services. This module uses the SDK (via the Libraries modules) and provides wrapper functions to ease the use of the API for other modules to use.


The core API module (authnet.module) is stable and contains working wrapper functions for CIM and AIM functionality. Other APIs have yet to be added, but the core module is designed to make that easy. Patches are welcome! APIs included:

  • CIM - yes*
  • AIM - yes*
  • ARB -
  • CP -
  • SIM -
  • DPM -
  • TD -

* CIM and AIM are mostly done and working. UI integration for bank accounts and payments are not yet implemented (but there are issues w/ patches started: #1766012 and 1896910).

If you have feature requests, or bug reports, please create an issue.

Included modules: API (authnet.module)

This is the core API module. It provides Drupal wrapper functions for the SDK objects and functions. It is used by all the other sub-modules.

CIM Entity Integration (authnet_cim_entity.module)

This module maintains an association between CIM customer profiles and payment profiles, and entities in Drupal. It does two main things:

  1. Provides two database tables: one for linking customer profiles to entities in Drupal (ie: users), and one for keeping track of payment profiles (ie: credit cards).
  2. Implements hooks provided by the authnet module to add/update/delete records from the abovementioned databases when customer profiles and payment profiles are updated via the API functions. UI (authnet_ui.module)

Provides reusable UI elements like forms (ie: payment profile edit form). User (authnet_user.module)

Maintains an association between CIM customer profiles and Drupal users. Depends on authnet_cim_entity and authnet_ui (above). It provides menu callbacks for users to add/edit/remove payment profiles (ie: manage their credit cards) at /user/[uid]/billing.



  1. Download and install the PHP SDK library (see below)
  2. Download and install the Libraries module.
  3. Download and install this module (authnet).
  4. Enter your Login ID and Transaction Key at /admin/settings/authnet

SDK Installation - Required:

This modules requires the installation of the PHP SDK.

  • Please download the SDK from:
  • Extract the archive and rename the extracted folder to 'anet_php_sdk'
  • Move the folder to your Drupal libraries folder. The default location is: /sites/all/libraries
  • The final path to the autoload.php file should be: /sites/all/libraries/anet_php_sdk/autoload.php

Ubercart/Commerce Integration

Attention: As of the 6.x-1.0-beta1 release, the Ubercart integration module has been moved to a separate contrib project (see below). Download and install that module if you are upgrading from an older release.

Ubercart integration is provided by this project: Ubercart Payment Gateway

Commerce integration is not yet available, but hopefully will be provided via integration with the Payment API module. See for Payment (work in progress).

Other modules:

Part of the reason this module was built was to address the disparity among the existing set of solutions available for Drupal. There are a number of different modules available, each with different goals, and all reinventing the wheel in their own ways.

The following modules provide various forms of integration with Many of them implement their own functions for communicating with the API. If you are a maintainer of any of these, and are interested in leveraging this module's API to make your job easier, let us know!


There are no topics to list.


No tasks.
Groupe de fonctionnalitées
Version de drupal
Creative Commons Licence