You are viewing an old version of the API
Retrieve merchant

Retrieve a Merchant object for the given merchant_id

Required permissions MERCHANT_PROFILE_READ

Path Parameters

Name Description
merchant_id
string

Required

The ID of the merchant to retrieve.

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
curl https://connect.squareup.com/v2/merchants/{merchant_id} \
  -H 'Square-Version: 2019-11-20' \
  -H 'Authorization: Bearer ACCESS_TOKEN'
Response JSON
{
  "merchant": {
    "id": "DM7VKY8Q63GNP",
    "business_name": "Apple A Day",
    "country": "US",
    "language_code": "en-US",
    "currency": "USD",
    "status": "ACTIVE"
  }
}

Share Feedback

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