com.squareup.square.api

Interface CardsApi

All Known Implementing Classes:

DefaultCardsApi

public interface CardsApi

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

Method Detail

listCards

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.

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

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.

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

CreateCardResponse createCard(CreateCardRequest body)
                       throws ApiException,
                              IOException

Adds a card on file to an existing merchant.

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

CompletableFuture<CreateCardResponse> createCardAsync(CreateCardRequest body)

Adds a card on file to an existing merchant.

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

RetrieveCardResponse retrieveCard(String cardId)
                           throws ApiException,
                                  IOException

Retrieves details for a specific Card.

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

CompletableFuture<RetrieveCardResponse> retrieveCardAsync(String cardId)

Retrieves details for a specific Card.

Parameters:

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

Returns:

Returns the RetrieveCardResponse response from the API call

disableCard

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.

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

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.

Parameters:

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

Returns:

Returns the DisableCardResponse response from the API call