Daimyo: Samurai Gateway API client for Node.js

Samurai is a payment gateway by the popular FeeFighters payment processor comparison service. Daimyo is a Node.js library for integrating Samurai into your Node.js application.

Documentation

Maintainer

Installation

npm install daimyo

FAQ

Where can I get Daimyo?

You can get Daimyo via npm, or via GitHub

Why should I use Daimyo and not Samurai API directly?

If you want to use the API directly, sure. I won't stand in your way. In fact it may be a good idea to first try the raw API, just to get a feel of how badly you want to use Daimyo!

Is Daimyo PCI compliant?

No. Daimyo itself is not atested for PCI-compliance, but you can use Samurai (and Daimyo) in ways that make PCI irrelevant for you. Also, Daimyo is quite new so it should not be considered otherwise secure yet. When it reaches version 0.1, though, it should be pretty secure and battle-tested.

Does it mean that Daimyo is not secure?

A lot of work has been done on securing Daimyo, not only against unvalidated user input, but also against potential API misuse by malicious code or accident. However, the work on security is still not quite done. Current target for the paranoid implementation is v0.1.

Should I use the pre-release version?

No, please don't use the pre-release version and file a story of lost millions in profit and reputation as bug report. The pre-release version (latest commits on GitHub) usually contain untested code that are almost guaranteed to fail. You should generally stick to released versions.

But pre-release version has this awesome feature X!

Yes, it sure does. In some cases, it may also contain fixes for known issues. But that does not mean it does not also contain new issues. (In fact, it usually does.)

Should I use the daimyo.Card.create() method?

Only use this method if you are reasonably confident that you will be able to achieve full PCI compliance. In other words, you should generally avoid doing that. Fines for failing to comply with PCI are scary, and nobody has gotten away with it so far.

I found a bug!

Hey, thanks for that! Please report it in the issue tracker. When filing a bug, please try to include as much information as possible. Most helpful information is the piece of code that triggered the error, maybe a small test app (or even better, a unit test!), and your configuration. Oh, and don't forget the exact error message.

I want feature X. Can I file an issue for that?

Yes, please!

I have some personal issues. Can I file those as well?

No.

I have a patch. Can I send you a pull request?

Generally, yes. Tests and docs would be highly appreciated, though, so please try to send them along with the patch. Also, indent the code with 2 spaces, not 4, and no tabs please. Take a look at the source code and you'll get the idea of what's required.

Who uses Diamyo?

Daimyo is currently used by Herd Hound. If you use it too, join us! email me and I'll add you to the list here.