The cl-paypal Reference Manual

Next: , Previous: , Up: (dir)   [Contents][Index]

The cl-paypal Reference Manual

This is the cl-paypal Reference Manual, version 0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Thu Sep 15 04:03:27 2022 GMT+0.

Table of Contents

Next: , Previous: , Up: The cl-paypal Reference Manual   [Contents][Index]

1 Introduction

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

Next: , Previous: , Up: The cl-paypal Reference Manual   [Contents][Index]

2 Systems

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

Previous: , Up: Systems   [Contents][Index]

2.1 cl-paypal

A paypal express checkout API in Common Lisp.

Maintainer

Plato Wu <netawater@gmail.com>

Author

Hans Huebner <hans@huebner.org>

License

BSD

Version

0.1

Dependencies
  • hunchentoot (system).
  • drakma (system).
  • cl-ppcre (system).
Source

cl-paypal.asd.

Child Components

Next: , Previous: , Up: The cl-paypal Reference Manual   [Contents][Index]

3 Files

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

Previous: , Up: Files   [Contents][Index]

3.1 Lisp

Next: , Previous: , Up: Lisp   [Contents][Index]

3.1.1 cl-paypal/cl-paypal.asd

Source

cl-paypal.asd.

Parent Component

cl-paypal (system).

ASDF Systems

cl-paypal.

Packages

cl-paypal-system.

Next: , Previous: , Up: Lisp   [Contents][Index]

3.1.2 cl-paypal/package.lisp

Source

cl-paypal.asd.

Parent Component

cl-paypal (system).

Packages

cl-paypal.

Next: , Previous: , Up: Lisp   [Contents][Index]

3.1.3 cl-paypal/config.lisp

Dependency

package.lisp (file).

Source

cl-paypal.asd.

Parent Component

cl-paypal (system).

Public Interface
Internals

Previous: , Up: Lisp   [Contents][Index]

3.1.4 cl-paypal/cl-paypal.lisp

Dependency

config.lisp (file).

Source

cl-paypal.asd.

Parent Component

cl-paypal (system).

Public Interface
Internals

Next: , Previous: , Up: The cl-paypal Reference Manual   [Contents][Index]

4 Packages

Packages are listed by definition order.

Next: , Previous: , Up: Packages   [Contents][Index]

4.1 cl-paypal

Source

package.lisp.

Use List

common-lisp.

Public Interface
Internals

Previous: , Up: Packages   [Contents][Index]

4.2 cl-paypal-system

Source

cl-paypal.asd.

Use List
  • asdf/interface.
  • common-lisp.

Next: , Previous: , Up: The cl-paypal Reference Manual   [Contents][Index]

5 Definitions

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

Next: , Previous: , Up: Definitions   [Contents][Index]

5.1 Public Interface

Next: , Previous: , Up: Public Interface   [Contents][Index]

5.1.1 Special variables

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

invoke garbage collection when it is reached.

Package

cl-paypal.

Source

config.lisp.

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

the max value of live period for token in minute

Package

cl-paypal.

Source

config.lisp.

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

max number of simultaneous transaction per ip

Package

cl-paypal.

Source

config.lisp.

Next: , Previous: , Up: Public Interface   [Contents][Index]

5.1.2 Ordinary functions

Function: get-and-do-express-checkout (success failure)
Package

cl-paypal.

Source

cl-paypal.lisp.

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.

Function: make-express-checkout-url (amount ip &key return-url cancel-url useraction currencycode sandbox hostname)
Package

cl-paypal.

Source

cl-paypal.lisp.

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.

Previous: , Up: Public Interface   [Contents][Index]

5.1.3 Conditions

Condition: http-request-error
Package

cl-paypal.

Source

cl-paypal.lisp.

Direct superclasses

paypal-error.

Direct slots
Slot: http-status
Initargs

:http-status

Slot: response-string
Initargs

:response-string

Condition: paypal-error
Package

cl-paypal.

Source

cl-paypal.lisp.

Direct superclasses

error.

Direct subclasses
Condition: request-error
Package

cl-paypal.

Source

cl-paypal.lisp.

Direct superclasses

paypal-error.

Condition: response-error
Package

cl-paypal.

Source

cl-paypal.lisp.

Direct superclasses

paypal-error.

Direct subclasses

transaction-already-confirmed-error.

Direct methods
Direct slots
Slot: response
Initargs

:response

Readers

response-error-response.

Writers

(setf response-error-response).

Slot: invalid-parameter
Initargs

:invalid-parameter

Condition: transaction-already-confirmed-error
Package

cl-paypal.

Source

cl-paypal.lisp.

Direct superclasses

response-error.

Previous: , Up: Definitions   [Contents][Index]

5.2 Internals

Next: , Previous: , Up: Internals   [Contents][Index]

5.2.1 Special variables

Special Variable: *active-transactions*
Package

cl-paypal.

Source

cl-paypal.lisp.

