All URIs are relative to https://connect.squareup.com

Method	HTTP request	Description
listMerchants	GET /v2/merchants	ListMerchants
retrieveMerchant	GET /v2/merchants/{merchant_id}	RetrieveMerchant

listMerchants

\SquareConnect\Model\ListMerchantsResponse listMerchants($cursor)

ListMerchants

Returns Merchant information for a given access token. If you don't know a Merchant ID, you can use this endpoint to retrieve the merchant ID for an access token. You can specify your personal access token to get your own merchant information or specify an OAuth token to get the information for the merchant that granted you access. If you know the merchant ID, you can also use the RetrieveMerchant endpoint to get the merchant information.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
SquareConnect\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new SquareConnect\Api\MerchantsApi();
$cursor = 56; // int | The cursor generated by the previous response.

try {
    $result = $apiInstance->listMerchants($cursor);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MerchantsApi->listMerchants: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
cursor	int	The cursor generated by the previous response.	[optional]

Return type

\SquareConnect\Model\ListMerchantsResponse

Authorization

oauth2

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieveMerchant

\SquareConnect\Model\RetrieveMerchantResponse retrieveMerchant($merchant_id)

RetrieveMerchant

Retrieve a Merchant object for the given merchant_id.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
SquareConnect\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new SquareConnect\Api\MerchantsApi();
$merchant_id = "merchant_id_example"; // string | The ID of the merchant to retrieve.

try {
    $result = $apiInstance->retrieveMerchant($merchant_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MerchantsApi->retrieveMerchant: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
merchant_id	string	The ID of the merchant to retrieve.

Return type

\SquareConnect\Model\RetrieveMerchantResponse

Authorization

oauth2

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]