The cl-paypal Reference Manual

Table of Contents

The cl-paypal Reference Manual

This is the cl-paypal Reference Manual, version 0.1, generated automatically by Declt version 3.0 "Montgomery Scott" on Tue Dec 22 12:38:52 2020 GMT+0.

1 Introduction

A paypal express checkout API in Common Lisp. 
Please refer cl-paypal-test.lisp for usage.

2 Systems

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

2.1 cl-paypal

Maintainer

Plato Wu <netawater@gmail.com>

Author

Hans Huebner <hans@huebner.org>

License

BSD

Description

A paypal express checkout API in Common Lisp.

Version

0.1

Dependencies

• hunchentoot
• drakma
• cl-ppcre

Source

cl-paypal.asd (file)

Components

• package.lisp (file)
• config.lisp (file)
• cl-paypal.lisp (file)

3 Files

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

3.1 Lisp

3.1.1 cl-paypal.asd

Location

cl-paypal.asd

Systems

cl-paypal (system)

Packages

cl-paypal-system

3.1.2 cl-paypal/package.lisp

Parent

cl-paypal (system)

Location

package.lisp

Packages

cl-paypal

3.1.3 cl-paypal/config.lisp

Dependency

package.lisp (file)

Parent

cl-paypal (system)

Location

config.lisp

Exported Definitions

• *paypal-max-active-transactions* (special variable)
• *paypal-max-token-live-period* (special variable)
• *paypal-max-transaction-per-ip* (special variable)
• init (function)

Internal Definitions

• *paypal-api-url* (special variable)
• *paypal-cancel-url* (special variable)
• *paypal-currencycode* (special variable)
• *paypal-password* (special variable)
• *paypal-return-url* (special variable)
• *paypal-signature* (special variable)
• *paypal-user* (special variable)
• *paypal-useraction* (special variable)

3.1.4 cl-paypal/cl-paypal.lisp

Dependency

config.lisp (file)

Parent

cl-paypal (system)

Location

cl-paypal.lisp

Exported Definitions

• get-and-do-express-checkout (function)
• http-request-error (condition)
• make-express-checkout-url (function)
• paypal-error (condition)
• request (function)
• request-error (condition)
• response-error (condition)
• transaction-already-confirmed-error (condition)

Internal Definitions

• *active-transactions* (special variable)
• *transaction-ips* (special variable)
• decode-response (function)
• find-transaction (function)
• register-transaction (function)
• response-error-response (method)
• (setf response-error-response) (method)
• unregister-transaction (function)

4 Packages

Packages are listed by definition order.

4.1 cl-paypal-system

Source

cl-paypal.asd

Use List

• common-lisp
• asdf/interface

4.2 cl-paypal

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions

• *paypal-max-active-transactions* (special variable)
• *paypal-max-token-live-period* (special variable)
• *paypal-max-transaction-per-ip* (special variable)
• get-and-do-express-checkout (function)
• http-request-error (condition)
• init (function)
• make-express-checkout-url (function)
• paypal-error (condition)
• request (function)
• request-error (condition)
• response-error (condition)
• transaction-already-confirmed-error (condition)

Internal Definitions

• *active-transactions* (special variable)
• *paypal-api-url* (special variable)
• *paypal-cancel-url* (special variable)
• *paypal-currencycode* (special variable)
• *paypal-password* (special variable)
• *paypal-return-url* (special variable)
• *paypal-signature* (special variable)
• *paypal-user* (special variable)
• *paypal-useraction* (special variable)
• *transaction-ips* (special variable)
• decode-response (function)
• find-transaction (function)
• register-transaction (function)
• response-error-response (generic function)
• response-error-response (method)
• (setf response-error-response) (method)
• (setf response-error-response) (generic function)
• unregister-transaction (function)

5 Definitions

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

5.1 Exported definitions

5.1.1 Special variables

Special Variable: *paypal-max-active-transactions*

invoke garbage collection when it is reached.

Package

cl-paypal

Source

config.lisp (file)

Special Variable: *paypal-max-token-live-period*

the max value of live period for token in minute

Package

cl-paypal

Source

config.lisp (file)

Special Variable: *paypal-max-transaction-per-ip*

max number of simultaneous transaction per ip

Package

cl-paypal

Source

config.lisp (file)

5.1.2 Functions

Function: get-and-do-express-checkout SUCCESS FAILURE

Package

cl-paypal

