Class: Gateway::RazorpayGateway

Inherits:
Gateway
  • Object
show all
Defined in:
app/models/spree/gateway/razorpay_gateway.rb

Instance Method Summary collapse

Instance Method Details

#actions ⇒ Object 



65
66
67
 
# File 'app/models/spree/gateway/razorpay_gateway.rb', line 65

def actions
  %w[capture void credit]
end

#auto_capture? ⇒ Boolean

Returns:

  • (Boolean) 


57
58
59
 
# File 'app/models/spree/gateway/razorpay_gateway.rb', line 57

def auto_capture?
  preferred_auto_capture
end

#can_capture?(payment) ⇒ Boolean

Returns:

  • (Boolean) 


69
70
71
 
# File 'app/models/spree/gateway/razorpay_gateway.rb', line 69

def can_capture?(payment)
  %w[checkout pending].include?(payment.state)
end

#can_void?(payment) ⇒ Boolean

Returns:

  • (Boolean) 


73
74
75
 
# File 'app/models/spree/gateway/razorpay_gateway.rb', line 73

def can_void?(payment)
  payment.state != 'void'
end

#cancel(response_code, _source = nil, _options = {}) ⇒ Object 



354
355
356
 
# File 'app/models/spree/gateway/razorpay_gateway.rb', line 354

def cancel(response_code, _source = nil, _options = {})
  void(response_code)
end

#capture(amount_in_cents, response_code, gateway_options = {}) ⇒ Object

UPDATED: Fully implemented Capture method so you can click “Capture” inside Spree Admin



299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'app/models/spree/gateway/razorpay_gateway.rb', line 299

def capture(amount_in_cents, response_code, gateway_options = {})
  provider
  begin
    rzp_payment_id = resolve_razorpay_payment_id(response_code)

    raise StandardError, "Missing Razorpay Payment ID." if rzp_payment_id.blank?

    rzp_payment = ::Razorpay::Payment.fetch(rzp_payment_id)
    if rzp_payment.status == 'authorized'
      rzp_payment.capture({ amount: amount_in_cents, currency: gateway_options[:currency] || 'INR' })
    end

    ActiveMerchant::Billing::Response.new(true, 'Razorpay Capture Successful', {}, test: preferred_test_mode, authorization: rzp_payment_id)
  rescue StandardError => e
    Rails.logger.error("Razorpay Capture Failed: #{e.message}")
    ActiveMerchant::Billing::Response.new(false, "Capture failed: #{e.message}", {}, test: preferred_test_mode)
  end
end

#complete_payment_session(payment_session:, params: {}) ⇒ Object 



156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'app/models/spree/gateway/razorpay_gateway.rb', line 156

def complete_payment_session(payment_session:, params: {})
  provider
  
  # Robustly parse the JSON string sent from Next.js via the Spree API
  result_data = {}
  if params[:session_result].present?
    begin
      result_data = params[:session_result].is_a?(String) ? JSON.parse(params[:session_result]) : params[:session_result]
    rescue JSON::ParserError
      result_data = {}
    end
  end
  
  rzp_payment_id = result_data['razorpay_payment_id'] || result_data[:razorpay_payment_id] || payment_session.external_data['razorpay_payment_id']
  rzp_signature  = result_data['razorpay_signature'] || result_data[:razorpay_signature] || payment_session.external_data['razorpay_signature']

  begin
    # Verify the Signature
    ::Razorpay::Utility.verify_payment_signature(
      razorpay_order_id: payment_session.external_id,
      razorpay_payment_id: rzp_payment_id,
      razorpay_signature: rzp_signature
    )

   # Lock the order database row to prevent race conditions with Webhooks
    payment_session.order.with_lock do
      
      # Save the verified IDs into the session
      session_data = payment_session.external_data || {}
      session_data['razorpay_payment_id'] = rzp_payment_id
      session_data['razorpay_signature'] = rzp_signature
      payment_session.update!(external_data: session_data)

      # Fetch payment status directly from Razorpay for instant frontend resolution
      rzp_payment = ::Razorpay::Payment.fetch(rzp_payment_id)

      # Process and Create Payment
      payment_session.process! if payment_session.can_process?
      
      payment = payment_session.find_or_create_payment!
      
      if payment.present? && !payment.completed?
        payment.started_processing! if payment.checkout?
        
        # SYNCHRONOUS FIX: Immediately transition payment state so Next.js can complete the order
        if rzp_payment.status == 'captured'
          payment.complete! if payment.can_complete?
        elsif rzp_payment.status == 'authorized'
          payment.pend! if payment.can_pend?
        end
      end

      payment_session.complete! if payment_session.can_complete?
    end

  rescue StandardError => e
    Rails.logger.error("Razorpay 5.4+ API Completion Failed: #{e.message}")
    payment_session.fail! if payment_session.can_fail?
    raise Spree::Core::GatewayError, e.message
  end
end

#configuration_guide_partial_name ⇒ Object 



37
38
39
 
# File 'app/models/spree/gateway/razorpay_gateway.rb', line 37

def configuration_guide_partial_name
  'razorpay'
end

