The cl-paypal Reference Manual

Table of Contents

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 2.3 "Robert April" on Wed Mar 14 03:28:35 2018 GMT+0.


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

1 Introduction

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

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

2 Systems

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


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

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
Source

cl-paypal.asd (file)

Components

Next: , Previous: , Up: Top   [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 files   [Contents][Index]

3.1.1 cl-paypal.asd

Location

cl-paypal.asd

Systems

cl-paypal (system)

Packages

cl-paypal-system


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

3.1.2 cl-paypal/package.lisp

Parent

cl-paypal (system)

Location

package.lisp

Packages

cl-paypal


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

3.1.3 cl-paypal/config.lisp

Dependency

package.lisp (file)

Parent

cl-paypal (system)

Location

config.lisp

Exported Definitions
Internal Definitions

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

3.1.4 cl-paypal/cl-paypal.lisp

Dependency

config.lisp (file)

Parent

cl-paypal (system)

Location

cl-paypal.lisp

Exported Definitions
Internal Definitions

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

4 Packages

Packages are listed by definition order.


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

4.1 cl-paypal-system

Source

cl-paypal.asd

Use List

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

4.2 cl-paypal

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [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 Exported definitions


Next: , Previous: , Up: Exported definitions   [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 (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)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

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)


Previous: , Up: Exported definitions   [Contents][Index]

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
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
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)


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

5.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

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)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

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)


Previous: , Up: Internal definitions   [Contents][Index]

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)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   C   F   L  
Index Entry  Section

C
cl-paypal.asd: The cl-paypal<dot>asd file
cl-paypal/cl-paypal.lisp: The cl-paypal/cl-paypal<dot>lisp file
cl-paypal/config.lisp: The cl-paypal/config<dot>lisp file
cl-paypal/package.lisp: The cl-paypal/package<dot>lisp file

F
File, Lisp, cl-paypal.asd: The cl-paypal<dot>asd file
File, Lisp, cl-paypal/cl-paypal.lisp: The cl-paypal/cl-paypal<dot>lisp file
File, Lisp, cl-paypal/config.lisp: The cl-paypal/config<dot>lisp file
File, Lisp, cl-paypal/package.lisp: The cl-paypal/package<dot>lisp file

L
Lisp File, cl-paypal.asd: The cl-paypal<dot>asd file
Lisp File, cl-paypal/cl-paypal.lisp: The cl-paypal/cl-paypal<dot>lisp file
Lisp File, cl-paypal/config.lisp: The cl-paypal/config<dot>lisp file
Lisp File, cl-paypal/package.lisp: The cl-paypal/package<dot>lisp file

Jump to:   C   F   L  

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): Internal generic functions
(setf response-error-response): Internal generic functions

D
decode-response: Internal functions

F
find-transaction: Internal functions
Function, decode-response: Internal functions
Function, find-transaction: Internal functions
Function, get-and-do-express-checkout: Exported functions
Function, init: Exported functions
Function, make-express-checkout-url: Exported functions
Function, register-transaction: Internal functions
Function, request: Exported functions
Function, unregister-transaction: Internal functions

G
Generic Function, (setf response-error-response): Internal generic functions
Generic Function, response-error-response: Internal generic functions
get-and-do-express-checkout: Exported functions

I
init: Exported functions

M
make-express-checkout-url: Exported functions
Method, (setf response-error-response): Internal generic functions
Method, response-error-response: Internal generic functions

R
register-transaction: Internal functions
request: Exported functions
response-error-response: Internal generic functions
response-error-response: Internal generic functions

U
unregister-transaction: Internal 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*: Internal special variables
*paypal-api-url*: Internal special variables
*paypal-cancel-url*: Internal special variables
*paypal-currencycode*: Internal special variables
*paypal-max-active-transactions*: Exported special variables
*paypal-max-token-live-period*: Exported special variables
*paypal-max-transaction-per-ip*: Exported special variables
*paypal-password*: Internal special variables
*paypal-return-url*: Internal special variables
*paypal-signature*: Internal special variables
*paypal-user*: Internal special variables
*paypal-useraction*: Internal special variables
*transaction-ips*: Internal special variables

H
http-status: Exported conditions

I
invalid-parameter: Exported conditions

R
response: Exported conditions
response-string: Exported conditions

S
Slot, http-status: Exported conditions
Slot, invalid-parameter: Exported conditions
Slot, response: Exported conditions
Slot, response-string: Exported conditions
Special Variable, *active-transactions*: Internal special variables
Special Variable, *paypal-api-url*: Internal special variables
Special Variable, *paypal-cancel-url*: Internal special variables
Special Variable, *paypal-currencycode*: Internal special variables
Special Variable, *paypal-max-active-transactions*: Exported special variables
Special Variable, *paypal-max-token-live-period*: Exported special variables
Special Variable, *paypal-max-transaction-per-ip*: Exported special variables
Special Variable, *paypal-password*: Internal special variables
Special Variable, *paypal-return-url*: Internal special variables
Special Variable, *paypal-signature*: Internal special variables
Special Variable, *paypal-user*: Internal special variables
Special Variable, *paypal-useraction*: Internal special variables
Special Variable, *transaction-ips*: Internal special variables

Jump to:   *  
H   I   R   S  

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

A.4 Data types

Jump to:   C   H   P   R   S   T  
Index Entry  Section

C
cl-paypal: The cl-paypal system
cl-paypal: The cl-paypal package
cl-paypal-system: The cl-paypal-system package
Condition, http-request-error: Exported conditions
Condition, paypal-error: Exported conditions
Condition, request-error: Exported conditions
Condition, response-error: Exported conditions
Condition, transaction-already-confirmed-error: Exported conditions

H
http-request-error: Exported conditions

P
Package, cl-paypal: The cl-paypal package
Package, cl-paypal-system: The cl-paypal-system package
paypal-error: Exported conditions

R
request-error: Exported conditions
response-error: Exported conditions

S
System, cl-paypal: The cl-paypal system

T
transaction-already-confirmed-error: Exported conditions

Jump to:   C   H   P   R   S   T