Special Variable: *paypal-api-url*

NVP URL of the Paypal server

Package

cl-paypal.

Source

config.lisp.

Special Variable: *paypal-cancel-url*

cancel url if cancel paypal express checkout

Package

cl-paypal.

Source

config.lisp.

Special Variable: *paypal-currencycode*

currency for paypal express checkout

Package

cl-paypal.

Source

config.lisp.

Special Variable: *paypal-password*

Password to use to authenticate at the Paypal server

Package

cl-paypal.

Source

config.lisp.

Special Variable: *paypal-return-url*

return url for finishing paypal express checkout

Package

cl-paypal.

Source

config.lisp.

Special Variable: *paypal-signature*

Signature to use to authenticate at the Paypal server

Package

cl-paypal.

Source

config.lisp.

Special Variable: *paypal-user*

Username to use to authenticate at the Paypal server

Package

cl-paypal.

Source

config.lisp.

Special Variable: *paypal-useraction*

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

Package

cl-paypal.

Source

config.lisp.

Special Variable: *transaction-ips*
Package

cl-paypal.

Source

cl-paypal.lisp.

Next: , Previous: , Up: Internals   [Contents][Index]

5.2.2 Ordinary 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.

Function: find-transaction (token &optional errorp)
Package

cl-paypal.

Source

cl-paypal.lisp.

Function: register-transaction (token amount currencycode ip)
Package

cl-paypal.

Source

cl-paypal.lisp.

Function: unregister-transaction (token)
Package

cl-paypal.

Source

cl-paypal.lisp.

Previous: , Up: Internals   [Contents][Index]

5.2.3 Generic functions

Generic Reader: response-error-response (condition)
Generic Writer: (setf response-error-response) (condition)
Package

cl-paypal.

Methods
Reader Method: response-error-response ((condition response-error))
Writer Method: (setf response-error-response) ((condition response-error))
Source

cl-paypal.lisp.

Target Slot

response.

Previous: , Up: The cl-paypal Reference Manual   [Contents][Index]

Appendix A Indexes

Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts

Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

Jump to:   (  
D   F   G   I   M   R   U  
Index Entry  Section
(
(setf response-error-response): Private generic functions
(setf response-error-response): Private generic functions
D
decode-response: Private ordinary functions
F
find-transaction: Private ordinary functions
Function, decode-response: Private ordinary functions
Function, find-transaction: Private ordinary functions
Function, get-and-do-express-checkout: Public ordinary functions
Function, init: Public ordinary functions
Function, make-express-checkout-url: Public ordinary functions
Function, register-transaction: Private ordinary functions
Function, request: Public ordinary functions
Function, unregister-transaction: Private ordinary functions
G
Generic Function, (setf response-error-response): Private generic functions
Generic Function, response-error-response: Private generic functions
get-and-do-express-checkout: Public ordinary functions
I
init: Public ordinary functions
M
make-express-checkout-url: Public ordinary functions
Method, (setf response-error-response): Private generic functions
Method, response-error-response: Private generic functions
R
register-transaction: Private ordinary functions
request: Public ordinary functions
response-error-response: Private generic functions
response-error-response: Private generic functions
U
unregister-transaction: Private ordinary functions
Jump to:   (  
D   F   G   I   M   R   U  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables

Jump to:   *  
H   I   R   S  
Index Entry  Section
*
*active-transactions*: Private special variables
*paypal-api-url*: Private special variables
*paypal-cancel-url*: Private special variables
*paypal-currencycode*: Private special variables
*paypal-max-active-transactions*: Public special variables
*paypal-max-token-live-period*: Public special variables
*paypal-max-transaction-per-ip*: Public special variables
*paypal-password*: Private special variables
*paypal-return-url*: Private special variables
*paypal-signature*: Private special variables
*paypal-user*: Private special variables
*paypal-useraction*: Private special variables
*transaction-ips*: Private special variables
H
http-status: Public conditions
I
invalid-parameter: Public conditions
R
response: Public conditions
response-string: Public conditions
S
Slot, http-status: Public conditions
Slot, invalid-parameter: Public conditions
Slot, response: Public conditions
Slot, response-string: Public conditions
Special Variable, *active-transactions*: Private special variables
Special Variable, *paypal-api-url*: Private special variables
Special Variable, *paypal-cancel-url*: Private special variables
Special Variable, *paypal-currencycode*: Private special variables
Special Variable, *paypal-max-active-transactions*: Public special variables
Special Variable, *paypal-max-token-live-period*: Public special variables
Special Variable, *paypal-max-transaction-per-ip*: Public special variables
Special Variable, *paypal-password*: Private special variables
Special Variable, *paypal-return-url*: Private special variables
Special Variable, *paypal-signature*: Private special variables
Special Variable, *paypal-user*: Private special variables
Special Variable, *paypal-useraction*: Private special variables
Special Variable, *transaction-ips*: Private special variables
Jump to:   *  
H   I   R   S