veritrans 2.1.2 → 2.4.0

data/lib/test/transaction_test.rb

@@ -0,0 +1,160 @@
+require 'veritrans'
+require 'minitest/autorun'
+
+class TestVeritrans < Minitest::Test
+
+  def setup
+    @mt_test = Veritrans.new(
+      server_key: "SB-Mid-server-uQmMImQMeo0Ky3Svl90QTUj2",
+      client_key: "SB-Mid-client-ArNfhrh7st9bQKmz",
+      api_host: "https://api.sandbox.midtrans.com",
+      logger: Logger.new(STDOUT),
+      file_logger: Logger.new(STDOUT)
+    )
+  end
+
+  def test_charge_permata_va
+    result = @mt_test.charge(
+      {
+        "payment_type": "bank_transfer",
+        "transaction_details": {
+          "gross_amount": 10000,
+          "order_id": "ruby-lib-test-#{Time.now.to_i}"
+        },
+        "bank_transfer": {
+          "bank": "permata",
+          "va_number": "1234567891"
+        }
+      }
+    )
+    assert_equal 201, result.status_code
+    assert_equal "pending", result.transaction_status
+    assert_equal "Success, PERMATA VA transaction is successful", result.status_message
+  end
+
+  def test_cancel_permata_va
+    charge = @mt_test.charge(
+      {
+        "payment_type": "bank_transfer",
+        "transaction_details": {
+          "gross_amount": 10000,
+          "order_id": "ruby-lib-test-#{Time.now.to_i}"
+        },
+        "bank_transfer": {
+          "bank": "permata",
+          "va_number": "1234567891"
+        }
+      }
+    )
+    cancel = @mt_test.cancel(charge.transaction_id)
+    assert_equal 200, cancel.status_code
+    assert_equal "cancel", cancel.transaction_status
+  end
+
+  def test_expire_permata_va
+    charge = @mt_test.charge(
+      {
+        "payment_type": "bank_transfer",
+        "transaction_details": {
+          "gross_amount": 10000,
+          "order_id": "ruby-lib-test-#{Time.now.to_i}"
+        },
+        "bank_transfer": {
+          "bank": "permata",
+          "va_number": "1234567891"
+        }
+      }
+    )
+    expire = @mt_test.expire(charge.transaction_id)
+    assert_equal "Success, transaction has expired", expire.status_message
+    assert_equal 407, expire.status_code
+    assert_equal "expire", expire.transaction_status
+  end
+
+  def test_get_status_transaction
+    charge = @mt_test.charge(
+      {
+        "payment_type": "bank_transfer",
+        "transaction_details": {
+          "gross_amount": 10000,
+          "order_id": "ruby-lib-test-#{Time.now.to_i}"
+        },
+        "bank_transfer": {
+          "bank": "permata",
+          "va_number": "1234567891"
+        }
+      }
+    )
+    result = @mt_test.status(charge.transaction_id)
+    assert_equal 201, result.status_code
+    assert_equal "Success, transaction is found", result.status_message
+  end
+
+  def test_approve_transaction
+    card = {
+      card_number: 5510111111111115,
+      card_cvv: 123,
+      card_exp_month: 12,
+      card_exp_year: 2025
+    }
+    get_token = @mt_test.test_token(card)
+    charge = @mt_test.charge(
+      {
+        "payment_type": "credit_card",
+        "transaction_details": {
+          "gross_amount": 10000,
+          "order_id": "ruby-lib-test-#{Time.now.to_i}"
+        },
+        "credit_card": {
+          "token_id": "#{get_token.token_id}",
+          "authentication": "false"
+        }
+      }
+    )
+    result = @mt_test.approve(charge.transaction_id)
+    assert_equal "Success, transaction is approved", result.status_message
+    assert_equal 200, result.status_code
+    assert_equal "accept", result.fraud_status
+  end
+
+  def test_deny_transaction
+    card = {
+      card_number: 5510111111111115,
+      card_cvv: 123,
+      card_exp_month: 12,
+      card_exp_year: 2025
+    }
+    get_token = @mt_test.test_token(card)
+    charge = @mt_test.charge(
+      {
+        "payment_type": "credit_card",
+        "transaction_details": {
+          "gross_amount": 10000,
+          "order_id": "ruby-lib-test-#{Time.now.to_i}"
+        },
+        "credit_card": {
+          "token_id": "#{get_token.token_id}",
+          "authentication": "false"
+        }
+      }
+    )
+    result = @mt_test.deny(charge.transaction_id)
+    assert_equal 200, result.status_code
+    assert_equal "Success, transaction is denied", result.status_message
+    assert_equal "deny", result.fraud_status
+  end
+
+  def test_fail_refund_transaction
+    begin
+    param = {
+      "refund_key": "reference1",
+      "amount": 5000,
+      "reason": "for some reason"
+    }
+    @mt_test.refund("dummy-order-id", param)
+    rescue MidtransError => e
+      assert_equal "404", e.status
+      end
+  end
+
+  end

