This is the python library for the Samurai API from Fee Fighters. It allows you easily store customer payment information, and create transactions, without having to ever worry about having their credit card number cross your server.
When a transparent redirect form is created, prepopulated with a previous payment method, and update is set to true, the form will now pass the payment_method_token on to FeeFighters. In such a case when the user submits this new form, any blank entries on required fields will be replaced by the value from the previous payment_method. In addition, invalid CCN/CVV fields will also be replaced. This way, you can output something like "************2342" (samurai_form.card_number.value in the template), and the user can submit it knowing that the old CCN actually got sent. See API documentation for details.
When using the test environment, you should pass in a boolean hidden field called "sandbox". The new example transparent redirect field reflects this, and you should add it to your own template. You should also add SAMURAI_SANDBOX=True in settings.py. This currently defaults to False to avoid breaking compatibility.
This a set of credentials for making a credit card payment. It includes:
- less sensitive data that you will have access to (name, address, credit card expiration date, etc)
- more sensitive data that you won't have access to (credit card number and cvv)
- the state of the payment method (is data valid, is payment method redacted, etc)
Each Payment Method is identified by a payment_method_token.
This is an action taken based on a payment method, and/or a previous transaction. There are a 5 different types of transactions.
- purchase - a complete payment
- authorize - the first part of a two-step payment
- capture - the second part of a two-step payment
- void - the cancellation of any previous payment
- credit - a partial or complete refund on an existing completed payment
Each Transaction is identified by a reference_id, and each set of transactions that relate to each other (the capture for an earlier authorize, the void of an earlier purchase, etc) is identified by a transaction_token.
This library currently isn't a proper Python package, so you will have to get the source. The main directory serves as a module, though you should rename it to something like samurai_client_python, since dashes aren't valid for module names. The directory also works as a Django application, if you would like to use it for that.
The module samurai_client_python.core and the file transparent_redirect.html.example contain everything necessary to use the Samurai API. You will be in charge of saving references to Payment Methods and Transactions Read More
The modules samurai_client_python.models, samurai_client_python.urls, samurai_client_python.views make up a Django app which call on samurai_client_python.core. Read More (Though read first about Core, above)
This is if you want to run samurai_client_python test suite. It's good to test the code, and also to test if anything is wrong or just changed with the samurai API. If you suddenly start having unexplainable problems, this might be a good place to start.
If you want any of the tests to pass, you will need to create a file called test_credentials.py. Look at test_extra/test_credentials.py.example for what to put in. Do not put credentials from real merchants or processors into this file. You should get test credentials from FeeFighters.
The Django portion of this client requires Django 1.2 or later, particularly because it uses the full_clean function for models.
If you don't have this properly configured as part of Django, the Django tests will not pass. Look in test_extra/django for a quick test-only setup.
Testing only core.py:
python test.py
This will run every test, and fail the Django ones:
Testing everything:
./manage.py test samurai_client_python
This requires that you have samurai_client_python in your INSTALLED_APPS.