The cl-creditcard Reference Manual

Table of Contents

The cl-creditcard Reference Manual

This is the cl-creditcard Reference Manual, version 0.1, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 11:02:42 2018 GMT+0.

1 Introduction

= CL-Creditcard =
CL-CreditCard is a common lisp library providing a common interface to charge creditcards.

== CL-Authorize-NET ==
CL-Authorize-net is a common lisp library for payment processing via Authorize.net.  It implements the CL-Creditcard interface.

''CL-Authorize-net is production ready and is in use.''

=== Example ===

(require :cl-authorize-net)
(defvar *auth-net* (make-instance 'cl-authorize-net:authorize-processor 
				  :login "YOUR LOGIN" 
				  :trankey "YOUR TRANKEY" 
				  :test-mode :full))
(cl-authorize-net:sale *auth-data*
		       (make-instance 'cl-authorize-net:authorize-data
				      :account "4222222222222" :expdate "06/11"
				      :first-name "Test")
		       5)



=== Objects ===
* authorize-processor
* authorize-data - holds information relevant to making credit-card charges
* echeck-data - holds information relevant to making ACH / echeck charges

=== Methods ===

All operations are based around a authorize-processor instance.

* (authorize processor data amount)
Do a pre-authorization without capture returning a
transaction identifier that can later be used with preauth-capture.

Not valid with echeck-data.

* (preauth-capture processor transaction-id &key amount)
Capture a charge that was previously authorized with authorize.
Some processors allow capturing a different amount than was originally authorized.

Not valid with echeck-data.

* (sale processor data amount)
Do a one time charge on a credit card for an amount using
the given processor. Other provided keys are up to the processor to interpret
or ignore.

Returns the transaction's unique identifier if successful.
* (void processor transaction-id)
Void a previous transaction.

== CL-Monetra ==
CL-Monetra is a common lisp library for payment processing via CL-Monetra.  It implements the CL-Creditcard interface

''CAUTION: This processor was in development and then abandoned.  See code in the monetra-dev branch if you want to use monetra''

2 Systems

The main system appears first, followed by any subsystem dependency.

2.1 cl-creditcard

Author

<programmers@acceleration.net>

License

MIT

Description

Generic interace library for talking with credit card processors.

Version

0.1

Dependency

iterate

Source

cl-creditcard.asd (file)

Component

src (module)

3 Modules

Modules are listed depth-first from the system components tree.

3.1 cl-creditcard/src

Parent

cl-creditcard (system)

Location

src/

Components

• packages.lisp (file)
• credit-card-api.lisp (file)
• util.lisp (file)

4 Files

Files are sorted by type and then listed depth-first from the systems components trees.

4.1 Lisp

4.1.1 cl-creditcard.asd

Location

cl-creditcard.asd

Systems

cl-creditcard (system)

Packages

cl-creditcard.system

4.1.2 cl-creditcard/src/packages.lisp

Parent

src (module)

Location

src/packages.lisp

Packages

cl-creditcard

4.1.3 cl-creditcard/src/credit-card-api.lisp

Dependency

packages.lisp (file)

Parent

src (module)

Location

src/credit-card-api.lisp

Exported Definitions

• account (method)
• (setf account) (method)
• address (method)
• (setf address) (method)
• authorize (generic function)
• cc-data (class)
• ccv (method)
• (setf ccv) (method)
• deny-exception (condition)
• enough-data-p (generic function)
• expdate (method)
• (setf expdate) (method)
• luhn-check-p (generic function)
• preauth-capture (generic function)
• sale (generic function)
• void (generic function)
• zip (method)
• (setf zip) (method)

Internal Definitions

• cc-error (condition)
• credit (generic function)
• user-message (method)
• (setf user-message) (method)
• verbiage (method)
• (setf verbiage) (method)

4.1.4 cl-creditcard/src/util.lisp

Dependency

credit-card-api.lisp (file)

Parent

src (module)

Location

src/util.lisp

Internal Definitions

• read-keyword-from-string (function)
• replace-all (function)

5 Packages

Packages are listed by definition order.

5.1 cl-creditcard.system

Source

cl-creditcard.asd

Use List

• asdf/interface
• common-lisp

5.2 cl-creditcard