data/lib/veritrans/api.rb

@@ -1,13 +1,12 @@
 # Veritrans API methods
 
-require 'uri'
+require 'erb'
 
 class Veritrans
   module Api
 
-    # POST /v2/charge { payment_type: "vtlink" }
-    # Docs http://docs.veritrans.co.id/vtdirect/integration_cc.html#step2
-    # Docs http://docs.veritrans.co.id/sandbox/charge.html
+    # POST /v2/charge { payment_type: "credit_card" }
+    # Docs https://api-docs.midtrans.com/#charge-features
     #
     # Example:
     # Veritrans.charge(
@@ -29,7 +28,7 @@ class Veritrans
       data[:payment_type] = payment_type if payment_type
 
       if data.has_key?(:payment_options)
-        data[ payment_type.to_sym ] = data.delete(:payment_options)
+        data[payment_type.to_sym] = data.delete(:payment_options)
       end
 
       # Rename keys:
@@ -38,54 +37,87 @@ class Veritrans
       # items       -> item_details
       # customer    -> customer_details
 
-      data[:transaction_details]  = data.delete(:payment)     if data[:payment]
-      data[:transaction_details]  = data.delete(:transaction) if data[:transaction]
-      data[:item_details]         = data.delete(:items)       if data[:items]
-      data[:customer_details]     = data.delete(:customer)    if data[:customer]
+      data[:transaction_details] = data.delete(:payment) if data[:payment]
+      data[:transaction_details] = data.delete(:transaction) if data[:transaction]
+      data[:item_details] = data.delete(:items) if data[:items]
+      data[:customer_details] = data.delete(:customer) if data[:customer]
 
       request_with_logging(:post, config.api_host + "/v2/charge", data)
     end
 
-    # POST https://app.sandbox.veritrans.co.id/snap/v1/charge
+    def test_token(options = {})
+      options[:client_key] = config.client_key
+      request_with_logging(:get, config.api_host + '/v2/token', options)
+    end
+
+    alias_method :create_card_token, :test_token
+
+    # POST https://app.sandbox.midtrans.com/snap/v1/transactions
+    # Create Snap payment page, with this version returning full API response
     def create_snap_token(options = {})
-      result = request_with_logging(:post, config.api_host.sub('//api.', '//app.') + "/snap/v1/charge", options)
+      result = request_with_logging(:post, config.api_host.sub('//api.', '//app.') + "/snap/v1/transactions", options)
       Veritrans::SnapResult.new(result.response, result.url, result.request_options, result.time)
     end
 
     alias_method :create_widget_token, :create_snap_token
