• Example searches: “transaction”, “CreateOrder”, “/v2/locations”, “inventory”, “delete customer”

You are viewing an old version of the API
Retrieve merchant

GET /v2/merchants/{merchant_id}

Retrieve a Merchant object for the given merchant_id.


Permissions
MERCHANT_PROFILE_READ
Guide
Merchants API Overview
Try in API Explorer
Name Description
merchant_id
string

Required

The ID of the merchant to retrieve. If the string "me" is supplied as the ID, then retrieve the merchant that is currently accessible to this call.

Response Fields

Name Description
errors
Error [ ]

Information on errors encountered during the request.

merchant
Merchant

The requested Merchant object.

Examples

You are viewing an old version of the API
GET /v2/merchants/{merchant_id}
cURL
  • cURL
  • Ruby
  • Python
  • C#
  • Java
  • PHP
  • Node.js
curl https://connect.squareup.com/v2/merchants/DM7VKY8Q63GNP \
  -H 'Square-Version: 2020-11-18' \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Content-Type: application/json'
Response JSON
{
  "merchant": {
    "id": "DM7VKY8Q63GNP",
    "business_name": "Apple A Day",
    "country": "US",
    "language_code": "en-US",
    "currency": "USD",
    "status": "ACTIVE",
    "main_location_id": "9A65CGC72ZQG1"
  }
}

Share Feedback

Thanks for visiting the Square API documentation. What's on your mind?