The library documents itself · Web & app server
stzPaymentsSandbox
24 own methods · 4 forms written with extensions, listed under their method
the source: base/service/stzPaymentsPort.ring(opens in a new tab) · All classes · The area reference: Web & app server
Under each method, its extensions (Q CS XT Z ZZ IB W U): bold and ticked, it exists; struck, it does not. The extensions and what they mean
No method of this class is run on this page: the class reaches files, the network, processes, the clock, chance or sound, and an example run here would only be an example of its effects. Each method carries the explanation the library gives of itself.
Method
Explanation, as the source carries it
init
(no comment in the source: the name reads as a sentence) initno extension
IsSandbox
a double declares itself -- see stzServiceRegistryno extension
ApproveUnder
the rules (deterministic, no randomness) -------------------------- approve anything strictly BELOW this amount; 0 = no ceiling.QCSXTZZZIBWU
DeclineOver
decline anything at or ABOVE this amount; 0 = no ceiling.QCSXTZZZIBWU
DeclineToken
a token that always declines -- the "test card" every real gateway publishes.QCSXTZZZIBWU
FailNext
make the NEXT call fail as if the gateway were unreachable -- a transient failure, which is different from a decline and must be handled differently (a decline is an answer; an outage is not).QCSXTZZZIBWU
Authorize
the PORT contract ------------------------------------------------ -> [ :ok, :id, :status, :amount, :why ]. status is :authorized or :declined.no extension
Capture
Capture an authorization. Full amount by default; CaptureAmount for less.no extension
CaptureAmount
pnAmount 0 = the whole authorization. A capture may not exceed it, and an authorization may be captured only ONCE -- both are real gateway rules, and both are where naive code goes wrong.no extension
Refund
Refund captured money. Full captured amount by default; partials allowed, and the TOTAL refunded may never exceed what was captured.no extension
RefundAmount
(no comment in the source: the name reads as a sentence) refund amountno extension
StatusOf
the ledger (what actually happened to the money)no extension
AmountOf
(no comment in the source: the name reads as a sentence) amount ofno extension
CapturedOf
(no comment in the source: the name reads as a sentence) captured ofno extension
RefundedOf
(no comment in the source: the name reads as a sentence) refunded ofno extension
NumberOfAuthorizations
(no comment in the source: the name reads as a sentence) number of authorizationsno extension
TotalAuthorized
(no comment in the source: the name reads as a sentence) total authorizedno extension
TotalCaptured
(no comment in the source: the name reads as a sentence) total capturedno extension
TotalRefunded
(no comment in the source: the name reads as a sentence) total refundedno extension
NetCaptured
what the merchant actually keeps.no extension
NumberOfDeclines
(no comment in the source: the name reads as a sentence) number of declinesno extension
Movements
[ [ :seq, :kind, :id, :amount ], ... ] -- kind is authorize/decline/capture/refundno extension
NumberOfMovements
(no comment in the source: the name reads as a sentence) number of movementsno extension
Show
(no comment in the source: the name reads as a sentence) showno extension