This is the cl-moneris Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Sep 15 04:14:30 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
cl-monerisAn interface to the Moneris payment processing service (HTTP).
Vladimir Sedach <vsedach@gmail.com>
ISC
s-xml (system).
drakma (system).
package.lisp (file).
response-codes.lisp (file).
moneris.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
cl-moneris/cl-moneris.asdcl-moneris/package.lispcl-moneris/response-codes.lispcl-moneris/moneris.lispcl-moneris/response-codes.lisppackage.lisp (file).
cl-moneris (system).
*response-codes* (special variable).
is-error-code? (function).
response-code-description (function).
cl-moneris/moneris.lispresponse-codes.lisp (file).
cl-moneris (system).
code (reader method).
(setf code) (writer method).
code-description (reader method).
(setf code-description) (writer method).
correction (function).
http-body (reader method).
(setf http-body) (writer method).
http-code (reader method).
(setf http-code) (writer method).
http-headers (reader method).
(setf http-headers) (writer method).
merchant-token (class).
message (reader method).
(setf message) (writer method).
moneris-error (condition).
moneris-post-error (condition).
moneris-transaction-error (condition).
parsed-xml (reader method).
(setf parsed-xml) (writer method).
process (function).
purchase (function).
raw-xml (reader method).
(setf raw-xml) (writer method).
reason-phrase (reader method).
(setf reason-phrase) (writer method).
refund (function).
api-token (reader method).
lispify-response (function).
moneris-uri (reader method).
store-id (reader method).
Packages are listed by definition order.
cl-moneriscommon-lisp.
drakma.
s-xml.
code (generic reader).
(setf code) (generic writer).
code-description (generic reader).
(setf code-description) (generic writer).
correction (function).
http-body (generic reader).
(setf http-body) (generic writer).
http-code (generic reader).
(setf http-code) (generic writer).
http-headers (generic reader).
(setf http-headers) (generic writer).
merchant-token (class).
message (generic reader).
(setf message) (generic writer).
moneris-error (condition).
moneris-post-error (condition).
moneris-transaction-error (condition).
parsed-xml (generic reader).
(setf parsed-xml) (generic writer).
process (function).
purchase (function).
raw-xml (generic reader).
(setf raw-xml) (generic writer).
reason-phrase (generic reader).
(setf reason-phrase) (generic writer).
refund (function).
*response-codes* (special variable).
api-token (generic reader).
is-error-code? (function).
lispify-response (function).
moneris-uri (generic reader).
response-code-description (function).
store-id (generic reader).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Generate a transaction to void a same-day purchase. No purchase will appear on the customer’s credit card.
Description of input parameters:
order-id (string, 50 chars max, alphanumeric)
Merchant defined unique transaction identifier - must reference a
previously processed purchase transaction order-id.
txn-id (string, 255 chars max, alphanumeric)
This must be the value returned as the Txn_number in the
response to the original purchase.
crypt-type (string, 1 char, alphanumeric)
E-Commerce Indicator:
1 - Mail Order/Telephone Order - Single
2 - Mail Order/Telephone Order - Recurring
3 - Mail Order Telephone Order - Instalment
4 - Mail Order Telephone Order - Unknown Classification
5 - Authenticated E-commerce Transaction (VBV)
6 - Non Authenticated Ecommerce Transaction (VBV)
7 - SSL enabled merchant
8 - Non Secure Transaction (Web or Email Based)
9 - SET Non Authenticated transaction
Send a ’purchase’, ’correction’, or ’refund’ transaction for processing to Moneris merchant account specified by merchant-token.
If the Moneris mpg server returns an HTTP status code other than 200, raises a moneris-post-error
If transaction is declined, raises a moneris-transaction-error
If transaction is successfuly processed, returns (as multiple values):
txn-id - transaction ID
code - numeric response code
code-description - response code description
message - message returned in response
response-xml - parsed XML of response
response-string - raw XML response string
Generate a purchase transaction for processing.
Description of input parameters:
order-id (string, 50 chars max, alphanumeric)
Merchant defined unique transaction identifier - must be uniquely
generated by caller for every Purchase.
amount (string, 9 chars max, decimal)
Amount of the transaction. This must contain 3 digits with two
penny values. The minimum value passed can be 0.01 and the maximum
9999999.99
pan (string, 20 chars max, numeric)
Credit Card Number - no spaces or dashes. Most credit card numbers
today are 16 digits in length but some 13 digits are still accepted
by some issuers. This field has been intentionally expanded to 20
digits in consideration for future expansion and/or potential
support of private label card ranges.
expdate (string, 4 chars, numeric)
Expiry Date - format YYMM no spaces or slashes. PLEASE NOTE THAT
THIS IS REVERSED FROM THE DATE DISPLAYED ON THE PHYSICAL CARD WHICH
IS MMYY
cust-id (string, 50 chars max, alphanumeric)
This is an optional field that can be sent as part of a Purchase or
PreAuth request. It is searchable in the Moneris Merchant Resource
Centre. It is commonly used for policy number, membership number,
student ID or invoice number.
Generate a transaction to refund a purchase.
order-id (string, 50 chars max, alphanumeric)
Merchant defined unique transaction identifier. For Independent
Refund attempts, must be uniquely generated by caller. For refunds
of previous purchases, must reference a previously processed
purchase transaction order-id.
txn-id (string, 255 chars max, alphanumeric)
Used when performing follow on transactions - this must be the value
returned as the Txn_number in the response to the original purchase.
amount (string, 9 chars max, decimal)
Amount of the transaction. This must contain 3 digits with two
penny values. The minimum value passed can be 0.01 and the maximum
9999999.99
crypt-type (string, 1 char, alphanumeric)
E-Commerce Indicator:
1 - Mail Order/Telephone Order - Single
2 - Mail Order/Telephone Order - Recurring
3 - Mail Order Telephone Order - Instalment
4 - Mail Order Telephone Order - Unknown Classification
5 - Authenticated E-commerce Transaction (VBV)
6 - Non Authenticated Ecommerce Transaction (VBV)
7 - SSL enabled merchant
8 - Non Secure Transaction (Web or Email Based)
9 - SET Non Authenticated transaction
moneris-transaction-error)) ¶moneris-transaction-error)) ¶code.
moneris-transaction-error)) ¶moneris-transaction-error)) ¶moneris-post-error)) ¶moneris-post-error)) ¶moneris-post-error)) ¶moneris-post-error)) ¶moneris-post-error)) ¶moneris-post-error)) ¶moneris-transaction-error)) ¶moneris-transaction-error)) ¶moneris-transaction-error)) ¶moneris-transaction-error)) ¶moneris-transaction-error)) ¶moneris-transaction-error)) ¶moneris-post-error)) ¶moneris-post-error)) ¶Superclass of network errors or
transaction-declined conditions. Handle this when you don’t care why
your transaction failed to process.
error.
Condition raised due to network error
:http-code
:http-headers
:http-body
Reason phrase from HTTP header status line
:reason-phrase
Condition raised when transaction is declined
Text description of Moneris response code
:code-description
Message returned by Moneris
:message
XML string returned by Moneris
:raw-xml
Parsed XML returned by Moneris
:parsed-xml
Merchant-token objects specify your unique Moneris store information.
Full URI of the Moneris Server e.g. https://moneris.com/mpg
:moneris-uri
This slot is read-only.
Your api token issued during Moneris store creation.
:api-token
This slot is read-only.
merchant-token)) ¶Your api token issued during Moneris store creation.
merchant-token)) ¶Full URI of the Moneris Server e.g. https://moneris.com/mpg
merchant-token)) ¶Your store-id issued during Moneris store creation.
| Jump to: | (
A C F G H I L M P R S |
|---|
| Jump to: | (
A C F G H I L M P R S |
|---|
| Jump to: | *
A C H M P R S |
|---|
| Jump to: | *
A C H M P R S |
|---|
| Jump to: | C F M P R S |
|---|
| Jump to: | C F M P R S |
|---|