#create_payment_session(order:, amount: nil, external_data: {}) ⇒ Object 



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'app/models/spree/gateway/razorpay_gateway.rb', line 106

def create_payment_session(order:, amount: nil, external_data: {})
  provider
  total = amount || order.total_minus_store_credits
  amount_in_cents = (total.to_f * 100).to_i

  rzp_order = ::Razorpay::Order.create(
    amount: amount_in_cents,
    currency: order.currency || 'INR',
    receipt: order.number,
    payment_capture: auto_capture? ? 1 : 0, # UPDATED: Respects Manual Capture
    notes: { spree_order_number: order.number, email: order.email }
  )

  unless rzp_order && rzp_order.attributes.key?('id')
    raise Spree::Core::GatewayError, 'Failed to create Razorpay session'
  end

  payment_sessions.create!(
    type: 'Spree::PaymentSessions::Razorpay',
    order: order,
    amount: total,
    currency: order.currency || 'INR',
    external_id: rzp_order.id,
    external_data: { client_key: current_key_id },
    customer: order.user,
    status: 'pending'
  )
rescue StandardError => e
  Rails.logger.error("Razorpay Session Creation Failed: #{e.message}")
  raise Spree::Core::GatewayError, e.message
end

#credit(credit_cents, response_code, _gateway_options = {}) ⇒ Object 



318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'app/models/spree/gateway/razorpay_gateway.rb', line 318

def credit(credit_cents, response_code, _gateway_options = {})
  provider
  begin
    rzp_payment_id = resolve_razorpay_payment_id(response_code)
    
    if rzp_payment_id.blank?
      raise StandardError, "Missing Razorpay Payment ID. Cannot process refund."
    end
    
    refund = ::Razorpay::Refund.create(payment_id: rzp_payment_id, amount: credit_cents.to_i)
    
    ActiveMerchant::Billing::Response.new(true, 'Razorpay Refund Successful', { refund_id: refund.id }, test: preferred_test_mode, authorization: refund.id)
  rescue StandardError => e
    Rails.logger.error("Razorpay Refund Failed: #{e.message}")
    ActiveMerchant::Billing::Response.new(false, "Refund failed: #{e.message}", {}, test: preferred_test_mode)
  end
end

#current_key_id ⇒ Object 



49
50
51
 
# File 'app/models/spree/gateway/razorpay_gateway.rb', line 49

def current_key_id
  preferred_test_mode ? preferred_test_key_id : preferred_key_id
end

#current_key_secret ⇒ Object 



53
54
55
 
# File 'app/models/spree/gateway/razorpay_gateway.rb', line 53

def current_key_secret
  preferred_test_mode ? preferred_test_key_secret : preferred_key_secret
end

#description_partial_name ⇒ Object 



33
34
35
 
# File 'app/models/spree/gateway/razorpay_gateway.rb', line 33

def description_partial_name
  'razorpay'
end

#method_type ⇒ Object 



25
26
27
 
# File 'app/models/spree/gateway/razorpay_gateway.rb', line 25

def method_type
  'razorpay'
end

#name ⇒ Object 



21
22
23
 
# File 'app/models/spree/gateway/razorpay_gateway.rb', line 21

def name
  'Razorpay Secure (UPI, Wallets, Cards & Netbanking)'
end

#parse_webhook_event(raw_body, headers) ⇒ Object 



218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'app/models/spree/gateway/razorpay_gateway.rb', line 218

def parse_webhook_event(raw_body, headers)
  provider
  signature = headers['HTTP_X_RAZORPAY_SIGNATURE'] || headers['X-Razorpay-Signature']

  unless ::Razorpay::Utility.verify_webhook_signature(raw_body, signature, preferred_webhook_secret)
    raise Spree::PaymentMethod::WebhookSignatureError
  end

  event = JSON.parse(raw_body)
  payment_entity = event.dig('payload', 'payment', 'entity') || event.dig('payload', 'order', 'entity')
  
  session = Spree::PaymentSession.find_by(external_id: payment_entity['order_id'])
  return nil unless session

  # UPDATED: Split authorized vs captured to align with new Spree webhook architecture
  case event['event']
  when 'payment.captured', 'order.paid'
    { action: :captured, payment_session: session }
  when 'payment.authorized'
    { action: :authorized, payment_session: session }
  when 'payment.failed'
    { action: :failed, payment_session: session }
  else
    nil
  end
rescue ::Razorpay::Errors::SignatureVerificationError
  raise Spree::PaymentMethod::WebhookSignatureError
end

#payment_icon_name ⇒ Object 



29
30
31
 
# File 'app/models/spree/gateway/razorpay_gateway.rb', line 29

def payment_icon_name
  'razorpay'
end

#payment_session_class ⇒ Object 



97
98
99
 
# File 'app/models/spree/gateway/razorpay_gateway.rb', line 97

def payment_session_class
  Spree::PaymentSessions::Razorpay if defined?(Spree::PaymentSession)
end

#payment_source_class ⇒ Object 



93
94
95
 
# File 'app/models/spree/gateway/razorpay_gateway.rb', line 93

def payment_source_class
  Spree::RazorpayCheckout
