Skip to content
Postman API Testing Tips

How To Use Postman With Square

API Testing Blog

Exploring Square APIs with Postman: A Comprehensive Guide

Postman is a powerful tool for API testing, streamlining the process of sending requests, analyzing responses, and ensuring the functionality of your integrations. Square, a popular payment processing platform, offers a robust API that allows you to programmatically interact with your Square account. This guide will walk you through using Postman to effectively test and interact with Square APIs.

1. Setting up Postman and Square API Credentials

Obtaining Your Square API Credentials

  1. Sign up for a Square Account: If you don’t have one already, sign up for a free Square account.
  2. Access Developer Dashboard: Navigate to the Square Developer Dashboard (https://developer.squareup.com/).
  3. Create a New Application: Click “Create Application” and provide a descriptive name for your application.
  4. Generate API Keys: You’ll need an Application ID and an Application Secret. These keys are crucial for authenticating your requests.

Installing and Configuring Postman

  1. Download Postman: Get the latest version of Postman for your operating system (https://www.postman.com/downloads/).

  2. Create a Workspace: A workspace helps organize your requests and collections.

  3. Add a New Environment: Click the “Environment” button and add a new environment called “Square”. Set the following variables:

    • SQUARE_APPLICATION_ID: Your Application ID.
    • SQUARE_APPLICATION_SECRET: Your Application Secret.

Important Note: Keep your API keys secure! Do not hardcode them directly into your requests. Instead, use environment variables, as demonstrated in the steps above.

2. Making Your First Square API Request

Let’s start with a simple request to retrieve information about your Square location.

Request:

  1. Create a New Request: In Postman, create a new request.

  2. Select Method: Set the HTTP method to GET.

  3. Enter the Endpoint: Paste the following endpoint into the request URL field:

    https://connect.squareup.com/v2/locations

  4. Add Authorization: Click on the “Authorization” tab and select “Bearer Token”.

  5. Generate a Token:

    • Create a new Postman request with the following details:
      • Method: POST
      • URL: https://connect.squareup.com/oauth2/token
      • Headers: Content-Type: application-json
      • Body (JSON): 
        {
           "grant_type": "client_credentials",
           "client_id": "{{SQUARE_APPLICATION_ID}}",
           "client_secret": "{{SQUARE_APPLICATION_SECRET}}"
        }
    • Send the request. This will generate an access token.
    • Copy the access token: You’ll need this to authenticate future requests.

  6. Set the Token: Paste the generated access token into the “Token” field in the Postman Authorization tab.

Response:

When you send the request, you’ll receive a JSON response. The response should contain information about your Square location(s), including the location ID, name, and address.

3. Testing Square API Endpoints

Square provides a comprehensive API to manage various aspects of your business. Here are some commonly used endpoints, along with how to test them using Postman:

Creating Customers:

  • Method: POST
  • Endpoint: https://connect.squareup.com/v2/customers
  • Body (JSON): 
    {
      "given_name": "John",
      "family_name": "Doe",
      "email_address": "john.doe@example.com",
      "phone_number": "555-123-4567"
    }

Retrieving Customer Details:

  • Method: GET
  • Endpoint: https://connect.squareup.com/v2/customers/{customer_id}
    • Replace {customer_id} with the actual customer ID.

Processing Payments:

  • Method: POST

  • Endpoint: https://connect.squareup.com/v2/payments

  • Body (JSON):

    {
      "amount_money": {
         "amount": 1000,  // In cents
         "currency": "USD"
      },
      "idempotency_key": "unique-key",
      "source_id": "card-nonce",  // Obtained from your frontend
      "location_id": "your-location-id"
    }

    Note: This example uses a “card-nonce” for payment processing. To securely handle credit card information, implement Square’s client-side encryption with their JavaScript SDK.

Retrieving Payment Details:

  • Method: GET
  • Endpoint: https://connect.squareup.com/v2/payments/{payment_id}
    • Replace {payment_id} with the actual payment ID.

4. Debugging and Troubleshooting

  • Check API Documentation: The official Square API documentation is your first point of reference (https://developer.squareup.com/reference).
  • Use the “Console” Tab: Postman’s console provides insightful information, including error messages, request headers, and response bodies.
  • Examine Response Codes: Carefully analyze response codes:
    • 200-level codes: Success.
    • 400-level codes: Client error (e.g., invalid input).
    • 500-level codes: Server error.

5. Automating Tests with Collections

For comprehensive testing, create Postman collections to group related requests.

  1. Create a Collection: Click the ”+” button and select “Create Collection”.
  2. Add Requests: Drag and drop your existing requests into the collection.
  3. Run Tests: Postman allows you to add pre-request scripts and tests to each request.
  4. Environment Variables: Use environment variables within your collection to manage sensitive data.
  5. Run the Collection: Click “Run” to execute all requests in the collection in sequence.

6. Best Practices for Effective Testing

  • Test API Authentication: Thoroughly test access token generation and request authentication.
  • Validate Responses: Ensure that responses conform to the expected schema and data types.
  • Test Error Handling: Send intentionally invalid requests to verify how the API responds to errors.
  • Document Your Tests: Add clear and detailed documentation for each test within your collection.

Conclusion

By leveraging Postman with Square APIs, you gain a powerful toolkit for testing and implementing integrations. By following these steps and best practices, you can confidently build robust and reliable integrations with Square, enhancing your application’s functionality and user experience.

API Testing Blog