tazapay

Tazapay

Tazapay API ruby client

https://docs.tazapay.com/reference/introduction

Installation

Install the gem and add to the application's Gemfile by executing:

$ bundle add tazapay

If bundler is not being used to manage dependencies, install the gem by executing:

$ gem install tazapay

Usage

Setup Tazapay client

require "tazapay"

Tazapay.configure do |config|
  config.base_url =  "<SANDBOX_API_URL / PRODUCTION_API_URL>"
  config.access_key = "<API_Key>"
  config.secret_key = "<API_Secret>"
end

Checkout

tazapay_checkout = Tazapay::Checkout.new

# Create payment transaction
tx_number = tazapay_checkout.pay(data)["data"]["txn_no"]

# Check transaction status
data = tazapay_checkout.get_status(tx_number)

User

tazapay_user = Tazapay::User.new

data = {
  email: "[e-mail]",
  country: "SG",
  ind_bus_type: "Business",
  business_name: "TEST SANDBOX",
  contact_code: "+65",
  contact_number: "9999999999",
  partners_customer_id: "test-123"
}

# Create user
user_id = tazapay_user.create(data)["data"]["account_id"]

# Update user
tazapay_user.update(user_id, new_data)

# Find user by ID
tazapay_user.find(user_id)

# Find user by Email
tazapay_user.find(email)

See more details in tests

Bank

tazapay_bank = Tazapay::Bank.new

data = {
  email: "[e-mail]",
  country: "SG",
  ind_bus_type: "Business",
  business_name: "TEST SANDBOX",
  contact_code: "+65",
  contact_number: "9999999999",
  partners_customer_id: "test-123"
}

# Add bank account
bank_id = tazapay_bank.add(
  account_id: user_id, bank_data: new_data
)['data']['bank_id']

# List user banks
tazapay_bank.list(user_id)

# Make bank account primary
tazapay_bank.make_primary(bank_id: bank_id, account_id: user_id)

Escrow

tazapay_escrow = Tazapay::Escrow.new

# See https://docs.tazapay.com/reference/create-escrow-api
txn_no = tazapay_escrow.create(data)['data']['txn_no']

# See https://docs.tazapay.com/reference/get-escrow-summary-1
tazapay_escrow.summary(txn_no)

# See https://docs.tazapay.com/reference/escrow-status-api
tazapay_escrow.status(txn_no)

# See https://docs.tazapay.com/reference/create-payment-api
payment_url = tazapay_escrow.create_payment(txn_no)['data']['redirect_url']

Release

# See https://docs.tazapay.com/reference/release-api
Tazapay::Release.new.release(txn_no: txn_no)

Refund

tazapay_refund = Tazapay::Refund.new
# See https://docs.tazapay.com/reference/refund-api
tazapay_refund.request(txn_no: txn_no)

# See https://docs.tazapay.com/reference/refund-status-api
tazapay_refund.status(txn_no)

Metadata

tazapay_metadata = Tazapay::Metadata.new

# See https://docs.tazapay.com/reference/country-configuration-api
country = "TH"
tazapay_metadata.country_config(country)

# See https://docs.tazapay.com/reference/invoice-currency-api
tazapay_metadata.invoice_currency(
  buyer_country: "US", seller_country: "TH"
)

# See https://docs.tazapay.com/reference/collection-methods-api
tazapay_metadata.collection_methods(
  buyer_country: "US",
  seller_country: "TH"
  invoice_currency: "USD",
  amount: 100
)

# See https://docs.tazapay.com/reference/disburse-methods-api
tazapay_metadata.disbursement_methods(
  buyer_country: "US",
  seller_country: "TH"
  invoice_currency: "USD",
  amount: 100
)

# Doc upload URL
tazapay_metadata.doc_upload_url

# KYB Doc
country = "TH"
tazapay_metadata.kyb_doc(country)

# See https://docs.tazapay.com/reference/get-milestone-schemes
tazapay_metadata.milestone_scheme

KYB

tazapay_kyb = Tazapay::KYB.new

# See https://docs.tazapay.com/reference/kyb-application-api
application_id = tazapay_kyb.create(data)['data']['application_id']

# See https://docs.tazapay.com/reference/update-kyb-api
tazapay_kyb.update(id: application_id, data)

# See https://docs.tazapay.com/reference/kyb-status-api
tazapay_kyb.status(account_id)

# See https://docs.tazapay.com/reference/get-kyb-by-id-api
tazapay_kyb.find(application_id)

See more details in tests

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

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 the created tag, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/lxkuz/tazapay. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the Tazapay project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.