Square .NET SDK Quickstart

Learn how to quickly set up and test the Square .NET SDK.

Before you begin, you need a Square account and account credentials. You use the Square Sandbox for the Quickstart exercise.

1. Create a Square account and an application. For more information, see Create an Account and Application.
2. Get a Sandbox access token from the Developer Console. For more information, see Get a personal access token.
3. Install .NET if you don't already have it on your computer.

You can now use one of the following workflows depending on whether you're using Visual Studio.

1. Open a new terminal window.

2. Find or create a new folder for your .NET project.

3. In that folder, run the following command to create a new .NET project:

   dotnet new console --name Quickstart

4. Add an application settings file to the project to store credentials. Go to the newly created Quickstart folder and add the following appsettings.json file, replacing YOUR-SANDBOX-ACCESS-TOKEN with your Sandbox access token:

   {
     "AppSettings": {
    "AccessToken": "YOUR-SANDBOX-ACCESS-TOKEN"
   
     }
   }

5. Run the following commands to install the necessary packages:

   dotnet add package Square
   dotnet add package Microsoft.Extensions.Configuration.Json
   dotnet add package Microsoft.Extensions.Configuration

   The Microsoft.Extensions.Configuration and package Microsoft.Extensions.Configuration.Json packages are used to manage the application settings file.

1. In your Quickstart folder, find and open Program.cs in your preferred editor.

2. Replace the contents with the following code and save the file:

   using Square;
   using Square.Locations;
   
   using Microsoft.Extensions.Configuration;
   
   namespace ExploreLocationsAPI
   {
       public class Program
       {
           private static SquareClient client = null!;
           private static IConfigurationRoot config = null!;
   
           static async Task Main(string[] args)
           {
               var builder = new ConfigurationBuilder()
                .AddJsonFile($"appsettings.json", true, true);
   
               config = builder.Build();
               var accessToken = config["AppSettings:AccessToken"];
   
               client = new SquareClient(
                   accessToken,
                   new ClientOptions
                   {
                       BaseUrl = SquareEnvironment.Sandbox
                   }
               );
   
               await RetrieveLocationsAsync();
           }
   
           static async Task RetrieveLocationsAsync()
           {
               try
               {
                   var response = await client.Locations.ListAsync();
                   if (response.Locations != null)
                   {
                       foreach (var location in response.Locations)
                       {
                           Console.WriteLine($"location: country = {location.Country} name = {location.Name}");
                       }
                   }
                   else
                   {
                       Console.WriteLine("No locations found.");
                   }
               }
               catch (SquareApiException e)
               {
                   Console.WriteLine("SquareApiException occurred:");
                   Console.WriteLine("Status Code: {0}", e.StatusCode);
                   Console.WriteLine("Error: {0}", e.Message);
               }
               catch (Exception e)
               {
                   Console.WriteLine($"Exception occurred: {e.Message}");
               }
           }
       }
   }

   This code does the following:

   • Reads your Square Sandbox access token from the appsettings.json file.
   • Creates a new client using the access token.
   • Calls the ListAsync method on the Locations API to retrieve the locations for your Square account.
   • If the request is successful, the code prints the location information in the terminal.

Run the following command:

dotnet run

You should see at least one location listed (Square creates one Sandbox location when you create a Square account).