+    alias_method :create_snap_redirect_url, :create_snap_token
+
+    # POST https://app.sandbox.midtrans.com/snap/v1/transactions
+    # Create Snap payment page, with this version returning token
+    def create_snap_token_string(options = {})
+      result = create_snap_token(options)
+      result.token
+    end
+
+    # POST https://app.sandbox.midtrans.com/snap/v1/transactions
+    # Create Snap payment page, with this version returning redirect url
+    def create_snap_redirect_url_str(options = {})
+      result = create_snap_token(options)
+      result.redirect_url
+    end
 
     # POST /v2/{id}/cancel
-    # Docs http://docs.veritrans.co.id/en/api/methods.html#Cancel
+    # Docs https://api-docs.midtrans.com/#cancel-transaction
     def cancel(payment_id, options = {})
       if !payment_id || payment_id.to_s == ""
         raise ArgumentError, "parameter payment_id can not be blank (got #{payment_id.class} : #{payment_id.inspect})"
       end
 
-      request_with_logging(:post, config.api_host + "/v2/#{URI.escape(payment_id)}/cancel", options)
+      request_with_logging(:post, config.api_host + "/v2/#{ERB::Util.url_encode(payment_id)}/cancel", options)
     end
 
     # POST /v2/{id}/approve
-    # Docs http://docs.veritrans.co.id/en/api/methods.html#Approve
+    # Docs https://api-docs.midtrans.com/#approve-transaction
     def approve(payment_id, options = {})
       if !payment_id || payment_id.to_s == ""
         raise ArgumentError, "parameter payment_id can not be blank (got #{payment_id.class} : #{payment_id.inspect})"
       end
 
-      request_with_logging(:post, config.api_host + "/v2/#{URI.escape(payment_id)}/approve", options)
+      request_with_logging(:post, config.api_host + "/v2/#{ERB::Util.url_encode(payment_id)}/approve", options)
+    end
+
+    # POST /v2/{id}/refund
+    # Docs https://api-docs.midtrans.com/#refund-transaction
+    def refund(payment_id, options = {})
+      if !payment_id || payment_id.to_s == ''
+        raise ArgumentError, "parameter payment_id can not be blank (got #{payment_id.class} : #{payment_id.inspect})"
+      end
+
+      request_with_logging(:post, config.api_host + "/v2/#{ERB::Util.url_encode(payment_id)}/refund", options)
     end
 
     # GET /v2/{id}/status
-    # Docs http://docs.veritrans.co.id/en/api/methods.html#Status
+    # Docs https://api-docs.midtrans.com/#get-status-transaction
     def status(payment_id)
       if !payment_id || payment_id.to_s == ""
         raise ArgumentError, "parameter payment_id can not be blank (got #{payment_id.class} : #{payment_id.inspect})"
       end
 
-      get(config.api_host + "/v2/#{URI.escape(payment_id)}/status")
+      get(config.api_host + "/v2/#{ERB::Util.url_encode(payment_id)}/status")
     end
 
     # POST /v2/capture
-    # Docs http://docs.veritrans.co.id/en/api/methods.html#Capture
+    # Docs https://api-docs.midtrans.com/#capture-transaction
     def capture(payment_id, gross_amount, options = {})
       if !payment_id || payment_id.to_s == ""
         raise ArgumentError, "parameter payment_id can not be blank (got #{payment_id.class} : #{payment_id.inspect})"
@@ -94,13 +126,24 @@ class Veritrans
       post(config.api_host + "/v2/capture", options.merge(transaction_id: payment_id, gross_amount: gross_amount))
     end
 
+    # POST /v2/{id}/deny
+    # Docs https://api-docs.midtrans.com/#deny-transaction
+    def deny(payment_id, options = {})
+      if !payment_id || payment_id.to_s == ''
+        raise ArgumentError, "parameter payment_id can not be blank (got #{payment_id.class} : #{payment_id.inspect})"
+      end
+
+      request_with_logging(:post, config.api_host + "/v2/#{ERB::Util.url_encode(payment_id)}/deny", options)
+    end
+
     # POST /v2/{id}/expire
