Square Payment Gateway Integration

Square is a comprehensive payment platform that simplifies accepting payments online, in-person, and via mobile apps. Operating in countries like the USA, Canada, UK, Australia, Japan, Ireland, France, and Spain, Square supports major credit/debit cards (Visa, MasterCard, AmEx, Discover), digital wallets (Apple Pay, Google Pay, Cash App), and ACH payments (US-only). Unlike traditional gateways, Square acts as an end-to-end processor, eliminating the need for a separate merchant account. With features like customizable checkouts, recurring payments, and PCI compliance built-in, Square is ideal for businesses seeking a unified solution across channels.

This guide walks you through integrating Square into your application, from account setup to live deployment.

Step 1: Log in or Sign Up

  1. Visit Square: Go to Square and click Sign Up to create a merchant account or Log In if you have one.
  2. Account Creation: Provide your email, password, and business details (e.g., name, country, industry). No separate merchant account is needed—Square handles this.
  3. Email Verification: Check your inbox for a verification email from Square and click the link to activate your account.
  4. Dashboard Access: Log in to the Square Dashboard at squareup.com/dashboard. You’ll automatically get Sandbox access for testing.

Step 2: Set Up Your Account

Before processing payments, configure your Square account:

  1. Complete Your Profile:
  1. Business Verification (Required for Live Mode):
  1. Add a Bank Account:
  1. Sandbox Mode: Use the Sandbox at developer.squareup.com with test credentials to simulate payments without verification.

Step 3: Obtain API Credentials

Square provides credentials for integration:

How to Get Your Credentials:
  1. Log in to the Square Developer Portal at developer.squareup.com.
  2. Go to Applications and click Create Application.
  3. Name your app (e.g., "MyStoreApp") and save:
  1. Key Security: Keep the Access Token confidential—use it server-side only. Store all credentials securely.
  2. Add these to your application’s Admin Panel under System Settings > Payment Gateways > Square.

Step 4: Configure Payment Methods

Square supports various payment methods, enabled by default or via settings:

  1. Go to Account & Settings > Payments in the Dashboard.
  2. Available methods include:
  1. Contact support@squareup.com to enable additional methods (e.g., Afterpay) or multi-currency support.
  2. These methods will appear in your checkout flow once integrated.

Step 5: Set Up Webhooks

Webhooks notify your server of payment events (e.g., payment success):

  1. In the Developer Portal, go to Webhooks.
  2. Click Add Endpoint.
  3. Webhook URL:
  1. Events: Subscribe to events like:
  1. Save the webhook. Square signs notifications with your Access Token for verification.
  2. Testing: Use the Sandbox to send test webhooks and confirm receipt.

Step 6: Set Up Credentials in Our Dashboard

Integrate Square into your application:

  1. Log in to your application’s Admin Panel.
  2. Navigate to System Settings > Payment Gateways > Square.
Square API Keys
  1. Fill out the configuration form:
Square API Keys
  1. Detailed Fields:
  1. Click Submit to save. Your Square gateway is now configured.

Step 7: Test the Integration

Test your setup in Sandbox Mode:

  1. Enable Sandbox Mode:
  1. Simulate Payments:
  1. Verify Webhooks:
  1. Debugging: If issues occur, check the Sandbox Dashboard’s Payments tab for error codes (e.g., “Card Declined”).

Step 8: Enable Live Mode

After successful testing:

  1. Square Dashboard:
  1. Admin Panel:
  1. Webhook Confirmation: Verify the webhook URL is set in the live Developer Portal.

Step 9: Go Live

Launch your Square integration:

  1. Start Accepting Payments:
  1. Live Verification:
  1. Troubleshooting:

Additional Tips

Note:

If you need further assistance, our support team is available 24/7. Reach out at softivus@gmail.com or through the Admin Panel. Let’s get your Square payments up and running smoothly!