Library for charging credit cards.

Source

packages.lisp (file)

Nickname

clcc

Use List

• iterate
• common-lisp

Exported Definitions

• account (generic function)
• account (method)
• (setf account) (method)
• (setf account) (generic function)
• address (generic function)
• address (method)
• (setf address) (method)
• (setf address) (generic function)
• authorize (generic function)
• cc-data (class)
• ccv (generic function)
• ccv (method)
• (setf ccv) (method)
• (setf ccv) (generic function)
• deny-exception (condition)
• enough-data-p (generic function)
• expdate (generic function)
• expdate (method)
• (setf expdate) (method)
• (setf expdate) (generic function)
• luhn-check-p (generic function)
• preauth-capture (generic function)
• sale (generic function)
• void (generic function)
• zip (generic function)
• zip (method)
• (setf zip) (method)
• (setf zip) (generic function)

Internal Definitions

• cc-error (condition)
• credit (generic function)
• read-keyword-from-string (function)
• replace-all (function)
• user-message (generic function)
• user-message (method)
• (setf user-message) (method)
• (setf user-message) (generic function)
• verbiage (generic function)
• verbiage (method)
• (setf verbiage) (method)
• (setf verbiage) (generic function)

6 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.

6.1 Exported definitions

6.1.1 Generic functions

Generic Function: account OBJECT

Generic Function: (setf account) NEW-VALUE OBJECT

Package

cl-creditcard

Methods

Method: account (CC-DATA cc-data)

Method: (setf account) NEW-VALUE (CC-DATA cc-data)

The card number.

Source

credit-card-api.lisp (file)

Generic Function: address OBJECT

Generic Function: (setf address) NEW-VALUE OBJECT

Package

cl-creditcard

Methods

Method: address (CC-DATA cc-data)

Method: (setf address) NEW-VALUE (CC-DATA cc-data)

Street address for AVS. Typically only numbers need to
be passed in this fields. Letters and other characters are ignored.

Source

credit-card-api.lisp (file)

Generic Function: authorize PROCESSOR CC-DATA AMOUNT &key &allow-other-keys

Do a pre-authorization without capture returning a
transaction identifier that can later be used with preauth-capture.

Package

cl-creditcard

Source

credit-card-api.lisp (file)

Generic Function: ccv OBJECT

Generic Function: (setf ccv) NEW-VALUE OBJECT

Package

cl-creditcard

Methods

Method: ccv (CC-DATA cc-data)

Method: (setf ccv) NEW-VALUE (CC-DATA cc-data)

Card [Code] Verification value. Usually 3-4 digits on back of card.

Source

credit-card-api.lisp (file)

Generic Function: enough-data-p CC-DATA &key REQUIRE-AVS REQUIRE-CCV ERROR-P

Check that a cc-data like structure has enough data to
complete a transaction.
Can optionally require that AVS verification, Card Verfication data be present. Can optionally signal an error if data isn’t present.

Some merchant accounts will incur extra fees if AVS isn’t used.

Package

cl-creditcard

Source

credit-card-api.lisp (file)

Generic Function: expdate OBJECT

Generic Function: (setf expdate) NEW-VALUE OBJECT

Package

cl-creditcard

Methods

Method: expdate (CC-DATA cc-data)

Method: (setf expdate) NEW-VALUE (CC-DATA cc-data)

The card expiration date

Source

credit-card-api.lisp (file)

Generic Function: luhn-check-p CARD-NUMBER

Check the credit-card number is valid looking based on
the luhn algorithm: http://en.wikipedia.org/wiki/Luhn_algorithm

Package

cl-creditcard

Source

credit-card-api.lisp (file)

Generic Function: preauth-capture PROCESSOR TRANSACTION-ID &key AMOUNT &allow-other-keys

Capture a charge that was previously authorized with authorize.
Some processors allow capturing a different amount than was originally authorized.

Package

cl-creditcard

Source

credit-card-api.lisp (file)

Generic Function: sale PROCESSOR CC-DATA AMOUNT &key &allow-other-keys

Do a one time charge on a credit card for an amount using
the given processor. Other provided keys are up to the processor to interpret or ignore.

Returns the transaction’s unique identifier if successful.

Package

