|

|  How to Process Payments with Square API in Ruby

How to Process Payments with Square API in Ruby

October 31, 2024

Learn how to process payments using Square API in Ruby with our step-by-step guide. Streamline transactions effectively and enhance your app's payment system.

How to Process Payments with Square API in Ruby

 

Install Required Gems

 

  • Add the Square SDK gem to your `Gemfile`:
gem 'square'
  • Run `bundle install` to install the gem.

 

Set Up Authentication

 

  • Retrieve your Access Token from your Square Developer Account.
  •  

  • Configure the Square client with your access token. It’s best practice to store such sensitive information in environment variables:
require 'square'

Square.configure do |config|
  config.access_token = ENV['SQUARE_ACCESS_TOKEN']
end

 

Create a Payment

 

  • To process a payment, you’ll need to build a `CreatePaymentRequest` object with necessary details. This includes the source ID, amount, and location ID. The source ID is typically generated by a Square payment form or sourced from a saved card on file.
client = Square::Client.new

request_body = {
  :source_id => 'cnon:card-nonce-ok',
  :idempotency_key => SecureRandom.uuid,
  :amount_money => {
    :amount => 100, # example amount in cents
    :currency => 'USD'
  },
  :location_id => 'LOCATION_ID'
}

response = client.payments.create_payment(request_body)
if response.success?
  puts "Payment successful: #{response.data[:payment]}"
else
  puts "Error processing payment: #{response.errors}"
end

 

Handle Errors and Responses

 

  • Always check the response for errors and log them appropriately. Square API might return error messages that give insight into what went wrong during the payment processing.
  •  

  • Inspect both `response.success?` and `response.errors` to manage payment success and failure cases:
if response.success?
  puts "Payment was successful."
else
  response.errors.each do |error|
    puts "Error: #{error[:category]} - #{error[:code]}: #{error[:detail]}"
  end
end

 

Store Payment Details

 

  • After a successful payment, you might want to store transaction details in your database for records and future reference.
if response.success?
  payment = response.data[:payment]
  
  # Example: saving to a hash or ORM database model
  payment_details = {
    id: payment[:id],
    amount: payment[:amount_money][:amount],
    status: payment[:status],
    created_at: payment[:created_at]
  }
  
  # Save payment_details to your preferred data store or log it appropriately
end

 

Implement Webhooks for Asynchronous Responses

 

  • Square can send asynchronous notifications about payment status changes. Set up webhooks in your developer dashboard, and implement a public endpoint to handle these notifications in your Ruby app.
  •  

  • Process the payment event data to update your system state accordingly:
post '/webhooks/square' do
  request.body.rewind
  payload = JSON.parse(request.body.read)
  
  if payload["type"] == "payment.updated"
    payment_id = payload["data"]["object"]["payment"]["id"]
    puts "Payment updated: #{payment_id}"
    # Update your local database records as needed
  end
  
  status 200 # Respond with 200 to acknowledge receipt
end

 

Security Best Practices

 

  • Always verify the origin of webhook events received using the `Square-Signature` header to ensure they are genuinely from Square.
  •  

  • Avoid hardcoding sensitive information such as API keys and tokens; use secure environment variables instead.

 

Pre-order Friend AI Necklace

Pre-Order Friend Dev Kit

Open-source AI wearable
Build using the power of recall

Order Now

OMI AI PLATFORM
Remember Every Moment,
Talk to AI and Get Feedback

Omi Necklace

The #1 Open Source AI necklace: Experiment with how you capture and manage conversations.

Build and test with your own Omi Dev Kit 2.

Omi App

Fully Open-Source AI wearable app: build and use reminders, meeting summaries, task suggestions and more. All in one simple app.

Github →

Join the #1 open-source AI wearable community

Build faster and better with 3900+ community members on Omi Discord

Participate in hackathons to expand the Omi platform and win prizes

Participate in hackathons to expand the Omi platform and win prizes

Get cash bounties, free Omi devices and priority access by taking part in community activities

Join our Discord → 

OMI NECKLACE + OMI APP
First & only open-source AI wearable platform

a person looks into the phone with an app for AI Necklace, looking at notes Friend AI Wearable recorded a person looks into the phone with an app for AI Necklace, looking at notes Friend AI Wearable recorded
a person looks into the phone with an app for AI Necklace, looking at notes Friend AI Wearable recorded a person looks into the phone with an app for AI Necklace, looking at notes Friend AI Wearable recorded
online meeting with AI Wearable, showcasing how it works and helps online meeting with AI Wearable, showcasing how it works and helps
online meeting with AI Wearable, showcasing how it works and helps online meeting with AI Wearable, showcasing how it works and helps
App for Friend AI Necklace, showing notes and topics AI Necklace recorded App for Friend AI Necklace, showing notes and topics AI Necklace recorded
App for Friend AI Necklace, showing notes and topics AI Necklace recorded App for Friend AI Necklace, showing notes and topics AI Necklace recorded

OMI NECKLACE: DEV KIT
Order your Omi Dev Kit 2 now and create your use cases

Omi Dev Kit 2

Endless customization

OMI DEV KIT 2

$69.99

Make your life more fun with your AI wearable clone. It gives you thoughts, personalized feedback and becomes your second brain to discuss your thoughts and feelings. Available on iOS and Android.

Your Omi will seamlessly sync with your existing omi persona, giving you a full clone of yourself – with limitless potential for use cases:

  • Real-time conversation transcription and processing;
  • Develop your own use cases for fun and productivity;
  • Hundreds of community apps to make use of your Omi Persona and conversations.

Learn more

Omi Dev Kit 2: build at a new level

Key Specs

OMI DEV KIT

OMI DEV KIT 2

Microphone

Yes

Yes

Battery

4 days (250mAH)

2 days (250mAH)

On-board memory (works without phone)

No

Yes

Speaker

No

Yes

Programmable button

No

Yes

Estimated Delivery 

-

1 week

What people say

“Helping with MEMORY,

COMMUNICATION

with business/life partner,

capturing IDEAS, and solving for

a hearing CHALLENGE."

Nathan Sudds

“I wish I had this device

last summer

to RECORD

A CONVERSATION."

Chris Y.

“Fixed my ADHD and

helped me stay

organized."

David Nigh

OMI NECKLACE: DEV KIT
Take your brain to the next level

LATEST NEWS
Follow and be first in the know

Latest news
FOLLOW AND BE FIRST IN THE KNOW

thought to action

team@basedhardware.com

company

careers

invest

privacy

products

omi

omi dev kit

personas

resources

apps

affiliate

docs

github

help