com.squareup.square.api

Interface MobileAuthorizationApi

All Known Implementing Classes:

DefaultMobileAuthorizationApi

public interface MobileAuthorizationApi

This interface lists all the endpoints of the group. This can be overridden for the mock calls.

Method Summary

Modifier and Type	Method and Description
CreateMobileAuthorizationCodeResponse	createMobileAuthorizationCode(CreateMobileAuthorizationCodeRequest body) Generates code to authorize a mobile application to connect to a Square card reader.
CompletableFuture<CreateMobileAuthorizationCodeResponse>	createMobileAuthorizationCodeAsync(CreateMobileAuthorizationCodeRequest body) Generates code to authorize a mobile application to connect to a Square card reader.

Method Detail

createMobileAuthorizationCode

CreateMobileAuthorizationCodeResponse createMobileAuthorizationCode(CreateMobileAuthorizationCodeRequest body)
                                                             throws ApiException,
                                                                    IOException

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](https://developer.squareup.com/docs/build-basics/access-tokens).

Parameters:

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the CreateMobileAuthorizationCodeResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

createMobileAuthorizationCodeAsync

CompletableFuture<CreateMobileAuthorizationCodeResponse> createMobileAuthorizationCodeAsync(CreateMobileAuthorizationCodeRequest body)

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](https://developer.squareup.com/docs/build-basics/access-tokens).

Parameters:

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the CreateMobileAuthorizationCodeResponse response from the API call