Class: ActiveMerchant::Billing::PinGateway

Inherits:
Gateway
  • Object
show all
Defined in:
lib/active_merchant/billing/gateways/pin.rb

Constant Summary

Constants inherited from Gateway

Gateway::CREDIT_DEPRECATION_MESSAGE, Gateway::RECURRING_DEPRECATION_MESSAGE, Gateway::STANDARD_ERROR_CODE

Instance Attribute Summary

Attributes inherited from Gateway

#options

Instance Method Summary collapse

Methods inherited from Gateway

#add_field_to_post_if_present, #add_fields_to_post_if_present, card_brand, #card_brand, #generate_unique_id, inherited, supported_countries, #supported_countries, supported_countries=, supports?, #supports_network_tokenization?, #supports_scrubbing?, #test?

Methods included from CreditCardFormatting

#expdate, #format

Methods included from PostsData

included, #raw_ssl_request, #ssl_get, #ssl_post, #ssl_request

Constructor Details

#initialize(options = {}) ⇒ PinGateway

Returns a new instance of PinGateway.



14
15
16
17
 
# File 'lib/active_merchant/billing/gateways/pin.rb', line 14

def initialize(options = {})
  requires!(options, :api_key)
  super
end

Instance Method Details

#authorize(money, creditcard, options = {}) ⇒ Object

Authorize an amount on a credit card. Once authorized, you can later capture this charge using the charge token that is returned.



67
68
69
70
71
 
# File 'lib/active_merchant/billing/gateways/pin.rb', line 67

def authorize(money, creditcard, options = {})
  options[:capture] = false

  purchase(money, creditcard, options)
end

#capture(money, token, options = {}) ⇒ Object

Captures a previously authorized charge. Capturing only part of the original authorization is currently not supported.



75
76
77
 
# File 'lib/active_merchant/billing/gateways/pin.rb', line 75

def capture(money, token, options = {})
  commit(:put, "charges/#{CGI.escape(token)}/capture", { amount: amount(money) }, options)
end

#purchase(money, creditcard, options = {}) ⇒ Object

Create a charge using a credit card, card token or customer token

To charge a credit card: purchase(, [creditcard hash], …) To charge a customer: purchase(, [token], …)



23
24
25
26
27
28
29
30
31
32
33
34
35
36
 
# File 'lib/active_merchant/billing/gateways/pin.rb', line 23

def purchase(money, creditcard, options = {})
  post = {}

  add_amount(post, money, options)
  add_customer_data(post, options)
  add_invoice(post, options)
  add_creditcard(post, creditcard)
  add_address(post, creditcard, options)
  add_capture(post, options)
  add_metadata(post, options)
  add_3ds(post, options)

  commit(:post, 'charges', post, options)
end

#refund(money, token, options = {}) ⇒ Object

Refund a transaction



61
62
63
 
# File 'lib/active_merchant/billing/gateways/pin.rb', line 61

def refund(money, token, options = {})
  commit(:post, "charges/#{CGI.escape(token)}/refunds", { amount: amount(money) }, options)
end

#scrub(transcript) ⇒ Object 



99
100
101
102
103
104
 
# File 'lib/active_merchant/billing/gateways/pin.rb', line 99

def scrub(transcript)
  transcript.
    gsub(%r((Authorization: Basic )\w+), '\1[FILTERED]').
    gsub(/(number\\?":\\?")(\d*)/, '\1[FILTERED]').
    gsub(/(cvc\\?":\\?")(\d*)/, '\1[FILTERED]')
end

#store(creditcard, options = {}) ⇒ Object

Create a customer and associated credit card. The token that is returned can be used instead of a credit card parameter in the purchase method



40
41
42
43
44
45
46
47
 
# File 'lib/active_merchant/billing/gateways/pin.rb', line 40

def store(creditcard, options = {})
  post = {}

  add_creditcard(post, creditcard)
  add_customer_data(post, options)
  add_address(post, creditcard, options)
  commit(:post, 'customers', post, options)
end

#supports_scrubbing ⇒ Object 



95
96
97
 
# File 'lib/active_merchant/billing/gateways/pin.rb', line 95

def supports_scrubbing
  true
end

#unstore(token) ⇒ Object

Unstore a customer and associated credit card.



50
51
52
53
54
55
56
57
58
 
# File 'lib/active_merchant/billing/gateways/pin.rb', line 50

def unstore(token)
  customer_token =
    if /cus_/.match?(token)
      get_customer_token(token)
    else
      token
    end
  commit(:delete, "customers/#{CGI.escape(customer_token)}", {}, {})
end

#update(token, creditcard, options = {}) ⇒ Object

Updates the credit card for the customer.



85
86
87
88
89
90
91
92
93
 
# File 'lib/active_merchant/billing/gateways/pin.rb', line 85

def update(token, creditcard, options = {})
  post = {}
  token = get_customer_token(token)

  add_creditcard(post, creditcard)
  add_customer_data(post, options)
  add_address(post, creditcard, options)
  commit(:put, "customers/#{CGI.escape(token)}", post, options)
end

#void(token, options = {}) ⇒ Object

Voids a previously authorized charge.



80
81
82
 
# File 'lib/active_merchant/billing/gateways/pin.rb', line 80

def void(token, options = {})
  commit(:put, "charges/#{CGI.escape(token)}/void", {}, options)
end