veritrans 1.2.6 → 2.0.0beta

checksums.yaml

@@ -1,7 +1,15 @@
 ---
 !binary "U0hBMQ==":
-  metadata.gz: 4a017d4aab2833fbc4ba25a649fe9a00d93eec35
-  data.tar.gz: bafcedb6c0a86d539747f90596e51a11766bb431
-!binary "U0hBNTEy":
-  metadata.gz: f4e0013cacbaabe14522d6e111982c6171d4955e7c25fe8b281a79096f0998f660fa20fc257d02dd626bf68837373df3daf021f382dce58ccc2477d54d90c6b5
-  data.tar.gz: 75430bc2305e45fb21c423d7ac8017456b54214bc305b83f9dd397180389e2aafcb59f5b4f236f9836879b3284584a5edd89abaf2149e90f6cb6910f59e7a476
+  metadata.gz: !binary |-
+    MWMwMzlhMDNjOWVkYzFlYjI3YzgzODc5NzIxYzEwY2NlZTg0MGY3OQ==
+  data.tar.gz: !binary |-
+    MDFhZDNiNDI5ZTRhMDc2N2MzNzY1ODJhMGIwNTcyMDcyOGFiMDYwYQ==
+SHA512:
+  metadata.gz: !binary |-
+    Zjg4MTAzMDcyNjdjMzI5MGY1MDA4ZDFkNzkyNWFjY2NkYmE4MDEzYWNmMzE1
+    MjY0ODYwYWE4MjhkNDAwZjJkNTg3ZjcwNGE5ODI3YWRjOGQ5YTA5ZGZkMzM4
+    M2Y4MmJmZGZkNDgwOWE5NmQ4NmJkZDU3NzNjODczZDkyZGEzMzE=
+  data.tar.gz: !binary |-
+    ODMyNTRiN2JjYjg0MWE3Njk2ODI0MzI1M2VjZGRiNWQ4NDljMjE0ZWIxNTll
+    MjQ1MTM2YWU5ZmE2M2E0NmRmZTFjNzllZTU4YWEwMGMxNTIzY2U2ZTJmNjlh
+    YzI5ODc4ODM2N2M4OGJjODFkOGQzOTlkZTllZWEzYmM2ZWU2ZGY=

data/.gitignore

@@ -0,0 +1,4 @@
+coverage
+rails_example*
+.DS_Store
+

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem 'vcr'

data/Gemfile.lock

@@ -0,0 +1,111 @@
+PATH
+  remote: .
+  specs:
+    veritrans (2.0.0beta)
+      excon (~> 0.20)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (4.1.6)
+      actionpack (= 4.1.6)
+      actionview (= 4.1.6)
+      mail (~> 2.5, >= 2.5.4)
+    actionpack (4.1.6)
+      actionview (= 4.1.6)
+      activesupport (= 4.1.6)
+      rack (~> 1.5.2)
+      rack-test (~> 0.6.2)
+    actionview (4.1.6)
+      activesupport (= 4.1.6)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+    activemodel (4.1.6)
+      activesupport (= 4.1.6)
+      builder (~> 3.1)
+    activerecord (4.1.6)
+      activemodel (= 4.1.6)
+      activesupport (= 4.1.6)
+      arel (~> 5.0.0)
+    activesupport (4.1.6)
+      i18n (~> 0.6, >= 0.6.9)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.1)
+      tzinfo (~> 1.1)
+    addressable (2.3.6)
+    arel (5.0.1.20140414130214)
+    builder (3.2.2)
+    crack (0.4.2)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.2.5)
+    erubis (2.7.0)
+    excon (0.40.0)
+    hike (1.2.3)
+    i18n (0.6.11)
+    json (1.8.1)
+    mail (2.6.1)
+      mime-types (>= 1.16, < 3)
+    mime-types (2.4.3)
+    minitest (5.4.2)
+    multi_json (1.10.1)
+    rack (1.5.2)
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rails (4.1.6)
+      actionmailer (= 4.1.6)
+      actionpack (= 4.1.6)
+      actionview (= 4.1.6)
+      activemodel (= 4.1.6)
+      activerecord (= 4.1.6)
+      activesupport (= 4.1.6)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.1.6)
+      sprockets-rails (~> 2.0)
+    railties (4.1.6)
+      actionpack (= 4.1.6)
+      activesupport (= 4.1.6)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.3.2)
+    rspec (3.1.0)
+      rspec-core (~> 3.1.0)
+      rspec-expectations (~> 3.1.0)
+      rspec-mocks (~> 3.1.0)
+    rspec-core (3.1.7)
+      rspec-support (~> 3.1.0)
+    rspec-expectations (3.1.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.1.0)
+    rspec-mocks (3.1.3)
+      rspec-support (~> 3.1.0)
+    rspec-support (3.1.2)
+    safe_yaml (1.0.4)
+    sprockets (2.11.3)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sprockets-rails (2.2.0)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      sprockets (>= 2.8, < 4.0)
+    thor (0.19.1)
+    thread_safe (0.3.4)
+    tilt (1.4.1)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    vcr (2.9.3)
+    webmock (1.20.2)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rails
+  rspec (>= 2.9.0)
+  vcr
+  veritrans!
+  webmock

