com.squareup.square.api

Class DefaultCardsApi

java.lang.Object

com.squareup.square.api.BaseApi

com.squareup.square.api.DefaultCardsApi

All Implemented Interfaces:

CardsApi

public final class DefaultCardsApi
extends BaseApi
implements CardsApi

This class lists all the endpoints of the groups.

Nested Class Summary

Nested classes/interfaces inherited from class com.squareup.square.api.BaseApi

BaseApi.RequestExecutor, BaseApi.RequestSupplier, BaseApi.ResponseHandler<T>

Field Summary

Fields inherited from class com.squareup.square.api.BaseApi

authManagers, config, httpCallback, internalUserAgent

Constructor Summary

Constructors

Constructor and Description
DefaultCardsApi(Configuration config, HttpClient httpClient, Map<String,AuthManager> authManagers) Initializes the controller.
DefaultCardsApi(Configuration config, HttpClient httpClient, Map<String,AuthManager> authManagers, HttpCallback httpCallback) Initializes the controller with HTTPCallback.

Method Summary

Modifier and Type	Method and Description
CreateCardResponse	createCard(CreateCardRequest body) Adds a card on file to an existing merchant.
CompletableFuture<CreateCardResponse>	createCardAsync(CreateCardRequest body) Adds a card on file to an existing merchant.
DisableCardResponse	disableCard(String cardId) Disables the card, preventing any further updates or charges.
CompletableFuture<DisableCardResponse>	disableCardAsync(String cardId) Disables the card, preventing any further updates or charges.
ListCardsResponse	listCards(String cursor, String customerId, Boolean includeDisabled, String referenceId, String sortOrder) Retrieves a list of cards owned by the account making the request.
CompletableFuture<ListCardsResponse>	listCardsAsync(String cursor, String customerId, Boolean includeDisabled, String referenceId, String sortOrder) Retrieves a list of cards owned by the account making the request.
RetrieveCardResponse	retrieveCard(String cardId) Retrieves details for a specific Card.
CompletableFuture<RetrieveCardResponse>	retrieveCardAsync(String cardId) Retrieves details for a specific Card.

Methods inherited from class com.squareup.square.api.BaseApi

getClientInstance, getHttpCallback, makeHttpCallAsync, validateResponse

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultCardsApi

public DefaultCardsApi(Configuration config,
                       HttpClient httpClient,
                       Map<String,AuthManager> authManagers)

Initializes the controller.

Parameters:

config - Configurations added in client.

httpClient - Send HTTP requests and read the responses.

authManagers - Apply authorization to requests.

DefaultCardsApi

public DefaultCardsApi(Configuration config,
                       HttpClient httpClient,
                       Map<String,AuthManager> authManagers,
                       HttpCallback httpCallback)

Initializes the controller with HTTPCallback.

Parameters:

config - Configurations added in client.

httpClient - Send HTTP requests and read the responses.

authManagers - Apply authorization to requests.

httpCallback - Callback to be called before and after the HTTP call.

Method Detail

listCards

public ListCardsResponse listCards(String cursor,
                                   String customerId,
                                   Boolean includeDisabled,
                                   String referenceId,
                                   String sortOrder)
                            throws ApiException,
                                   IOException

Retrieves a list of cards owned by the account making the request. A max of 25 cards will be returned.

Specified by:

listCards in interface CardsApi

Parameters:

cursor - Optional parameter: A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information.

customerId - Optional parameter: Limit results to cards associated with the customer supplied. By default, all cards owned by the merchant are returned.

includeDisabled - Optional parameter: Includes disabled cards. By default, all enabled cards owned by the merchant are returned.

referenceId - Optional parameter: Limit results to cards associated with the reference_id supplied.

sortOrder - Optional parameter: Sorts the returned list by when the card was created with the specified order. This field defaults to ASC.

Returns:

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

listCardsAsync

public CompletableFuture<ListCardsResponse> listCardsAsync(String cursor,
                                                           String customerId,
                                                           Boolean includeDisabled,
                                                           String referenceId,
                                                           String sortOrder)

Retrieves a list of cards owned by the account making the request. A max of 25 cards will be returned.

Specified by:

listCardsAsync in interface CardsApi

Parameters:

cursor - Optional parameter: A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information.

customerId - Optional parameter: Limit results to cards associated with the customer supplied. By default, all cards owned by the merchant are returned.

includeDisabled - Optional parameter: Includes disabled cards. By default, all enabled cards owned by the merchant are returned.

referenceId - Optional parameter: Limit results to cards associated with the reference_id supplied.

sortOrder - Optional parameter: Sorts the returned list by when the card was created with the specified order. This field defaults to ASC.

Returns:

Returns the ListCardsResponse response from the API call

createCard

public CreateCardResponse createCard(CreateCardRequest body)
                              throws ApiException,
                                     IOException

Adds a card on file to an existing merchant.

Specified by:

createCard in interface CardsApi

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 CreateCardResponse 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.

createCardAsync

public CompletableFuture<CreateCardResponse> createCardAsync(CreateCardRequest body)

Adds a card on file to an existing merchant.

Specified by:

createCardAsync in interface CardsApi

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 CreateCardResponse response from the API call

retrieveCard

public RetrieveCardResponse retrieveCard(String cardId)
                                  throws ApiException,
                                         IOException

Retrieves details for a specific Card.

Specified by:

retrieveCard in interface CardsApi

Parameters:

cardId - Required parameter: Unique ID for the desired Card.

Returns:

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

retrieveCardAsync

public CompletableFuture<RetrieveCardResponse> retrieveCardAsync(String cardId)

Retrieves details for a specific Card.

Specified by:

retrieveCardAsync in interface CardsApi

Parameters:

cardId - Required parameter: Unique ID for the desired Card.

Returns:

Returns the RetrieveCardResponse response from the API call

disableCard

public DisableCardResponse disableCard(String cardId)
                                throws ApiException,
                                       IOException

Disables the card, preventing any further updates or charges. Disabling an already disabled card is allowed but has no effect.

Specified by:

disableCard in interface CardsApi

Parameters:

cardId - Required parameter: Unique ID for the desired Card.

Returns:

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

disableCardAsync

public CompletableFuture<DisableCardResponse> disableCardAsync(String cardId)

Disables the card, preventing any further updates or charges. Disabling an already disabled card is allowed but has no effect.

Specified by:

disableCardAsync in interface CardsApi

Parameters:

cardId - Required parameter: Unique ID for the desired Card.

Returns:

Returns the DisableCardResponse response from the API call