merchants.md

Merchants

$merchantsApi = $client->getMerchantsApi();

Class Name

MerchantsApi

Methods

• List Merchants
• Retrieve Merchant

List Merchants

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.

function listMerchants(?int $cursor = null): ApiResponse

Parameters

Parameter	Type	Tags	Description
cursor	?int	Query, Optional	The cursor generated by the previous response.

Response Type

This method returns a Square\Utils\ApiResponse instance. The getResult() method on this instance returns the response data which is of type ListMerchantsResponse.

Example Usage

$cursor = 210;

$apiResponse = $merchantsApi->listMerchants($cursor);

if ($apiResponse->isSuccess()) {
    $listMerchantsResponse = $apiResponse->getResult();
} else {
    $errors = $apiResponse->getErrors();
}

// Get more response info...
// $statusCode = $apiResponse->getStatusCode();
// $headers = $apiResponse->getHeaders();

Retrieve Merchant

Retrieve a Merchant object for the given merchant_id.

function retrieveMerchant(string $merchantId): ApiResponse

Parameters

Parameter	Type	Tags	Description
merchantId	string	Template, 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 Type

This method returns a Square\Utils\ApiResponse instance. The getResult() method on this instance returns the response data which is of type RetrieveMerchantResponse.

Example Usage

$merchantId = 'merchant_id0';

$apiResponse = $merchantsApi->retrieveMerchant($merchantId);

if ($apiResponse->isSuccess()) {
    $retrieveMerchantResponse = $apiResponse->getResult();
} else {
    $errors = $apiResponse->getErrors();
}

// Get more response info...
// $statusCode = $apiResponse->getStatusCode();
// $headers = $apiResponse->getHeaders();