data/README.md

@@ -0,0 +1,258 @@
+# Veritrans ruby library
+
+## Installation
+
+     $ gem install veritrans
+
+## How to use (Rails)
+
+### Add veritrans to Gemfile
+
+```ruby
+gem 'veritrans'
+```
+
+    bundle install
+
+### Generate veritrans.yml
+
+    rails g veritrans:install
+
+### Create simple payment form (optional)
+
+    rails g veritrans:payment_form
+
+### Edit api keys in config/veritrans.yml
+
+```yml
+# config/veritrans.yml
+development:
+  client_key: # your api client key
+  server_key: # your api client key
+```
+
+## STEP 1: Process credit cards
+
+
+#### VT-Web
+
+*If you want to use VT-Web, add `payment_type: "VTWEB"`*
+
+```ruby
+@result = Veritrans.charge(
+  payment_type: "VTWEB",
+  transaction_details: {
+    order_id: "my-unique-order-id",
+    gross_amount: 100_000
+  }
+)
+
+redirect_to @result.redirect_url
+```
+
+#### VT-Direct
+
+It's little more complicated, because credit_card is sensitive data,
+you need put credit card number in our safe storage first using `veritrans.js` library, then send received token to with other payment details.
+
+We don't want you to send credit card number to your server, especially for websites not using https.
+
+File: "app/views/shared/_veritrans_include.erb"
+
+```html
+<script src="//api.sandbox.veritrans.co.id/v2/assets/veritrans.js"></script>
+
+<script type="text/javascript">
+  Veritrans.url = "<%= Veritrans.config.api_host %>/v2/token";
+  Veritrans.client_key = "<%= Veritrans.config.client_key %>";
+</script>
+```
+
+Payment form:
+```html
+<form action="/charge_vtdirect" method="post" id="card_form">
+  <input type="hidden" name="token_id" id="card_token">
+  <input type="hidden" id="gross_amount" value="30000">
+  <p>
+    <label for="card_number">Card number</label>
+    <input type="text" id="card_number" style="width: 150px" value="4811 1111 1111 1114">
+  </p>
+  <p>
+    <label for="card_cvc">Security Code</label>
+    <input type="text" id="card_cvc" style="width: 30px" placeholder="cvc" value="123">
+  </p>
+  <p>
+    <label for="card_exp">Expiration date</label>
+    <input type="text" id="card_exp" placeholder="MM / YY" value="12 / 16">
+  </p>
+  <input id="submit_btn" type="submit">
+</form>
+<iframe id="3d-secure-iframe" style="display: none; width: 500px; height: 600px"></iframe>
+```
+
+Sending "get-token" request:
+
+```js
+$(document).ready(function () {
+  // function to prepare our credit card data before send
+  function createTokenData() {
+    return {
+      card_number: $('#card_number').val(),
+      card_cvv: $('#card_cvc').val(),
+      card_exp_month: $('#card_exp').val().match(/(\d+) \//)[1],
+      card_exp_year: '20' + $('#card_exp').val().match(/\/ (\d+)/)[1],
+      gross_amount: $('#gross_amount').val(),
+      secure: true
+    };
+  }
+  // Add custom event for form submition
+  $('#card_form').on('submit', function (event) {
+    var form = this;
+    event.preventDefault();
+
+    Veritrans.token(createTokenData, function (data) {
+      console.log('Token data:', data);
+      // when you making 3D-secure transaction,
+      // this callback function will be called again after user confirm 3d-secure
+      // but you can also redirect on server side
+      if (data.redirect_url) {
+        // if we get url then it's 3d-secure transaction
+        // so we need to open that page
+        $('#3d-secure-iframe').attr('src', data.redirect_url).show();
+      // if no redirect_url and we have token_id then just make charge request
+      } else if (data.token_id) {
+        $('#card_token').val(data.token_id);
+        form.submit();
+      // if no redirect_url and no token_id, then it should be error
+      } else {
+        alert(data.validation_messages ? data.validation_messages.join("\n") : data.status_message);
+      }
+    });
+  });
+});
+```
+
+On a server side:
+
+```ruby
+@result = Veritrans.charge(
+  payment_type: "credit_card",
+  credit_card: { token_id: params[:token_id] },
+  transaction_details: {
+    order_id: @payment.order_id,
+    gross_amount: @payment.amount
+  }
+)
+if @result.success?
+  puts "Success"
+end
+```
+
+## STEP 2: Process not credit cards
+
+We provide many payment channels to receive money, but API is almost same.
+
+For VT-Web in only one request, and payment page will have all available payment options.
+
+For VT-Direct you have to specify payment method (token required only for credit card transactions).
+
+```ruby
+@result = Veritrans.charge(
+  payment_type: "bank_transfer",
+  bank_transfer: { bank: 'permata' },
+  transaction_details: {
+    order_id: @payment.order_id,
+    gross_amount: @payment.amount
+  }
+)
+puts "Please send money to account no. #{@result.permata_va_number} in bank Permata"
+```
+
+See [our documentation](http://docs.veritrans.co.id/sandbox/charge.html) for other available options.
+
+
+## STEP 3: Receive notification callback
+
+For every transaction success and failed we will send you HTTP POST notification (aka webhook)
+
+First you should set callback url in our dashboard https://my.sandbox.veritrans.co.id/settings/vtweb_configuration
+
+In development mode please read our [Testing webhooks tutorial](https://github.com/Paxa/veritrans-ruby/blob/new_api/testing_webhooks.md)
+
+
+For rails:
+
+```ruby
+# config/routes.rb
+match "/payments/receive_webhook" => "payments#receive_webhook", via: [:post]
+
+# app/controllers/payments_controller.rb
+def receive_webhook
+  verified_data = Veritrans.status(params[:transaction_id])
+
+  if verified_data.status_code != 404
+    puts "--- Transaction callback ---"
+    puts "Payment:        #{verified_data.data[:order_id]}"
+    puts "Payment type:   #{verified_data.data[:payment_type]}"
+    puts "Payment status: #{verified_data.data[:transaction_status]}"
+    puts "Fraud status:   #{verified_data.data[:fraud_status]}" if verified_data.data[:fraud_status]
+    puts "Payment amount: #{verified_data.data[:gross_amount]}"
+    puts "--- Transaction callback ---"
+
+    render text: "ok"
+  else
+    render text: "ok", :status => :not_found
+  end
+end
+```
+
+#### Veritrans::Events
+
+Other option to handle callbacks is our rack-based handler
+
+```ruby
+# config/routes.rb
+mount Veritrans::Events.new => '/vt_events'
+
+# config/initalizers/veritrans.rb
+Veritrans.setup do
+  config.server_key = "..."
+  config.client_key = "..."
+
+  events.subscribe('payment.success') do |payment|
+    Payment.find_by(order_id: payment.order_id).mark_paid!(payment.masked_card)
+  end
+
+  events.subscribe('payment.failed', 'payment.challenge') do |payment|
+    Payment.find_by(order_id: payment.order_id) ...
+  end
+end
+```
+
+#### Logging
+
+By default gem veritrans will show information via rails' logger. And in addition save important information to `RAILS_APP/config/veritrans.log`
+
+It's configurable.
+
+```ruby
+Veritrans.logger = Logger.new("/my/logs/veritrans.log")
+Veritrans.file_logger = Logger.new("/my/important_logs/veritrans.log")
+```
+
+`Veritrans.file_logger` save information about:
+
+* "charge", "cancel", "approve" api calls
+* Validation errors for "charge", "cancel", "approve"
+* Received http notifications
+* Errors and exception while processing http notifications
+
+
+#### Get help
+
+* [Veritrans gem reference](https://github.com/Paxa/veritrans-ruby/blob/new_api/api_reference.md)
+* [Veritrans sandbox login](https://my.sandbox.veritrans.co.id/register)
+* [Veritrans sandbox registration](https://my.sandbox.veritrans.co.id/register)
+* [Veritrans registration](https://my.veritrans.co.id/register)
+* [Veritrans documentation](http://docs.veritrans.co.id)
+* Technical support [support@veritrans.co.id](mailto:support@veritrans.co.id)

data/Rakefile

@@ -0,0 +1,7 @@
+require 'rubygems'
+
+task :default => :spec
+
+desc "Run Specs"
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)

data/api_reference.md

@@ -0,0 +1,219 @@
+# API Reference
+
+Here is only reference for API of this gem, to see complete information
+please use our [documentation](http://docs.veritrans.co.id/sandbox/introduction.html)
+
+
+<table>
+  <thead>
+    <tr>
+      <th>Method</th>
+      <th>Descripion</th>
+      <th>Http Method</th>
+      <th>URL</th>
+    </tr>
+  </thead>
+
+  <tbody>
+    <tr>
+      <td><a href="#charge">Veritrans.charge(data)</a></td>
+      <td>Charge Transaction</td>
+      <td>POST</td>
+      <td>api.veritrans.co.id/v2/charge</td>
+    </tr>
+    <tr>
+      <td><a href="#status">Veritrans.status(id)</a></td>
+      <td>Get Last Status</td>
+      <td>GET</td>
+      <td>api.veritrans.co.id/v2/{id}/status</td>
+    </tr>
+    <tr>
+      <td><a href="#cancel">Veritrans.cancel(id)</a></td>
+      <td>Cancel Transaction</td>
+      <td>POST</td>
+      <td>api.veritrans.co.id/v2/{id}/cancel</td>
+    </tr>
+    <tr>
+      <td><a href="#approve">Veritrans.approve(id)</a></td>
+      <td>Approve Challenge Transaction</td>
+      <td>POST</td>
+      <td>api.veritrans.co.id/v2/{id}/approve</td>
+    </tr>
+    <tr>
+      <td><a href="#capture">Veritrans.capture(id)</a></td>
+      <td>Capture Authorise Transaction</td>
+      <td>POST</td>
+      <td>api.veritrans.co.id/v2/{id}/capture</td>
+    </tr>
+  </tbody>
+</table>
+
+
+### <a name="charge"></a> Charge
+
+Actually make transaction. But for vt-web create a redirect url, and for vt-link creates payment page
+
+**For VT-Web:**
+
+```ruby
+q = Veritrans.charge({
+  payment_type: "VTWEB",
+  transaction_details: {
+    order_id: "order-1",
+    gross_amount: 100_000
+  }
+})
+
+q.class # => Veritrans::Result
+q.data == {
+  status_code: "201",
+  status_message: "OK, success do VTWeb transaction, please go to redirect_url",
+  redirect_url: "https://vtweb.sandbox.veritrans.co.id/v2/vtweb/b27d421f-90ff-4427-83d2-fbe8acbbce89"
+}
+```
+
+**For VT-Direct:**
+
+```ruby
+q = Veritrans.charge({
+  # *required
+  payment_type: "credit_card",
+  # *required
+  transaction_details: {
+    order_id: "order-2",
+    gross_amount: 100_000
+  },
+  # *required (but different for different payment type)
+  credit_card: {
+    token_id: "dcd6cd71-bc4c-4f4b-8752-49cb0a3f204c",
+    bank: "cimb"
+  },
+  # optional
+  item_details: [
+    {
+      id: "ITEM1",
+      price: 100_000,
+      quantity: 1,
+      name: "T-Short Infinity"
+    }
+  ],
+  # optional
+  customer_details: {
+    first_name: "Nadia",
+    last_name: "Modjo",
+    email: "noreply@veritrans.co.id",
+    phone: "+6281 123 12345",
+    billing_address: {
+      address: "Jalan Raya Kalijati",
+      city: "Subang",
+      postal_code: "41271",
+    },
+  },
+  # optional
+  custom_field1: "age: 25",
+  custom_field2: "new_year_promo",
+  custom_field3: "submerchant_id: 23"
+});
+
+q.class # => Veritrans::Result
+q.data == {
+  status_code: "200",
+  status_message: "Success, Credit Card transaction is successful",
+  transaction_id: "20bcc3dd-6fa5-4a9a-a9ad-615af992aa3d", 
+  masked_card: "481111-1114",
+  order_id: "order-2",
+  payment_type: "credit_card",
+  transaction_time: "2014-11-03 16:22:52",
+  transaction_status: "capture",
+  fraud_status: "accept",
+  approval_code: "1415006572598",
+  gross_amount: "100000.00"
+}
+
+q.success? # => true
+```
+
+
+### <a name="status"></a> Status
+
+Return current status of transaction.
+
+```ruby
+q = Veritrans.status("order-2")
+
+q.data == {
+  status_code: "200",
+  status_message: "Success, transaction found",
+  transaction_id: "20bcc3dd-6fa5-4a9a-a9ad-615af992aa3d",
+  masked_card: "481111-1114",
+  order_id: "order-2",
+  payment_type: "credit_card",
+  transaction_time: "2014-11-03 16:22:52",
+  transaction_status: "settlement",
+  fraud_status: "accept",
+  signature_key: "639af8e985f68526839e6ed04c1...",
+  bank: "bni",
+  gross_amount: "100000.00"
+}
+```
+
+
+### <a name="cancel"></a> Cancel
+
+Cancel transaction, before it was settled. For credit card payments you can cancel it before we trigger settlement in bank.
+Usually we do settlement next day after payment happen, about 4pm.
+
+For internet banking, bank transfer, mobile payments, convenient store payments if user already made payment,
+you can't cancel it as simple as credit card, but before user sent money you can cancel pending transactions.
+
+```ruby
+q = Veritrans.cancel("testing-0.2072-1415086078")
+
+q.data == {
+  status_code: "200",
+  status_message: "Success, transaction is canceled",
+  transaction_id: "b38f598a-59ab-4850-b311-2aa14c78bc45",
+  masked_card: "481111-1114",
+  order_id: "testing-0.2072-1415086078",
+  payment_type: "credit_card",
+  transaction_time: "2014-11-04 14:29:47",
+  transaction_status: "cancel",
+  fraud_status: "accept",
+  bank: "bni",
+  gross_amount: "100000.00"
+}
+```
+
+
+### <a name="approve"></a> Approve
+
+Some transactions marked as challenge. If challenge you can approve it or cancel it. Usual way is to use our dashboard web interface,
+but you also can do it programatically, via API
+
+```ruby
+q = Veritrans.cancel("testing-0.2072-1415086078")
+
+q.data == {
+  status_code: "200",
+  status_message: "Success, transaction is approved",
+  transaction_id: "8492c240-1600-465a-9bf1-808863410b0e",
+  masked_card: "451111-1117",
+  order_id: "testing-0.0501-1415086808",
+  payment_type: "credit_card",
+  transaction_time: "2014-11-04 14:41:58",
+  transaction_status: "capture",
+  fraud_status: "accept",
+  bank: "bni",
+  gross_amount: "100000.00"
+}
+```
+
+
+### <a name="capture"></a> Capture
+
+This API method is only for merchants who have pre-authorise feature (can be requested) and have pre-authorise payments.
+
+```ruby
+q = Veritrans.capture("testing-0.2072-1415086078", 101_000)
+q.success? # => true
+```