+    # Docs https://api-docs.midtrans.com/#expire-transaction
     def expire(payment_id)
       if !payment_id || payment_id.to_s == ""
         raise ArgumentError, "parameter payment_id can not be blank (got #{payment_id.class} : #{payment_id.inspect})"
       end
 
-      request_with_logging(:post, config.api_host + "/v2/#{URI.escape(payment_id)}/expire", nil)
+      request_with_logging(:post, config.api_host + "/v2/#{ERB::Util.url_encode(payment_id)}/expire", nil)
     end
 
     # POST /v2/charge { payment_type: "vtlink" }
@@ -112,7 +155,7 @@ class Veritrans
 
     # DELETE /v2/vtlink/{id}
     def delete_vtlink(id, options)
-      request_with_logging(:delete, config.api_host + "/v2/vtlink/#{URI.escape(id)}", options)
+      request_with_logging(:delete, config.api_host + "/v2/vtlink/#{ERB::Util.url_encode(id)}", options)
     end
 
     # GET /v2/point_inquiry/{token_id}
@@ -123,7 +166,88 @@ class Veritrans
 
       request_with_logging(:get, config.api_host + "/v2/point_inquiry/#{token_id}", {})
     end
+
     alias_method :point_inquiry, :inquiry_points
 
-  end
-end
+    # POST /v2/pay/account
+    # param create pay account request (more params detail refer to: https://api-docs.midtrans.com/#create-pay-account)
+    def link_payment_account(param)
+      if param == nil
+        raise ArgumentError, "parameter Payment_type gopay cannot be blank"
+      end
+
+      request_with_logging(:post, config.api_host + "/v2/pay/account", param)
+    end
+
+    # GET /v2/pay/account/{account_id}
+    # account_id (more params detail refer to: https://api-docs.midtrans.com/#get-pay-account)
+    def get_payment_account(account_id)
+      if account_id == nil || account_id == ''
+        raise ArgumentError, "account_id cannot be blank"
+      end
+
+      request_with_logging(:get, config.api_host + "/v2/pay/account/#{account_id}", {})
+    end
+
+    # POST /v2/pay/account/{account_id}/unbind
+    # account_id (more params detail refer to: https://api-docs.midtrans.com/#unbind-pay-account)
+    def unlink_payment_account(account_id)
+      if account_id == nil || account_id == ''
+        raise ArgumentError, "parameter account_id cannot be blank"
+      end
+
+      request_with_logging(:post, config.api_host + "/v2/pay/account/#{account_id}/unbind", {})
+    end
+
+    # POST /v1/subscription
+    # param create subscription request (more params detail refer to: https://api-docs.midtrans.com/#create-subscription)
+    def create_subscription(param)
+      if param == nil
+        raise ArgumentError, "parameter subscription cannot be blank"
+      end
+
+      request_with_logging(:post, config.api_host + "/v1/subscriptions", param)
+    end
+
+    # GET /v1/subscription/{subscription_id}
+    # get subscription request (more params detail refer to: https://api-docs.midtrans.com/#get-subscription)
+    def get_subscription(subscription_id)
+      if subscription_id == nil || subscription_id == ''
+        raise ArgumentError, "subscription_id cannot be blank"
+      end
+
+      request_with_logging(:get, config.api_host + "/v1/subscriptions/#{subscription_id}", {})
+    end
+
+    # POST /v1/subscription/{subscription_id}/disable
+    # disable subscription request (more params detail refer to: https://api-docs.midtrans.com/#disable-subscription)
+    def disable_subscription(subscription_id)
+      if subscription_id == nil || subscription_id == ''
+        raise ArgumentError, "subscription_id cannot be blank"
+      end
+
+      request_with_logging(:post, config.api_host + "/v1/subscriptions/#{subscription_id}/disable", {})
+    end
+
+    # POST /v1/subscription/{subscription_id}/disable
+    # enable subscription request (more params detail refer to: https://api-docs.midtrans.com/#enable-subscription)
+    def enable_subscription(subscription_id)
+      if subscription_id == nil || subscription_id == ''
+        raise ArgumentError, "subscription_id cannot be blank"
+      end
+
+      request_with_logging(:post, config.api_host + "/v1/subscriptions/#{subscription_id}/enable", {})
+    end
+
+    # PATCH /v1/subscription/{subscription_id}
+    # update subscription request (more params detail refer to: https://api-docs.midtrans.com/#update-subscription)
+    def update_subscription(subscription_id, param)
+      if subscription_id && param == nil || subscription_id && param == ''
+        raise ArgumentError, "subscription_id and param cannot be blank"
+      end
+
+      request_with_logging(:patch, config.api_host + "/v1/subscriptions/#{subscription_id}", param)
+      end
+    end
+
+end

