Merchants API

Merchants API Overview

Backend

Use the Merchants API to retrieve information about a Square merchant account.

For example, suppose you develop an application (an eCommerce or a SaaS platform) integrated with Square to process payments. Other Square sellers sign up to use your application.

Note

Both application developer and seller are separate Square accounts. The application developer cannot perform any actions, such as take payments, on behalf of other accounts without permissions. The sellers must grant the application developer permissions through OAuth. For more information, see OAuth API-What It Does.

In this scenario, the application developer can use the Merchants API to retrieve seller account information, such as language, business name, country, and account status as shown in the following RetrieveMerchant request. In the request, the Authorization header provides an OAuth access token that identifies the seller whose account information is requested.

curl -X GET                                 \
-H 'Accept: application/json'                \
-H 'Authorization: Bearer {{ACCESS-TOKEN}}' \
-H 'Cache-Control: no-cache'                 \
-H 'Content-Type: application/json'          \
-d '{}' \
'https://connect.squareup.com/v2/merchants/{{MERCHANT-ID}}'

The following is an example response:

{
    "merchant": [
        {
            "id": "6AH6E4EXAMPLE",
            "business_name": "My New Business Name",
            "country": "US",
            "language_code": "en-US",
            "currency": "USD",
            "status": "ACTIVE"
        }
    ]
}