Source

cl-paypal.lisp (file)

Function: init PAYPAL-API-URL PAYPAL-USER PAYPAL-PASSWORD PAYPAL-SIGNATURE PAYPAL-RETURN-URL PAYPAL-CANCEL-URL &key USERACTION CURRENCYCODE

Package

cl-paypal

Source

config.lisp (file)

Function: make-express-checkout-url AMOUNT IP &key RETURN-URL CANCEL-URL USERACTION CURRENCYCODE SANDBOX HOSTNAME

Package

cl-paypal

Source

cl-paypal.lisp (file)

Function: request METHOD &rest ARGS &key &allow-other-keys

Perform a request to the Paypal NVP API. METHOD is the method to use, additional keyword arguments are passed as parameters to the API. Returns

Package

cl-paypal

Source

cl-paypal.lisp (file)

5.1.3 Conditions

Condition: http-request-error ()

Package

cl-paypal

Source

cl-paypal.lisp (file)

Direct superclasses

paypal-error (condition)

Direct slots

Slot: http-status

Initargs

:http-status

Slot: response-string

Initargs

:response-string

Condition: paypal-error ()

Package

cl-paypal

Source

cl-paypal.lisp (file)

Direct superclasses

error (condition)

Direct subclasses

• request-error (condition)
• http-request-error (condition)
• response-error (condition)

Condition: request-error ()

Package

cl-paypal

Source

cl-paypal.lisp (file)

Direct superclasses

paypal-error (condition)

Condition: response-error ()

Package

cl-paypal

Source

cl-paypal.lisp (file)

Direct superclasses

paypal-error (condition)

Direct subclasses

transaction-already-confirmed-error (condition)

Direct methods

• response-error-response (method)
• response-error-response (method)

Direct slots

Slot: response

Initargs

:response

Readers

response-error-response (generic function)

Writers

(setf response-error-response) (generic function)

Slot: invalid-parameter

Initargs

:invalid-parameter

Condition: transaction-already-confirmed-error ()

Package

cl-paypal

Source

cl-paypal.lisp (file)

Direct superclasses

response-error (condition)

5.2 Internal definitions

5.2.1 Special variables

Special Variable: *active-transactions*

Package

cl-paypal

Source

cl-paypal.lisp (file)

Special Variable: *paypal-api-url*

NVP URL of the Paypal server

Package

cl-paypal

Source

config.lisp (file)

Special Variable: *paypal-cancel-url*

cancel url if cancel paypal express checkout

Package

cl-paypal

Source

config.lisp (file)

Special Variable: *paypal-currencycode*

currency for paypal express checkout

Package

cl-paypal

Source

config.lisp (file)

Special Variable: *paypal-password*

Password to use to authenticate at the Paypal server

Package

cl-paypal

Source

config.lisp (file)

Special Variable: *paypal-return-url*

return url for finishing paypal express checkout

Package

cl-paypal

Source

config.lisp (file)

Special Variable: *paypal-signature*

Signature to use to authenticate at the Paypal server

Package

cl-paypal

Source

config.lisp (file)

Special Variable: *paypal-user*

Username to use to authenticate at the Paypal server

Package

cl-paypal

Source

config.lisp (file)

Special Variable: *paypal-useraction*

confirm order on your site or on Paypal, continue or commit, respectively

Package

cl-paypal

Source

config.lisp (file)

Special Variable: *transaction-ips*

Package

cl-paypal

Source

cl-paypal.lisp (file)

5.2.2 Functions

Function: decode-response RESPONSE

Decode a paypal response string, which is URL encoded and follow list encoding rules. Returns the parameters as a plist.

Package

cl-paypal

Source

cl-paypal.lisp (file)

Function: find-transaction TOKEN &optional ERRORP

Package

cl-paypal

Source

cl-paypal.lisp (file)

Function: register-transaction TOKEN AMOUNT CURRENCYCODE IP

Package

cl-paypal

Source

cl-paypal.lisp (file)

Function: unregister-transaction TOKEN

Package

cl-paypal

Source

cl-paypal.lisp (file)

5.2.3 Generic functions

Generic Function: response-error-response CONDITION

Generic Function: (setf response-error-response) NEW-VALUE CONDITION

Package

cl-paypal

Methods

Method: response-error-response (CONDITION response-error)

Method: (setf response-error-response) NEW-VALUE (CONDITION response-error)

Source

cl-paypal.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types