end

#provider ⇒ Object 



45
46
47
 
# File 'app/models/spree/gateway/razorpay_gateway.rb', line 45

def provider
  ::Razorpay.setup(current_key_id, current_key_secret)
end

#provider_class ⇒ Object 



41
42
43
 
# File 'app/models/spree/gateway/razorpay_gateway.rb', line 41

def provider_class
  self
end

#purchase(_amount, source, _gateway_options = {}) ⇒ Object

LEGACY / ACTIVEMERCHANT FLOW



252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
 
# File 'app/models/spree/gateway/razorpay_gateway.rb', line 252

def purchase(_amount, source, _gateway_options = {})
  provider

  begin
    if source.razorpay_payment_id.blank? || source.razorpay_signature.blank?
       return ActiveMerchant::Billing::Response.new(false, 'Payment was not completed. Please try again.', {}, test: preferred_test_mode)
    end

    ::Razorpay::Utility.verify_payment_signature(
      razorpay_order_id: source.razorpay_order_id,
      razorpay_payment_id: source.razorpay_payment_id,
      razorpay_signature: source.razorpay_signature
    )

    rzp_payment = ::Razorpay::Payment.fetch(source.razorpay_payment_id)
    if rzp_payment.status == 'authorized'
      rzp_payment.capture({ amount: _amount })
    end

    source.update!(status: 'captured')
    
    ActiveMerchant::Billing::Response.new(true, 'Razorpay Payment Successful', {}, test: preferred_test_mode, authorization: source.razorpay_payment_id)
    
  rescue StandardError => e
    Rails.logger.error("Razorpay Verification/Capture Failed: #{e.message}")
    ActiveMerchant::Billing::Response.new(false, 'Payment verification failed.', {}, test: preferred_test_mode)
  end
end

#request_type ⇒ Object 



61
62
63
 
# File 'app/models/spree/gateway/razorpay_gateway.rb', line 61

def request_type
  'DEFAULT'
end

#resolve_razorpay_payment_id(response_code) ⇒ Object 



281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'app/models/spree/gateway/razorpay_gateway.rb', line 281

def resolve_razorpay_payment_id(response_code)
  return nil if response_code.blank?

  if response_code.to_s.start_with?('order_')
    rzp_order = ::Razorpay::Order.fetch(response_code)
    payments = rzp_order.payments
    
    captured_payment = payments.items.find { |p| p.status == 'captured' } || payments.items.first
    
    raise StandardError, "No captured payment found for Razorpay Order #{response_code}" unless captured_payment
    
    captured_payment.id
  else
    response_code
  end
end

#session_required? ⇒ Boolean

Returns:

  • (Boolean) 


81
82
83
 
# File 'app/models/spree/gateway/razorpay_gateway.rb', line 81

def session_required?
  preferred_headless_api_mode
end

#setup_session_supported? ⇒ Boolean

Returns:

  • (Boolean) 


89
90
91
 
# File 'app/models/spree/gateway/razorpay_gateway.rb', line 89

def setup_session_supported?
  false
end

#source_required? ⇒ Boolean

Returns:

  • (Boolean) 


85
86
87
 
# File 'app/models/spree/gateway/razorpay_gateway.rb', line 85

def source_required?
  !preferred_headless_api_mode
end

#supports?(_source) ⇒ Boolean

Returns:

  • (Boolean) 


77
78
79
 
# File 'app/models/spree/gateway/razorpay_gateway.rb', line 77

def supports?(_source)
  true
end

#update_payment_session(payment_session:, amount: nil, external_data: {}) ⇒ Object 



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'app/models/spree/gateway/razorpay_gateway.rb', line 138

def update_payment_session(payment_session:, amount: nil, external_data: {})
  provider
  
  if amount.present? && payment_session.amount != amount
    amount_in_cents = (amount.to_f * 100).to_i
    
    new_rzp_order = ::Razorpay::Order.create(
      amount: amount_in_cents,
      currency: payment_session.currency,
      receipt: payment_session.order.number,
      payment_capture: auto_capture? ? 1 : 0 # UPDATED: Respects Manual Capture
    )
    
    payment_session.update!(amount: amount, external_id: new_rzp_order.id)
  end
  payment_session
end

#void(response_code, _gateway_options = {}) ⇒ Object 



336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
 
# File 'app/models/spree/gateway/razorpay_gateway.rb', line 336

def void(response_code, _gateway_options = {})
  provider
  begin
    rzp_payment_id = resolve_razorpay_payment_id(response_code)

    if rzp_payment_id.blank?
      raise StandardError, "Missing Razorpay Payment ID. Cannot process void."
    end

    refund = ::Razorpay::Refund.create(payment_id: rzp_payment_id)
    
    ActiveMerchant::Billing::Response.new(true, 'Razorpay Void/Refund Successful', { refund_id: refund.id }, test: preferred_test_mode, authorization: refund.id)
  rescue StandardError => e
    Rails.logger.error("Razorpay Void Failed: #{e.message}")
    ActiveMerchant::Billing::Response.new(false, "Void failed: #{e.message}", {}, test: preferred_test_mode)
  end
end