data/lib/veritrans/client.rb

@@ -7,7 +7,8 @@ require 'excon'
 class Veritrans
   module Client
 
-    # Failback for activesupport
+    # If you using Rails then it will call ActiveSupport::JSON.encode
+    # Otherwise JSON.pretty_generate
     def self._json_encode(params)
       if defined?(ActiveSupport) && defined?(ActiveSupport::JSON)
         ActiveSupport::JSON.encode(params)
@@ -21,6 +22,8 @@ class Veritrans
       Veritrans::Client._json_encode(params)
     end
 
+    # If you using Rails then it will call ActiveSupport::JSON.decode
+    # Otherwise JSON.parse
     def self._json_decode(params)
       if defined?(ActiveSupport) && defined?(ActiveSupport::JSON)
         ActiveSupport::JSON.decode(params)
@@ -65,27 +68,38 @@ class Veritrans
       make_request(:post, url, params)
     end
 
+    def patch(url, params)
+      make_request(:patch, url, params)
+    end
+
     def make_request(method, url, params, auth_header = nil)
       if !config.server_key || config.server_key == ''
-        raise "Please add server_key to config/veritrans.yml"
+        raise "Please configure your server key"
       end
 
       method = method.to_s.upcase
-      logger.info "Veritrans: #{method} #{url} #{_json_encode(params)}"
-      logger.info "Veritrans: Using server key: #{config.server_key}"
+      logger.info "Midtrans: #{method} #{url} #{_json_encode(params)}"
+      #logger.info "Veritrans: Using server key: #{config.server_key}"
       #puts "Veritrans: #{method} #{url} #{_json_encode(params)}"
 
       default_options = config.http_options || {}
 
+      idempotency_key = config.idempotency_key
+      append_notif_url = config.append_notif_url
+      override_notif_url = config.override_notif_url
+
       # Add authentication and content type
-      # Docs http://docs.veritrans.co.id/sandbox/introduction.html
+      # Docs https://api-docs.midtrans.com/#http-s-header
       request_options = {
         :path => URI.parse(url).path,
         :headers => {
-          :Authorization => auth_header || basic_auth_header(config.server_key),
-          :Accept => "application/json",
-          :"Content-Type" => "application/json",
-          :"User-Agent" => "Veritrans ruby gem #{Veritrans::VERSION}"
+          "Authorization" => auth_header || basic_auth_header(config.server_key),
+          "Accept" => "application/json",
+          "Content-Type" => "application/json",
+          "User-Agent" => "Veritrans ruby gem #{Veritrans::VERSION}",
+          "Idempotency-Key" => "#{idempotency_key}",
+          "X-Append-Notification" => "#{append_notif_url}",
+          "X-Override-Notification" => "#{override_notif_url}"
         }
       }
 
@@ -99,19 +113,41 @@ class Veritrans
         read_timeout: 120,
         write_timeout: 120,
         connect_timeout: 120
