com.squareup.square.api

Interface MerchantsApi

All Known Implementing Classes:

DefaultMerchantsApi

public interface MerchantsApi

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
ListMerchantsResponse	listMerchants(Integer cursor) Provides details about the merchant associated with a given access token.
CompletableFuture<ListMerchantsResponse>	listMerchantsAsync(Integer cursor) Provides details about the merchant associated with a given access token.
RetrieveMerchantResponse	retrieveMerchant(String merchantId) Retrieves the `Merchant` object for the given `merchant_id`.
CompletableFuture<RetrieveMerchantResponse>	retrieveMerchantAsync(String merchantId) Retrieves the `Merchant` object for the given `merchant_id`.

Method Detail

listMerchants

ListMerchantsResponse listMerchants(Integer cursor)
                             throws ApiException,
                                    IOException

Provides details about the merchant associated with a given access token. The access token used to connect your application to a Square seller is associated with a single merchant. That means that `ListMerchants` returns a list with a single `Merchant` object. 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 your application access. If you know the merchant ID, you can also use the [RetrieveMerchant]($e/Merchants/RetrieveMerchant) endpoint to retrieve the merchant information.

Parameters:

cursor - Optional parameter: The cursor generated by the previous response.

Returns:

Returns the ListMerchantsResponse 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.

listMerchantsAsync

CompletableFuture<ListMerchantsResponse> listMerchantsAsync(Integer cursor)

Provides details about the merchant associated with a given access token. The access token used to connect your application to a Square seller is associated with a single merchant. That means that `ListMerchants` returns a list with a single `Merchant` object. 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 your application access. If you know the merchant ID, you can also use the [RetrieveMerchant]($e/Merchants/RetrieveMerchant) endpoint to retrieve the merchant information.

Parameters:

cursor - Optional parameter: The cursor generated by the previous response.

Returns:

Returns the ListMerchantsResponse response from the API call

retrieveMerchant

RetrieveMerchantResponse retrieveMerchant(String merchantId)
                                   throws ApiException,
                                          IOException

Retrieves the `Merchant` object for the given `merchant_id`.

Parameters:

merchantId - Required parameter: 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.

Returns:

Returns the RetrieveMerchantResponse 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.

retrieveMerchantAsync

CompletableFuture<RetrieveMerchantResponse> retrieveMerchantAsync(String merchantId)

Retrieves the `Merchant` object for the given `merchant_id`.

Parameters:

merchantId - Required parameter: 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.

Returns:

Returns the RetrieveMerchantResponse response from the API call