From: senator Date: Mon, 14 Jun 2010 14:27:37 +0000 (+0000) Subject: Better documentation of payment outcomes, particularly credit card declines X-Git-Url: https://old-git.evergreen-ils.org/?a=commitdiff_plain;h=5cc273122b1352a9187e3b712ec9d731197beac7;p=evergreen%2Fbjwebb.git Better documentation of payment outcomes, particularly credit card declines git-svn-id: svn://svn.open-ils.org/ILS/trunk@16699 dcc99617-32d9-48b4-a31d-7c20da2025e4 --- diff --git a/Open-ILS/src/perlmods/OpenILS/Application/Circ/Money.pm b/Open-ILS/src/perlmods/OpenILS/Application/Circ/Money.pm index 10f357f28..2274e353c 100644 --- a/Open-ILS/src/perlmods/OpenILS/Application/Circ/Money.pm +++ b/Open-ILS/src/perlmods/OpenILS/Application/Circ/Money.pm @@ -70,28 +70,43 @@ __PACKAGE__->register_method( "desc" => q{1 on success, event on failure. Event possibilities include: BAD_PARAMS - (Bad parameters were given to this API method itself. - See note field.) + Bad parameters were given to this API method itself. + See note field. + REFUND_EXCEEDS_BALANCE + REFUND_EXCEEDS_DESK_PAYMENTS CREDIT_PROCESSOR_NOT_SPECIFIED - (Evergreen has not been set up to process CC payments) + Evergreen has not been set up to process CC payments. CREDIT_PROCESSOR_NOT_ALLOWED - (Evergreen has been incorrectly setup for CC payments) + Evergreen has been incorrectly setup for CC payments. CREDIT_PROCESSOR_NOT_ENABLED - (Evergreen has been set up for CC payments, but an admin - has not explicitly enabled them) + Evergreen has been set up for CC payments, but an admin + has not explicitly enabled them. CREDIT_PROCESSOR_BAD_PARAMS - (Evergreen has been incorrectly setup for CC payments; + Evergreen has been incorrectly setup for CC payments; specifically, the login and/or password for the CC - processor weren't provided) + processor weren't provided. + CREDIT_PROCESSOR_INVALID_CC_NUMBER + You have supplied a credit card number that Evergreen + has judged to be invalid even before attempting to contact + the payment processor. CREDIT_PROCESSOR_DECLINED_TRANSACTION - (We contacted the CC processor to attempt the charge, but - they declined it. See the statusText field for their - message.) + We contacted the CC processor to attempt the charge, but + they declined it. + The error_message field of the event payload will + contain the payment processor's response. This + typically includes a message in plain English intended + for human consumption. In PayPal's case, the message + is preceded by an integer, a colon, and a space, so + a caller might take the 2nd match from /^(\d+: )?(.+)$/ + to present to the user. + The payload also contains other fields from the payment + processor, but these are generally not user-friendly + strings. CREDIT_PROCESSOR_SUCCESS_WO_RECORD - (A payment was processed successfully, but couldn't be - recorded in Evergreen. This is bad bad bad, as it means + A payment was processed successfully, but couldn't be + recorded in Evergreen. This is _bad bad bad_, as it means somebody made a payment but isn't getting credit for it. - See note field for more info.) + See note field for more info. }, "type" => "number" }