0.1.0 • Published 9 years ago
beanstream v0.1.0
Node-Beanstream
A Node.JS library for communicating with the Beanstream API.
Currently only supports these actions of the Transactions API:
- Card Purchase & Pre-Authorization
- Return
- Pre-Authorization Completion
- Void Purchase & Void Return
Installation
npm install --save beanstream
Usage
Constructor
var Beanstream = require("beanstream");
var beanstream = new Beanstream(options);
options
object -merchant_id
string -passcode
string -username
string -password
string -version
number / string; optional, defaults to1
Credentials for authenticating with Beanstream. Provide username
+ password
, or merchant_id
+ passcode
. merchant_id
is required regardless.
cardPurchase
beanstream.cardPurchase(card, order, callback);
card
object - see Card Objectorder
object - see Order Objectcallback
function -callback
gets passed two arguments:error
anddata
. Data contains to JSON response from Beanstream.
preAuthorization
beanstream.preAuthorization(card, order, callback);
card
object - see Card Objectorder
object - see Order Objectcallback
function -callback
gets passed two arguments:error
anddata
. Data contains to JSON response from Beanstream.
This creates a pre-auth charge by automatically setting card.complete
to false
. See completePreAuthorization for completing the pre-auth transaction.
completePreAuthorization
beanstream.completePreAuthorization(transaction_id, options, callback);
transaction_id
stringoptions
object -amount
number - ordernumber _string; optionalcallback
function -callback
gets passed two arguments:error
anddata
. Data contains to JSON response from Beanstream.
This completes a pre-auth charge.
return
beanstream.return(transaction_id, options, callback);
transaction_id
stringoptions
object -amount
number - ordernumber _string; optionalcallback
function -callback
gets passed two arguments:error
anddata
. Data contains to JSON response from Beanstream.
This creates a return transaction.
void
beanstream.void(transaction_id, options, callback);
transaction_id
stringoptions
object -amount
number - ordernumber _string; optionalcallback
function -callback
gets passed two arguments:error
anddata
. Data contains to JSON response from Beanstream.
This creates a void transaction.
Objects
Card Object
complete
boolean; optional, defaults totrue
name
stringnumber
stringexpiry_month
number / stringexpiry_year
number / stringcvd
string
Order Object
order_number
string,amount
number,comments
string; optionalbilling
object; optional -name
"Beanstream Internet Commerce", -address_line1
string -address_line2
string; optional -city
string -province
string -country
string -postal_code
string -phone_number
string -email_address
stringlanguage
string; optional, defaults to"eng"
customer_ip
: string; optionalterm_url
string; optional
Tests
Follow the instructions in test/credentials_template.js
, then run tests with npm test
0.1.0
9 years ago