-      }.deep_merge(default_options)
+      }.merge(default_options)
 
       s_time = Time.now
       request = Excon.new(url, connection_options)
 
       response = request.send(method.downcase.to_sym, request_options)
 
-      logger.info "Veritrans: got #{(Time.now - s_time).round(3)} sec #{response.status} #{response.body}"
+      if defined?(response.body)
+        response_body = JSON.parse(response.body)
+        if response_body.has_key? 'status_code'
+          status_code = Integer(response_body["status_code"])
+          if status_code >= 400 && status_code != 407
+            raise MidtransError.new(
+              "Midtrans API is returning API error. HTTP status code: #{status_code}",
+              "#{status_code}",
+              "#{response_body}",
+              "#{response}")
+          end
+        end
+      end
+
+      if response.status >= 400
+        raise MidtransError.new(
+          "Midtrans API is returning API error. HTTP status code: #{response.status}  API response: #{response.body}",
+          "#{response.status}",
+          "#{response.body}",
+          "#{response}")
+      end
+
+      logger.info "Midtrans: got #{(Time.now - s_time).round(3)} sec #{response.status} #{response.body}"
 
       Result.new(response, url, request_options, Time.now - s_time)
 
     rescue Excon::Errors::SocketError => error
-      logger.info "Veritrans: socket error, can not connect"
+      logger.info "Veritrans: socket error, can not connect (#{error.message})"
       error_response = Excon::Response.new(
         body: '{"status_code": "500", "status_message": "Internal server error, no response from backend. Try again later"}',
         status: '500'

data/lib/veritrans/config.rb

@@ -7,7 +7,7 @@ class Veritrans
   class Config
 
     def initialize(options = nil)
-      @api_host = "https://api.sandbox.veritrans.co.id"
+      @api_host = "https://api.sandbox.midtrans.com"
       apply(options) if options
     end
 
@@ -20,7 +20,6 @@ class Veritrans
       @client_key = value
     end
 
-
     def client_key
       @client_key
     end
@@ -41,9 +40,9 @@ class Veritrans
     ##
     # API Server hostname, this allow to switch between production and sandbox
     #
-    # Should be "https://api.sandbox.veritrans.co.id" or "https://api.veritrans.co.id"
+    # Should be "https://api.sandbox.midtrans.com" or "https://api.midtrans.com"
     #
-    # Default is "https://api.sandbox.veritrans.co.id"
+    # Default is "https://api.sandbox.midtrans.com"
     #
     def api_host=(value)
       @api_host = value
@@ -72,13 +71,37 @@ class Veritrans
       diff = options.keys.map(&:to_sym) - Excon::VALID_CONNECTION_KEYS
       if diff.size > 0
         raise ArgumentError,
-          "http_options contain unsupported keys: #{diff.inspect}\n" +
-          "Supported keys are: #{Excon::VALID_CONNECTION_KEYS.inspect}"
+              "http_options contain unsupported keys: #{diff.inspect}\n" +
+                "Supported keys are: #{Excon::VALID_CONNECTION_KEYS.inspect}"
       end
 
       @http_options = options
     end
 
+    def idempotency_key=(value)
+      @idempotency_key = value
+    end
+
+    def idempotency_key
+      @idempotency_key
+    end
+
+    def append_notif_url=(value)
+      @append_notif_url = value
+    end
+
+    def append_notif_url
+      @append_notif_url
+    end
+
+    def override_notif_url=(value)
+      @override_notif_url = value
+    end
+
+    def override_notif_url
+      @override_notif_url
+    end
+
     def http_options
       @http_options
     end
@@ -93,6 +116,8 @@ class Veritrans
     #
     #   Veritrans.setup do
     #     config.load_yml "#{Rails.root.to_s}/config/veritrans.yml#development"
+    #     # or
+    #     config.load_yml "#{Rails.root.to_s}/config/veritrans.yml", :development
     #   end
     #
     def load_config(filename, yml_section = nil)