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.

Field Summary

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

AUTHENTICATION_KEY, GLOBAL_ERROR_CASES

Constructor Summary

Constructors

Constructor and Description
DefaultApplePayApi(io.apimatic.core.GlobalConfiguration globalConfig) Initializes the controller.

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, getGlobalConfiguration, getHttpCallback

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultApplePayApi

public DefaultApplePayApi(io.apimatic.core.GlobalConfiguration globalConfig)

Initializes the controller.

Parameters:

globalConfig - Configurations added in client.

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. Note: The SqPaymentForm library is deprecated as of May 13, 2021, and will only receive critical security updates until it is retired on October 31, 2022. You must migrate your payment form code to the Web Payments SDK to continue using your domain for Apple Pay. For more information on migrating to the Web Payments SDK, see [Migrate to the Web Payments SDK](https://developer.squareup.com/docs/web-payments/migrate). To learn more about the Web Payments SDK and how to add Apple Pay, see [Take an Apple Pay Payment](https://developer.squareup.com/docs/web-payments/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. Note: The SqPaymentForm library is deprecated as of May 13, 2021, and will only receive critical security updates until it is retired on October 31, 2022. You must migrate your payment form code to the Web Payments SDK to continue using your domain for Apple Pay. For more information on migrating to the Web Payments SDK, see [Migrate to the Web Payments SDK](https://developer.squareup.com/docs/web-payments/migrate). To learn more about the Web Payments SDK and how to add Apple Pay, see [Take an Apple Pay Payment](https://developer.squareup.com/docs/web-payments/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