com.squareup.square.api

Class DefaultApplePayApi

java.lang.Object

com.squareup.square.api.BaseApi

com.squareup.square.api.DefaultApplePayApi

All Implemented Interfaces:

ApplePayApi

public final class DefaultApplePayApi
extends BaseApi
implements ApplePayApi

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
DefaultApplePayApi(Configuration config, HttpClient httpClient, Map<String,AuthManager> authManagers) Initializes the controller.
DefaultApplePayApi(Configuration config, HttpClient httpClient, Map<String,AuthManager> authManagers, HttpCallback httpCallback) Initializes the controller with HTTPCallback.

Method Summary

Modifier and Type	Method and Description
RegisterDomainResponse	registerDomain(RegisterDomainRequest body) Activates a domain for use with Apple Pay on the Web and Square.
CompletableFuture<RegisterDomainResponse>	registerDomainAsync(RegisterDomainRequest body) Activates a domain for use with Apple Pay on the Web and Square.

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

DefaultApplePayApi

public DefaultApplePayApi(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.

DefaultApplePayApi

public DefaultApplePayApi(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

registerDomain

public RegisterDomainResponse registerDomain(RegisterDomainRequest body)
                                      throws ApiException,
                                             IOException

Activates a domain for use with Apple Pay on the Web and Square. A validation is performed on this domain by Apple to ensure that it is properly set up as an Apple Pay enabled domain. This endpoint provides an easy way for platform developers to bulk activate Apple Pay on the Web with Square for merchants using their platform. To learn more about Web Apple Pay, see [Add the Apple Pay on the Web Button](https://developer.squareup.com/docs/payment-form/add-digital-wallets/apple-pay).

Specified by:

registerDomain in interface ApplePayApi

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

registerDomainAsync

public CompletableFuture<RegisterDomainResponse> registerDomainAsync(RegisterDomainRequest body)

Activates a domain for use with Apple Pay on the Web and Square. A validation is performed on this domain by Apple to ensure that it is properly set up as an Apple Pay enabled domain. This endpoint provides an easy way for platform developers to bulk activate Apple Pay on the Web with Square for merchants using their platform. To learn more about Web Apple Pay, see [Add the Apple Pay on the Web Button](https://developer.squareup.com/docs/payment-form/add-digital-wallets/apple-pay).

Specified by:

registerDomainAsync in interface ApplePayApi

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