This is the cl-coinpayments Reference Manual, version 1.0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Tue Jul 15 03:43:30 2025 GMT+0.
The main system appears first, followed by any subsystem dependency.
cl-coinpaymentsHelpers for working with the coinpayments.net api.
K1D77A
MIT
1.0.1
str (system).
ironclad (system).
babel (system).
dexador (system).
jonathan (system).
closer-mop (system).
package.lisp (file).
conditions.lisp (file).
classes.lisp (file).
cl-coinpayments.lisp (file).
api-helpers.lisp (file).
api-forms.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
cl-coinpayments/cl-coinpayments.asdcl-coinpayments/package.lispcl-coinpayments/conditions.lispcl-coinpayments/classes.lispcl-coinpayments/cl-coinpayments.lispcl-coinpayments/api-helpers.lispcl-coinpayments/api-forms.lispcl-coinpayments/cl-coinpayments.asdcl-coinpayments (system).
cl-coinpayments/conditions.lisppackage.lisp (file).
cl-coinpayments (system).
arg-count (reader method).
(setf arg-count) (writer method).
coinpayment-api-condition (condition).
coinpayment-condition (condition).
ipn (reader method).
ipn (reader method).
(setf ipn) (writer method).
(setf ipn) (writer method).
ipn-type (reader method).
(setf ipn-type) (writer method).
name (reader method).
(setf name) (writer method).
no-dispatcher-found (condition).
not-set (reader method).
(setf not-set) (writer method).
plist (reader method).
(setf plist) (writer method).
required (reader method).
(setf required) (writer method).
required-slots-not-bound (condition).
status (reader method).
status (reader method).
(setf status) (writer method).
(setf status) (writer method).
status-type (reader method).
(setf status-type) (writer method).
unknown-status (condition).
unsupported-ipn (condition).
cl-coinpayments/classes.lispconditions.lisp (file).
cl-coinpayments (system).
bad-response (class).
cmd (reader method).
(setf cmd) (writer method).
dex-alist (reader method).
(setf dex-alist) (writer method).
dex-extra (reader method).
(setf dex-extra) (writer method).
error-slot (reader method).
(setf error-slot) (writer method).
five (class).
good-response (class).
hmac (reader method).
(setf hmac) (writer method).
ipn-failure (class).
ipn-payment-pending (class).
ipn-payment-success (class).
ipn-status (class).
key (reader method).
(setf key) (writer method).
merchant-secret-key (reader method).
(setf merchant-secret-key) (writer method).
negative-1 (class).
negative-2 (class).
one (class).
one-hundred (class).
post-string (reader method).
(setf post-string) (writer method).
print-object (method).
request (reader method).
(setf request) (writer method).
request (class).
required (reader method).
(setf required) (writer method).
response (class).
result-slot (reader method).
(setf result-slot) (writer method).
three (class).
two (class).
version (reader method).
(setf version) (writer method).
zero (class).
nonce (reader method).
(setf nonce) (writer method).
response-format (reader method).
(setf response-format) (writer method).
cl-coinpayments/cl-coinpayments.lispclasses.lisp (file).
cl-coinpayments (system).
*ipn-dispatchers* (special variable).
construct-status (function).
def-ipn-dispatcher (macro).
dispatch-ipn-by-name (macro).
find-dispatcher (function).
ipn-dispatch (function).
new-ipn-dispatcher (function).
parse-data (generic function).
verify-data (generic function).
*strings->symbols* (special variable).
determine-unknown-status (function).
n->status (function).
new-symbol (function).
string->symbol (function).
cl-coinpayments/api-helpers.lispcl-coinpayments.lisp (file).
cl-coinpayments (system).
compute-dex-alist (method).
compute-final-hmac (method).
compute-hmac (generic function).
compute-post-params (method).
convert-merchant-secret-key (method).
initialize-instance (method).
new-request (macro).
request (method).
validate-slots (method).
*sym->string* (special variable).
new-string (function).
symbol->string (function).
cl-coinpayments/api-forms.lispapi-helpers.lisp (file).
cl-coinpayments (system).
accepted (reader method).
(setf accepted) (writer method).
add_tx_fee (reader method).
(setf add_tx_fee) (writer method).
address (reader method).
address (reader method).
address (reader method).
(setf address) (writer method).
(setf address) (writer method).
(setf address) (writer method).
all (reader method).
all (reader method).
(setf all) (writer method).
(setf all) (writer method).
amount (reader method).
amount (reader method).
amount (reader method).
amount (reader method).
(setf amount) (writer method).
(setf amount) (writer method).
(setf amount) (writer method).
(setf amount) (writer method).
auto-confirm (reader method).
auto-confirm (reader method).
(setf auto-confirm) (writer method).
(setf auto-confirm) (writer method).
buy-pbn-tags (class).
buyer-email (reader method).
(setf buyer-email) (writer method).
buyer-name (reader method).
(setf buyer-name) (writer method).
cancel-url (reader method).
(setf cancel-url) (writer method).
cancel-withdrawal (class).
claim-pbn-coupon (class).
claim-pbn-tag (class).
coin (reader method).
coin (reader method).
(setf coin) (writer method).
(setf coin) (writer method).
conversion-limits (class).
convert-coins (class).
coupon (reader method).
(setf coupon) (writer method).
create-fixed-price-transaction (class).
create-mass-withdrawal (class).
create-transfer (class).
create-withdrawal (class).
currency (reader method).
currency (reader method).
currency (reader method).
currency (reader method).
(setf currency) (writer method).
(setf currency) (writer method).
(setf currency) (writer method).
(setf currency) (writer method).
currency-prices (class).
currency1 (reader method).
(setf currency1) (writer method).
currency2 (reader method).
currency2 (reader method).
(setf currency2) (writer method).
(setf currency2) (writer method).
custom (reader method).
(setf custom) (writer method).
delete-pbn-tag (class).
dest-tag (reader method).
dest-tag (reader method).
(setf dest-tag) (writer method).
(setf dest-tag) (writer method).
domain (reader method).
(setf domain) (writer method).
eip55 (reader method).
(setf eip55) (writer method).
email (reader method).
(setf email) (writer method).
from (reader method).
from (reader method).
(setf from) (writer method).
(setf from) (writer method).
full (reader method).
(setf full) (writer method).
get-basic-info (class).
get-callback-address (class).
get-coin-balances (class).
get-conversion-information (class).
get-deposit-address (class).
get-multiple-transaction-information (class).
get-pbn-profile-information (class).
get-pbn-tag-list (class).
get-transaction-ids (class).
get-transaction-information (class).
get-withdrawal-history (class).
get-withdrawal-information (class).
id (reader method).
id (reader method).
id (reader method).
(setf id) (writer method).
(setf id) (writer method).
(setf id) (writer method).
image (reader method).
(setf image) (writer method).
invoice (reader method).
(setf invoice) (writer method).
ipn-url (reader method).
ipn-url (reader method).
ipn-url (reader method).
(setf ipn-url) (writer method).
(setf ipn-url) (writer method).
(setf ipn-url) (writer method).
item-name (reader method).
(setf item-name) (writer method).
item-number (reader method).
(setf item-number) (writer method).
label (reader method).
(setf label) (writer method).
limit (reader method).
limit (reader method).
(setf limit) (writer method).
(setf limit) (writer method).
merchant (reader method).
(setf merchant) (writer method).
name (reader method).
name (reader method).
(setf name) (writer method).
(setf name) (writer method).
newer (reader method).
newer (reader method).
(setf newer) (writer method).
(setf newer) (writer method).
note (reader method).
note (reader method).
(setf note) (writer method).
(setf note) (writer method).
num (reader method).
(setf num) (writer method).
pbntag (reader method).
pbntag (reader method).
pbntag (reader method).
(setf pbntag) (writer method).
(setf pbntag) (writer method).
(setf pbntag) (writer method).
renew-pbn-tag (class).
short (reader method).
(setf short) (writer method).
start (reader method).
start (reader method).
(setf start) (writer method).
(setf start) (writer method).
success-url (reader method).
(setf success-url) (writer method).
tagid (reader method).
tagid (reader method).
tagid (reader method).
(setf tagid) (writer method).
(setf tagid) (writer method).
(setf tagid) (writer method).
to (reader method).
to (reader method).
(setf to) (writer method).
(setf to) (writer method).
txid (reader method).
txid (reader method).
(setf txid) (writer method).
(setf txid) (writer method).
update-pbn-profile (class).
url (reader method).
(setf url) (writer method).
validate-slots (method).
validate-slots (method).
wd (reader method).
(setf wd) (writer method).
years (reader method).
(setf years) (writer method).
Packages are listed by definition order.
cl-coinpaymentscoin
common-lisp.
*ipn-dispatchers* (special variable).
accepted (generic reader).
(setf accepted) (generic writer).
add_tx_fee (generic reader).
(setf add_tx_fee) (generic writer).
address (generic reader).
(setf address) (generic writer).
all (generic reader).
(setf all) (generic writer).
amount (generic reader).
(setf amount) (generic writer).
arg-count (generic reader).
(setf arg-count) (generic writer).
auto-confirm (generic reader).
(setf auto-confirm) (generic writer).
bad-response (class).
buy-pbn-tags (class).
buyer-email (generic reader).
(setf buyer-email) (generic writer).
buyer-name (generic reader).
(setf buyer-name) (generic writer).
cancel-url (generic reader).
(setf cancel-url) (generic writer).
cancel-withdrawal (class).
claim-pbn-coupon (class).
claim-pbn-tag (class).
cmd (generic reader).
(setf cmd) (generic writer).
coin (generic reader).
(setf coin) (generic writer).
coinpayment-api-condition (condition).
coinpayment-condition (condition).
compute-dex-alist (generic function).
compute-final-hmac (generic function).
compute-hmac (generic function).
compute-post-params (generic function).
construct-status (function).
conversion-limits (class).
convert-coins (class).
convert-merchant-secret-key (generic function).
coupon (generic reader).
(setf coupon) (generic writer).
create-fixed-price-transaction (class).
create-mass-withdrawal (class).
create-transfer (class).
create-withdrawal (class).
currency (generic reader).
(setf currency) (generic writer).
currency-prices (class).
currency1 (generic reader).
(setf currency1) (generic writer).
currency2 (generic reader).
(setf currency2) (generic writer).
custom (generic reader).
(setf custom) (generic writer).
def-ipn-dispatcher (macro).
delete-pbn-tag (class).
dest-tag (generic reader).
(setf dest-tag) (generic writer).
dex-alist (generic reader).
(setf dex-alist) (generic writer).
dex-extra (generic reader).
(setf dex-extra) (generic writer).
dispatch-ipn-by-name (macro).
domain (generic reader).
(setf domain) (generic writer).
eip55 (generic reader).
(setf eip55) (generic writer).
email (generic reader).
(setf email) (generic writer).
error-slot (generic reader).
(setf error-slot) (generic writer).
find-dispatcher (function).
five (class).
from (generic reader).
(setf from) (generic writer).
full (generic reader).
(setf full) (generic writer).
get-basic-info (class).
get-callback-address (class).
get-coin-balances (class).
get-conversion-information (class).
get-deposit-address (class).
get-multiple-transaction-information (class).
get-pbn-profile-information (class).
get-pbn-tag-list (class).
get-transaction-ids (class).
get-transaction-information (class).
get-withdrawal-history (class).
get-withdrawal-information (class).
good-response (class).
hmac (generic reader).
(setf hmac) (generic writer).
id (generic reader).
(setf id) (generic writer).
image (generic reader).
(setf image) (generic writer).
invoice (generic reader).
(setf invoice) (generic writer).
ipn (generic reader).
(setf ipn) (generic writer).
ipn-dispatch (function).
ipn-failure (class).
ipn-payment-pending (class).
ipn-payment-success (class).
ipn-status (class).
ipn-type (generic reader).
(setf ipn-type) (generic writer).
ipn-url (generic reader).
(setf ipn-url) (generic writer).
item-name (generic reader).
(setf item-name) (generic writer).
item-number (generic reader).
(setf item-number) (generic writer).
key (generic reader).
(setf key) (generic writer).
label (generic reader).
(setf label) (generic writer).
limit (generic reader).
(setf limit) (generic writer).
merchant (generic reader).
(setf merchant) (generic writer).
merchant-secret-key (generic reader).
(setf merchant-secret-key) (generic writer).
name (generic reader).
(setf name) (generic writer).
negative-1 (class).
negative-2 (class).
new-ipn-dispatcher (function).
new-request (macro).
newer (generic reader).
(setf newer) (generic writer).
no-dispatcher-found (condition).
not-set (generic reader).
(setf not-set) (generic writer).
note (generic reader).
(setf note) (generic writer).
num (generic reader).
(setf num) (generic writer).
one (class).
one-hundred (class).
parse-data (generic function).
pbntag (generic reader).
(setf pbntag) (generic writer).
plist (generic reader).
(setf plist) (generic writer).
post-string (generic reader).
(setf post-string) (generic writer).
renew-pbn-tag (class).
request (generic function).
(setf request) (generic writer).
request (class).
required (generic reader).
(setf required) (generic writer).
required-slots-not-bound (condition).
response (class).
result-slot (generic reader).
(setf result-slot) (generic writer).
short (generic reader).
(setf short) (generic writer).
start (generic reader).
(setf start) (generic writer).
status (generic reader).
(setf status) (generic writer).
status-type (generic reader).
(setf status-type) (generic writer).
success-url (generic reader).
(setf success-url) (generic writer).
tagid (generic reader).
(setf tagid) (generic writer).
three (class).
to (generic reader).
(setf to) (generic writer).
two (class).
txid (generic reader).
(setf txid) (generic writer).
unknown-status (condition).
unsupported-ipn (condition).
update-pbn-profile (class).
url (generic reader).
(setf url) (generic writer).
validate-slots (generic function).
verify-data (generic function).
version (generic reader).
(setf version) (generic writer).
wd (generic reader).
(setf wd) (generic writer).
years (generic reader).
(setf years) (generic writer).
zero (class).
*strings->symbols* (special variable).
*sym->string* (special variable).
determine-unknown-status (function).
n->status (function).
new-string (function).
new-symbol (function).
nonce (generic reader).
(setf nonce) (generic writer).
response-format (generic reader).
(setf response-format) (generic writer).
string->symbol (function).
symbol->string (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
A list of plists used to dispatch on various ipn-types.
Defines a new dispatch function under the name NAME. This is very similar to
a defmethod form however dispatching from most to least specific subclasses is only done
with the status-class. IPN-VAR names the IPN passed into the fun (a plist). STATUS-VAR
names the status object passed into the fun, args is a list of
Macro version of IPN-DISPATCH. It just looks nicer.
Creates a new class by NAME which is a subclass of ’request,
CMD is a string which is set to the initform of the slot cmd. REQUIRED is a list
of slots that are required for this request. PARAMS is all of the slots, yes
you will have to repeat whats in required in params. Also if you were to add some
new API that I didn’t see then where they use a case like abc_def you can just
use symbols like abc-def because they are automatically translated to the
correct case, dont worry this is memoized to make it faster.
Given a plist of post parameters that have been parsed by parse-data beforehand, attempts to first construct and IPN object, in the event this fails it will signal ’unsupported-ipn, then attempts to construct an IPN-STATUS object using CONSTRUCT-STATUS. These are then returned as multiple values ipn,status.
Attempts to find the most specific function for NAME IPN-TYPE and STATUS (all symbols)
within *ipn-dispatchers*, dispatching is done both on the ipn-type, arg-count and status,
if no dispatcher is found under name then returns nil, if one is then tries to find
dispatcher with ARG-COUNT args, if non exists returns nil, otherwise checks under
the ipn-status, if none are found by that name under that specific status
then recalls FIND-DISPATCHER with the superclasses of STATUS. If some dispatchers are found
under that name and that status, then attempts to find the dispatcher by IPN-TYPE, if one
is found returns it, otherwise returns nil. This will find most specific dispatchers first.
Uses FIND-DISPATCH to execute the dispatcher found with IPN, STATUS and (length ARGS).
If
no dispatcher is found signals ’no-dispatcher-found. Its important to note that no
default dispatchers are provided so your fall-back behaviour should involve catching
that condition and doing something with the condition object.
currency-prices)) ¶automatically generated reader method
currency-prices)) ¶automatically generated writer method
create-withdrawal)) ¶automatically generated reader method
create-withdrawal)) ¶automatically generated writer method
convert-coins)) ¶automatically generated reader method
create-withdrawal)) ¶automatically generated reader method
create-fixed-price-transaction)) ¶automatically generated reader method
convert-coins)) ¶automatically generated writer method
create-withdrawal)) ¶automatically generated writer method
create-fixed-price-transaction)) ¶automatically generated writer method
get-coin-balances)) ¶automatically generated reader method
all.
get-transaction-ids)) ¶automatically generated reader method
all.
get-coin-balances)) ¶automatically generated writer method
all.
get-transaction-ids)) ¶automatically generated writer method
all.
convert-coins)) ¶automatically generated reader method
create-withdrawal)) ¶automatically generated reader method
create-transfer)) ¶automatically generated reader method
create-fixed-price-transaction)) ¶automatically generated reader method
convert-coins)) ¶automatically generated writer method
create-withdrawal)) ¶automatically generated writer method
create-transfer)) ¶automatically generated writer method
create-fixed-price-transaction)) ¶automatically generated writer method
no-dispatcher-found)) ¶no-dispatcher-found)) ¶create-withdrawal)) ¶automatically generated reader method
create-transfer)) ¶automatically generated reader method
create-withdrawal)) ¶automatically generated writer method
create-transfer)) ¶automatically generated writer method
create-fixed-price-transaction)) ¶automatically generated reader method
create-fixed-price-transaction)) ¶automatically generated writer method
create-fixed-price-transaction)) ¶automatically generated reader method
create-fixed-price-transaction)) ¶automatically generated writer method
create-fixed-price-transaction)) ¶automatically generated reader method
create-fixed-price-transaction)) ¶automatically generated writer method
renew-pbn-tag)) ¶automatically generated reader method
coin.
buy-pbn-tags)) ¶automatically generated reader method
coin.
renew-pbn-tag)) ¶automatically generated writer method
coin.
buy-pbn-tags)) ¶automatically generated writer method
coin.
request)) ¶This function must be called before ’compute-dex-alist. This computes the
alist used as the :content key to dex:post, it loops through all the slots in the class
and creates an alist from their slotname and values, it ignores slots that are
any of ’(dex-alist required merchant-secret-key) or are unbound.
Computes a hmac from the merchant-secret-key and a string.
claim-pbn-coupon)) ¶automatically generated reader method
claim-pbn-coupon)) ¶automatically generated writer method
create-withdrawal)) ¶automatically generated reader method
create-transfer)) ¶automatically generated reader method
get-deposit-address)) ¶automatically generated reader method
get-callback-address)) ¶automatically generated reader method
create-withdrawal)) ¶automatically generated writer method
create-transfer)) ¶automatically generated writer method
get-deposit-address)) ¶automatically generated writer method
get-callback-address)) ¶automatically generated writer method
create-fixed-price-transaction)) ¶automatically generated reader method
create-fixed-price-transaction)) ¶automatically generated writer method
create-withdrawal)) ¶automatically generated reader method
create-fixed-price-transaction)) ¶automatically generated reader method
create-withdrawal)) ¶automatically generated writer method
create-fixed-price-transaction)) ¶automatically generated writer method
create-fixed-price-transaction)) ¶automatically generated reader method
create-fixed-price-transaction)) ¶automatically generated writer method
convert-coins)) ¶automatically generated reader method
create-withdrawal)) ¶automatically generated reader method
convert-coins)) ¶automatically generated writer method
create-withdrawal)) ¶automatically generated writer method
create-withdrawal)) ¶automatically generated reader method
create-withdrawal)) ¶automatically generated writer method
get-callback-address)) ¶automatically generated reader method
get-callback-address)) ¶automatically generated writer method
update-pbn-profile)) ¶automatically generated reader method
update-pbn-profile)) ¶automatically generated writer method
conversion-limits)) ¶automatically generated reader method
from.
convert-coins)) ¶automatically generated reader method
from.
conversion-limits)) ¶automatically generated writer method
from.
convert-coins)) ¶automatically generated writer method
from.
get-transaction-information)) ¶automatically generated reader method
full.
get-transaction-information)) ¶automatically generated writer method
full.
get-conversion-information)) ¶automatically generated reader method
id.
get-withdrawal-information)) ¶automatically generated reader method
id.
cancel-withdrawal)) ¶automatically generated reader method
id.
get-conversion-information)) ¶automatically generated writer method
id.
get-withdrawal-information)) ¶automatically generated writer method
id.
cancel-withdrawal)) ¶automatically generated writer method
id.
update-pbn-profile)) ¶automatically generated reader method
update-pbn-profile)) ¶automatically generated writer method
create-fixed-price-transaction)) ¶automatically generated reader method
create-fixed-price-transaction)) ¶automatically generated writer method
no-dispatcher-found)) ¶no-dispatcher-found)) ¶ipn.
unsupported-ipn)) ¶unsupported-ipn)) ¶ipn.
no-dispatcher-found)) ¶no-dispatcher-found)) ¶create-withdrawal)) ¶automatically generated reader method
get-callback-address)) ¶automatically generated reader method
create-fixed-price-transaction)) ¶automatically generated reader method
create-withdrawal)) ¶automatically generated writer method
get-callback-address)) ¶automatically generated writer method
create-fixed-price-transaction)) ¶automatically generated writer method
create-fixed-price-transaction)) ¶automatically generated reader method
create-fixed-price-transaction)) ¶automatically generated writer method
create-fixed-price-transaction)) ¶automatically generated reader method
create-fixed-price-transaction)) ¶automatically generated writer method
get-callback-address)) ¶automatically generated reader method
get-callback-address)) ¶automatically generated writer method
get-withdrawal-history)) ¶automatically generated reader method
get-transaction-ids)) ¶automatically generated reader method
get-withdrawal-history)) ¶automatically generated writer method
get-transaction-ids)) ¶automatically generated writer method
create-transfer)) ¶automatically generated reader method
create-transfer)) ¶automatically generated writer method
update-pbn-profile)) ¶automatically generated reader method
name.
claim-pbn-tag)) ¶automatically generated reader method
name.
no-dispatcher-found)) ¶name.
update-pbn-profile)) ¶automatically generated writer method
name.
claim-pbn-tag)) ¶automatically generated writer method
name.
no-dispatcher-found)) ¶name.
get-withdrawal-history)) ¶automatically generated reader method
get-transaction-ids)) ¶automatically generated reader method
get-withdrawal-history)) ¶automatically generated writer method
get-transaction-ids)) ¶automatically generated writer method
required-slots-not-bound)) ¶required-slots-not-bound)) ¶create-withdrawal)) ¶automatically generated reader method
note.
create-transfer)) ¶automatically generated reader method
note.
create-withdrawal)) ¶automatically generated writer method
note.
create-transfer)) ¶automatically generated writer method
note.
buy-pbn-tags)) ¶automatically generated reader method
num.
buy-pbn-tags)) ¶automatically generated writer method
num.
Attempts to parse ’data’ into a plist with keys that match the IPN class definitions in classes.lisp.
array)) ¶Convert an array which contains the raw post data into a plist representing the IPN. This method assumes the array provided is not unsigned-byte 8 so it converts it.
string)) ¶Parse a www-url-form-encoded string into something that can be used to make a coinpayment ipn object.
list)) ¶get-pbn-profile-information)) ¶automatically generated reader method
create-withdrawal)) ¶automatically generated reader method
create-transfer)) ¶automatically generated reader method
get-pbn-profile-information)) ¶automatically generated writer method
create-withdrawal)) ¶automatically generated writer method
create-transfer)) ¶automatically generated writer method
unsupported-ipn)) ¶unsupported-ipn)) ¶request)) ¶When given a constructed REQUEST object, attempts to use the object to make
a request to the coinpayments API. If successfully returns a ’good-response object,
if there was a failure with your values then returns a ’bad-response object.
See the definition of ’response for information on the slots.
request)) ¶request)) ¶A list of required slots.
required-slots-not-bound)) ¶required-slots-not-bound)) ¶currency-prices)) ¶automatically generated reader method
currency-prices)) ¶automatically generated writer method
get-withdrawal-history)) ¶automatically generated reader method
get-transaction-ids)) ¶automatically generated reader method
get-withdrawal-history)) ¶automatically generated writer method
get-transaction-ids)) ¶automatically generated writer method
no-dispatcher-found)) ¶no-dispatcher-found)) ¶unknown-status)) ¶unknown-status)) ¶no-dispatcher-found)) ¶no-dispatcher-found)) ¶create-fixed-price-transaction)) ¶automatically generated reader method
create-fixed-price-transaction)) ¶automatically generated writer method
delete-pbn-tag)) ¶automatically generated reader method
renew-pbn-tag)) ¶automatically generated reader method
claim-pbn-tag)) ¶automatically generated reader method
delete-pbn-tag)) ¶automatically generated writer method
renew-pbn-tag)) ¶automatically generated writer method
claim-pbn-tag)) ¶automatically generated writer method
conversion-limits)) ¶automatically generated reader method
to.
convert-coins)) ¶automatically generated reader method
to.
conversion-limits)) ¶automatically generated writer method
to.
convert-coins)) ¶automatically generated writer method
to.
get-transaction-information)) ¶automatically generated reader method
txid.
get-multiple-transaction-information)) ¶automatically generated reader method
txid.
get-transaction-information)) ¶automatically generated writer method
txid.
get-multiple-transaction-information)) ¶automatically generated writer method
txid.
update-pbn-profile)) ¶automatically generated reader method
url.
update-pbn-profile)) ¶automatically generated writer method
url.
create-withdrawal)) ¶Special method for create-transfer which has two slots one of either must be set.
create-transfer)) ¶Special method for create-transfer which has two slots one of either must be set.
A generic function to verify the integrity of a request while
PRIVATE-KEY and RAW-POST are in different formats. Depending on the request,
I think PRIVATE-KEY is either meant to be your private-api key, or your private IPN key.
IPN key for validating IPN’s and private api key for sending requests to the API.
create-mass-withdrawal)) ¶automatically generated reader method
wd.
create-mass-withdrawal)) ¶automatically generated writer method
wd.
renew-pbn-tag)) ¶automatically generated reader method
renew-pbn-tag)) ¶automatically generated writer method
request) &rest initargs &key &allow-other-keys) ¶After initialization this confirms that all required slots have been filled, computes the alist for the post request which is passed to dex:post, computes a list of those same post parameters which is used for generating a hmac header, and then finally computes that hmac header.
bad-response) stream) ¶Top level api condition
condition.
Signalled when an IPN dispatcher cant be found.
The STATUS in question.
:status
The number of ARGS for the dispatcher.
:arg-count
The ipn-type of the dispatcher.
:ipn-type
The status-type of the dispatcher.
:status-type
Signalled when you try to instantiate a class but dont set required slots
signalled when an unknown status code is received.
The unknown status code.
:status
Signalled when an attempt was made to construct an unsupported IPN.
(setf coin).
coin.
(setf num).
num.
"buy_pbn_tags"
(quote (cl-coinpayments:coin cl-coinpayments:merchant-secret-key cl-coinpayments:key))
"claim_pbn_tag"
(quote (cl-coinpayments:tagid cl-coinpayments:name cl-coinpayments:merchant-secret-key cl-coinpayments:key))
string
:tagid
(setf from).
from.
(setf to).
to.
"convert_limits"
(quote (cl-coinpayments:from cl-coinpayments:to cl-coinpayments:merchant-secret-key cl-coinpayments:key))
"convert"
(quote (cl-coinpayments:amount cl-coinpayments:from cl-coinpayments:to cl-coinpayments:merchant-secret-key cl-coinpayments:key))
string
:amount
string
:address
string
:dest-tag
(setf address).
address.
(setf amount).
amount.
(setf buyer-email).
buyer-email.
(setf buyer-name).
buyer-name.
(setf cancel-url).
cancel-url.
(setf currency1).
currency1.
(setf currency2).
currency2.
(setf custom).
custom.
(setf invoice).
invoice.
(setf ipn-url).
ipn-url.
(setf item-name).
item-name.
(setf item-number).
item-number.
(setf success-url).
success-url.
"create_transaction"
(quote (cl-coinpayments:amount cl-coinpayments:currency1 cl-coinpayments:currency2 cl-coinpayments:buyer-email cl-coinpayments:merchant-secret-key cl-coinpayments:key))
string
:amount
string
:currency1
string
:currency2
string
:buyer-email
string
:address
string
:buyer-name
string
:item-name
string
:item-number
string
:invoice
string
:custom
string
:ipn-url
string
:success-url
string
:cancel-url
"create_transfer"
(quote (cl-coinpayments:amount cl-coinpayments:currency cl-coinpayments:merchant-secret-key cl-coinpayments:key))
string
:amount
string
:currency
string
:merchant
string
:pbntag
string
:auto-confirm
(setf add_tx_fee).
add_tx_fee.
(setf address).
address.
(setf amount).
amount.
(setf auto-confirm).
auto-confirm.
(setf currency).
currency.
(setf currency2).
currency2.
(setf dest-tag).
dest-tag.
(setf domain).
domain.
(setf ipn-url).
ipn-url.
(setf note).
note.
(setf pbntag).
pbntag.
validate-slots.
"create_withdrawal"
(quote (cl-coinpayments:currency cl-coinpayments:merchant-secret-key cl-coinpayments:key))
string
:amount
string
:add_tx_fee
string
:currency
string
:currency2
string
:address
string
:pbntag
string
:domain
string
:dest-tag
string
:ipn-url
string
:auto-confirm
"rates"
(quote (cl-coinpayments:merchant-secret-key cl-coinpayments:key))
string
:short
string
:accepted
In Escrow (if you are using SetEscrow)
"get_callback_address"
(quote (cl-coinpayments:currency cl-coinpayments:merchant-secret-key cl-coinpayments:key))
string
:currency
string
:ipn-url
string
:label
string
:eip55
"get_tx_ids"
(quote (cl-coinpayments:merchant-secret-key cl-coinpayments:key))
string
:limit
string
:start
string
:newer
"get_tx_info"
(quote (cl-coinpayments:txid cl-coinpayments:merchant-secret-key cl-coinpayments:key))
"get_withdrawal_history"
(quote (cl-coinpayments:merchant-secret-key cl-coinpayments:key))
string
:limit
string
:start
string
:newer
Cancelled/Timed out
Paypal Refund or Reversal
We have confirmed coin reception from the buyer.
Payment complete
"renew_pbn_tag"
(quote (cl-coinpayments:tagid cl-coinpayments:coin cl-coinpayments:merchant-secret-key cl-coinpayments:key))
string
:tagid
string
:years
The base class for all API requests.
buy-pbn-tags.
cancel-withdrawal.
claim-pbn-coupon.
claim-pbn-tag.
conversion-limits.
convert-coins.
create-fixed-price-transaction.
create-mass-withdrawal.
create-transfer.
create-withdrawal.
currency-prices.
delete-pbn-tag.
get-basic-info.
get-callback-address.
get-coin-balances.
get-conversion-information.
get-deposit-address.
get-multiple-transaction-information.
get-pbn-profile-information.
get-pbn-tag-list.
get-transaction-ids.
get-transaction-information.
get-withdrawal-history.
get-withdrawal-information.
renew-pbn-tag.
update-pbn-profile.
(setf cmd).
cmd.
compute-dex-alist.
compute-final-hmac.
compute-post-params.
(setf dex-alist).
dex-alist.
(setf hmac).
hmac.
initialize-instance.
(setf key).
key.
(setf merchant-secret-key).
merchant-secret-key.
(setf nonce).
nonce.
(setf post-string).
post-string.
request.
(setf required).
required.
(setf response-format).
response-format.
validate-slots.
(setf version).
version.
The API version.
string
"1"
:version
A computed a list of all post vars for sending as form-urlencoded.
list
The computed post string.
string
The private key used to sign the requests.
string
:merchant-secret-key
An optional nonce that should be one higher than the previous
string
:nonce
The response format. Default JSON.
common-lisp.
string
"json"
:format
A list of required slots.
list
:required
A class for putting the parsed results.
The parsed ’error’ slot.
:error-slot
The parsed result.
:result-slot
The other values returned by dex:post
:dex-extra
the request object.
:request
PayPal Pending (eChecks of other types of holds)
queued for nightly payout. (if you have Payout Mode for this coin set to Nightly)
"update_pbn_tag"
(quote (cl-coinpayments:tagid cl-coinpayments:merchant-secret-key cl-coinpayments:key))
string
:email
string
:image
Waiting for buyer funds.
A hash-table of key values representing the strings and their converted counterparts
A list of symbols and their string counterparts
After calling CONSTRUCT-STATUS this is called in an attempt to determine whether the status is part of the API not implemented yet.
Given a number N attempts to determine which IPN-STATUS object to create,
you can see all of the available status classes within classes.lisp. If it cannot match
the numbers specifically then more general classes are used based on the coinpayments
’loose’ recommendations for future proofing, this is done with DETERMINE-UNKNOWN-STATUS.
| Jump to: | (
A B C D E F G H I K L M N P R S T U V W Y |
|---|
| Jump to: | (
A B C D E F G H I K L M N P R S T U V W Y |
|---|
| Jump to: | *
A B C D E F H I K L M N P R S T U V W Y |
|---|
| Jump to: | *
A B C D E F H I K L M N P R S T U V W Y |
|---|
| Jump to: | A B C D F G I N O P R S T U Z |
|---|
| Jump to: | A B C D F G I N O P R S T U Z |
|---|