mobile-authorization.md

Mobile Authorization

$mobileAuthorizationApi = $client->getMobileAuthorizationApi();

Class Name

MobileAuthorizationApi

Create Mobile Authorization Code

Generates code to authorize a mobile application to connect to a Square card reader.

Authorization codes are one-time-use codes and expire 60 minutes after being issued.

Important: The Authorization header you provide to this endpoint must have the following format:

Authorization: Bearer ACCESS_TOKEN

Replace ACCESS_TOKEN with a valid production authorization credential.

function createMobileAuthorizationCode(CreateMobileAuthorizationCodeRequest $body): ApiResponse

Parameters

Parameter	Type	Tags	Description
body	CreateMobileAuthorizationCodeRequest	Body, Required	An object containing the fields to POST for the request. See the corresponding object definition for field details.

Response Type

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

Example Usage

$body = CreateMobileAuthorizationCodeRequestBuilder::init()
    ->locationId('YOUR_LOCATION_ID')
    ->build();

$apiResponse = $mobileAuthorizationApi->createMobileAuthorizationCode($body);

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

// Getting more response information
var_dump($apiResponse->getStatusCode());
var_dump($apiResponse->getHeaders());