cl-creditcard

Source

credit-card-api.lisp (file)

Generic Function: void PROCESSOR TRANSACTION-ID &key &allow-other-keys

Void a previous transaction.

Package

cl-creditcard

Source

credit-card-api.lisp (file)

Generic Function: zip OBJECT

Generic Function: (setf zip) NEW-VALUE OBJECT

Package

cl-creditcard

Methods

Method: zip (CC-DATA cc-data)

Method: (setf zip) NEW-VALUE (CC-DATA cc-data)

Zipcode for AVS verfication.

Source

credit-card-api.lisp (file)

6.1.2 Conditions

Condition: deny-exception ()

Error signalled when the CC is denied and error signalling is requested.

Package

cl-creditcard

Source

credit-card-api.lisp (file)

Direct superclasses

cc-error (condition)

6.1.3 Classes

Class: cc-data ()

Class to hold data that normally goes with a credit card charge.
We interact with this class only through the accessors and never actually check
the type, so you can feed it any data structure that responds to these set of accessors.

Package

cl-creditcard

Source

credit-card-api.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• zip (method)
• zip (method)
• address (method)
• address (method)
• ccv (method)
• ccv (method)
• expdate (method)
• expdate (method)
• account (method)
• account (method)

Direct slots

Slot: account

The card number.

Initargs

:account

Readers

account (generic function)

Writers

(setf account) (generic function)

Slot: expdate

The card expiration date

Initargs

:expdate

Readers

expdate (generic function)

Writers

(setf expdate) (generic function)

Slot: ccv

Card [Code] Verification value. Usually 3-4 digits on back of card.

Initargs

:ccv

Readers

ccv (generic function)

Writers

(setf ccv) (generic function)

Slot: address

Street address for AVS. Typically only numbers need to
be passed in this fields. Letters and other characters are ignored.

Initargs

:address

Readers

address (generic function)

Writers

(setf address) (generic function)

Slot: zip

Zipcode for AVS verfication.

Initargs

:zip

Readers

zip (generic function)

Writers

(setf zip) (generic function)

6.2 Internal definitions

6.2.1 Functions

Function: read-keyword-from-string STR

Safely read a string into the keyword package.

Package

cl-creditcard

Source

util.lisp (file)

Function: replace-all STRING PART REPLACEMENT &key TEST

Returns a new string in which all the occurences of the part
is replaced with replacement. [FROM http://cl-cookbook.sourceforge.net/strings.html#manip]

Package

cl-creditcard

Source

util.lisp (file)

6.2.2 Generic functions

Generic Function: credit PROCESSOR CC-DATA &key TRANSACTION-ID AMOUNT &allow-other-keys

Credit a charge, if transaction-id is present this is a credit against a precviouly charged authorization

Package

cl-creditcard

Source

credit-card-api.lisp (file)

Generic Function: user-message CONDITION

Generic Function: (setf user-message) NEW-VALUE CONDITION

Package

cl-creditcard

Methods

Method: user-message (CONDITION cc-error)

Method: (setf user-message) NEW-VALUE (CONDITION cc-error)

Source

credit-card-api.lisp (file)

Generic Function: verbiage CONDITION

Generic Function: (setf verbiage) NEW-VALUE CONDITION

Package

cl-creditcard

Methods

Method: verbiage (CONDITION cc-error)

Method: (setf verbiage) NEW-VALUE (CONDITION cc-error)

Source

credit-card-api.lisp (file)

6.2.3 Conditions

Condition: cc-error ()

Requested errors when processing the credit will inherit
from here. user-message, when supplied, should be a safe string to display to clients informing them of the error.

Package

cl-creditcard

Source

credit-card-api.lisp (file)

Direct superclasses

simple-error (condition)

Direct subclasses

deny-exception (condition)

Direct methods

• verbiage (method)
• verbiage (method)
• user-message (method)
• user-message (method)

Direct slots

Slot: user-message

Initargs

:user-message

Initform

(quote nil)

Readers

user-message (generic function)

Writers

(setf user-message) (generic function)

Slot: verbiage

human-interpretable response code
(meant for system display to clerk)

Initargs

:verbiage

Readers

verbiage (generic function)

Writers

(setf verbiage) (generic function)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types