com.squareup.square.api

Interface ApplePayApi

All Known Implementing Classes:

DefaultApplePayApi

public interface ApplePayApi

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

Method Detail

registerDomain

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

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

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

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