Simple Bluepay API Wrapper.
Add this line to your application's Gemfile:
gem 'bluepay-rb'
And then execute:
$ bundle install
Or install it yourself as:
$ gem install bluepay-rb
Bluepay.account_id = "blah"
Bluepay.secret_key = "supersecret"
Bluepay.mode = :live
auth = Bluepay::Auth.new(
amount: '0.00',
source: Bluepay::Card.new(
cc_num: '4111111111111111',
cc_expires: '1227',
cvcvv2: "723",
name1: 'Bobby',
name2: 'Tester',
addr1: '123 Test St.',
addr2: 'Apt #500',
city: 'Testville',
state: 'IL',
zipcode: '94321',
country: 'USA',
phone: '123-123-1234',
email: 'test@bluepay.com',
company_name: ''
)
).create!
auth.trans_id
#=> "10080152343"
auth.message
#=> "INFORMATION STORED"
auth = Bluepay::Auth.new(
amount: 5500, # $55.00
source: card
).create!
auth.trans_id
#=> "10080152349"
auth.message
#=> 'Approved Auth'
capture = Bluepay::Capture.new(
rrno: auth.trans_id
).create!
capture.trans_id
#=> "10080252348"
capture.message
#=> 'Approved Capture'
sale = Bluepay::Sale.new(
amount: 2500,
responsetype: 'DIRECT',
source: card
).create!
void = Bluepay::Void.create!(
rrno: sale.trans_id
)
sale = Bluepay::Sale.new(
amount: 2500,
responsetype: 'DIRECT',
source: card
).create!
# NOTE: Cannot change amount unless the sale is settled.
refund = Bluepay::Refund.create!(
rrno: sale.trans_id,
amount: 1000
)
refund.message
#=> "Approved Void" or "Approved Refund" # depends on if settled.
report = Bluepay::Report.generate!(
query_by_settlement: true,
report_start_date: '2020-04-01',
report_end_date: '2020-04-30'
)
report.rows.first.id
#=> "10080152343"
report.rows.first
# => #<OpenStruct id="100867577224", payment_type="CREDIT", trans_type="AUTH", amount="0.00", card_type="VISA", payment_account="xxxxxxxxxxxx1111", order_id="100867577224", invoice_id="100867577224", custom_id="", custom_id2="", master_id="", status="1", f_void="", message="INFORMATION STORED", origin="bp10emu", issue_date="2020-04-06 11:17:25", settle_date="", rebilling_id="", settlement_id="", card_expire="1225", bank_name="", addr1="123 Test St.", addr2="Apt #500", city="Testville", state="IL", zip="54321", phone="123-123-1234", email="test@bluepay.com", auth_code="", name1="Bob", name2="Tester", company_name="", memo="", backend_id="", doc_type="", f_captured="", avs_result="_", cvv_result="_", card_present="0", merchdata="", level_3_data="", remote_ip="75.139.119.161", connected_ip="75.139.119.161", level_2_data="">
report = Bluepay::Report.generate!(
transaction_id: '100867577224',
report_start_date: '2020-04-01',
report_end_date: '2020-04-30'
)
report.rows.first.id
#=> "10080152343"
report.rows.first
# => #<OpenStruct id="100867577224", payment_type="CREDIT", trans_type="AUTH", amount="0.00", card_type="VISA", payment_account="xxxxxxxxxxxx1111", order_id="100867577224", invoice_id="100867577224", custom_id="", custom_id2="", master_id="", status="1", f_void="", message="INFORMATION STORED", origin="bp10emu", issue_date="2020-04-06 11:17:25", settle_date="", rebilling_id="", settlement_id="", card_expire="1225", bank_name="", addr1="123 Test St.", addr2="Apt #500", city="Testville", state="IL", zip="54321", phone="123-123-1234", email="test@bluepay.com", auth_code="", name1="Bob", name2="Tester", company_name="", memo="", backend_id="", doc_type="", f_captured="", avs_result="_", cvv_result="_", card_present="0", merchdata="", level_3_data="", remote_ip="75.139.119.161", connected_ip="75.139.119.161", level_2_data="">
report = Bluepay::Report.generate!(
transaction_id: '10008..',
starts_on: Date.new
ends_on: Date.new
)
report['100867577224']
# => #<OpenStruct id="100867577224", payment_type="CREDIT", trans_type="AUTH", amount="0.00", card_type="VISA", payment_account="xxxxxxxxxxxx1111", order_id="100867577224", invoice_id="100867577224", custom_id="", custom_id2="", master_id="", status="1", f_void="", message="INFORMATION STORED", origin="bp10emu", issue_date="2020-04-06 11:17:25", settle_date="", rebilling_id="", settlement_id="", card_expire="1225", bank_name="", addr1="123 Test St.", addr2="Apt #500", city="Testville", state="IL", zip="54321", phone="123-123-1234", email="test@bluepay.com", auth_code="", name1="Bob", name2="Tester", company_name="", memo="", backend_id="", doc_type="", f_captured="", avs_result="_", cvv_result="_", card_present="0", merchdata="", level_3_data="", remote_ip="75.139.119.161", connected_ip="75.139.119.161", level_2_data="">
card = Bluepay::Card.new(
cc_num: '4111111111111111',
cc_expires: '1227',
cvcvv2: "723",
name1: 'Bobby',
name2: 'Tester',
addr1: '123 Test St.',
addr2: 'Apt #500',
city: 'Testville',
state: 'IL',
zipcode: '94321',
country: 'USA',
phone: '123-123-1234',
email: 'test@bluepay.com',
company_name: ''
).save!
#=> <BluePay::Card>
card.trans_id
#=> card.trans_id
card.auth
#=> <Bluepay::Auth>
Bluepay::BankAccount.new(
ach_routing: '123123123',
ach_account: '123456789',
ach_account_type: 'C',
name1: 'Bobby',
name2: 'Tester',
addr1: '123 Test St.',
addr2: 'Apt #500',
city: 'Testville',
state: 'IL',
zipcode: '94321',
country: 'USA',
phone: '123-123-1234',
email: 'test@bluepay.com',
company_name: ''
).save!
#=> <BluePay::BankAccount>
bank_account.trans_id
#=> bank_account.trans_id
bank_account.auth
#=> <Bluepay::Auth>
transaction = Bluepay::Transaction.retrieve!('10080152343')
transaction.amount
#=> "10.00"
When you pass parameters to this gem's methods, we convert them to the API's
style of parameters for you. This means you can pass symbols as keys and that
there is a 1:1 mapping to the paramters in the Bluepay provided API
documentation.
Some paramerters will be converted to the expected strings before passing to the Bluepay API.
:amount can take an Integer of the amount in cents, a Float in dollars,
or a formatted string.Date or Datetime instance or a formatted string.Bluepay uses the Central Timezone (US). Some parameters will convert time/date like objects to strings but will use the given objects hours. As such, you must pass in approriate date or time objects in Central Timezone or offset.
Voids work on unsettled transactions. Refunds work on settled transactions.
That being said, you can Refund the full amount of an unsettled transaction, but
if the amount is changed it will fail with a message of
Refund/VOID amount cannot exceed original charge amount.
Links
Documentation
APIs
After checking out the repo, run bin/setup to install dependencies. Then, run
rake test to run the tests. You can also run bin/console for an interactive
prompt that will allow you to experiment.
The gem doesn't come with default credentials for BluePay. You will need to provide those
https://www.bluepay.com/sites/default/files/documentation/bpdailyreport2formHMAC_SHA512.htm
Add a .env to run tests.
BLUEPAY_ACCOUNT_ID=100....
BLUEPAY_SECRET_KEY=WCP0....
Run tests with:
rake test
To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.
Bug reports and pull requests are welcome on GitHub at https://github.com/nearapogee/bluepay-rb.
FAQs
Unknown package
We found that bluepay-rb demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Malicious Go packages are impersonating popular libraries to install hidden loader malware on Linux and macOS, targeting developers with obfuscated payloads.
Security News
Bybit's $1.46B hack by North Korea's Lazarus Group pushes 2025 crypto losses to $1.6B in just two months, already surpassing all of 2024's $1.49B total.
Security News
OpenSSF has published OSPS Baseline, an initiative designed to establish a minimum set of security-related best practices for open source software projects.