Package io.moov.sdk

Class ApplePay

java.lang.Object

io.moov.sdk.ApplePay

public class ApplePay
extends java.lang.Object

Method Summary

Modifier and Type	Method	Description
CreateApplePaySessionRequestBuilder	createSession()	Create a session with Apple Pay to facilitate a payment.
CreateApplePaySessionResponse	createSession(java.lang.String accountID, CreateApplePaySession createApplePaySession)	Create a session with Apple Pay to facilitate a payment.
GetApplePayMerchantDomainsRequestBuilder	getMerchantDomains()	Get domains registered with Apple Pay.
GetApplePayMerchantDomainsResponse	getMerchantDomains(java.lang.String accountID)	Get domains registered with Apple Pay.
LinkApplePayTokenRequestBuilder	linkToken()	Connect an Apple Pay token to the specified account.
LinkApplePayTokenResponse	linkToken(java.lang.String accountID, LinkApplePay linkApplePay)	Connect an Apple Pay token to the specified account.
RegisterApplePayMerchantDomainsRequestBuilder	registerMerchantDomains()	Add domains to be registered with Apple Pay.
RegisterApplePayMerchantDomainsResponse	registerMerchantDomains(java.lang.String accountID, RegisterApplePayMerchantDomains registerApplePayMerchantDomains)	Add domains to be registered with Apple Pay.
UpdateApplePayMerchantDomainsRequestBuilder	updateMerchantDomains()	Add or remove domains to be registered with Apple Pay.
UpdateApplePayMerchantDomainsResponse	updateMerchantDomains(java.lang.String accountID, UpdateApplePayMerchantDomains updateApplePayMerchantDomains)	Add or remove domains to be registered with Apple Pay.

Methods inherited from class java.lang.Object

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

Method Detail

registerMerchantDomains

public RegisterApplePayMerchantDomainsRequestBuilder registerMerchantDomains()

Add domains to be registered with Apple Pay.

Any domains that will be used to accept payments must first be [verified](https://docs.moov.io/guides/sources/cards/apple-pay/#register-your-domains) with Apple.

To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/apple-pay.write` scope.

Returns:

The call builder

registerMerchantDomains

public RegisterApplePayMerchantDomainsResponse registerMerchantDomains(java.lang.String accountID,
                                                                       RegisterApplePayMerchantDomains registerApplePayMerchantDomains)
                                                                throws java.lang.Exception

Add domains to be registered with Apple Pay.

Any domains that will be used to accept payments must first be [verified](https://docs.moov.io/guides/sources/cards/apple-pay/#register-your-domains) with Apple.

To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/apple-pay.write` scope.

Parameters:

accountID - ID of the Moov account representing the merchant.

registerApplePayMerchantDomains -

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

updateMerchantDomains

public UpdateApplePayMerchantDomainsRequestBuilder updateMerchantDomains()

Add or remove domains to be registered with Apple Pay.

Any domains that will be used to accept payments must first be [verified](https://docs.moov.io/guides/sources/cards/apple-pay/#register-your-domains) with Apple.

To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/apple-pay.write` scope.

Returns:

The call builder

updateMerchantDomains

public UpdateApplePayMerchantDomainsResponse updateMerchantDomains(java.lang.String accountID,
                                                                   UpdateApplePayMerchantDomains updateApplePayMerchantDomains)
                                                            throws java.lang.Exception

Add or remove domains to be registered with Apple Pay.

Any domains that will be used to accept payments must first be [verified](https://docs.moov.io/guides/sources/cards/apple-pay/#register-your-domains) with Apple.

To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/apple-pay.write` scope.

Parameters:

accountID - ID of the Moov account representing the merchant.

updateApplePayMerchantDomains -

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

getMerchantDomains

public GetApplePayMerchantDomainsRequestBuilder getMerchantDomains()

Get domains registered with Apple Pay.

Read our [Apple Pay tutorial](https://docs.moov.io/guides/sources/cards/apple-pay/#register-your-domains) to learn more.

To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/apple-pay.read` scope.

Returns:

The call builder

getMerchantDomains

public GetApplePayMerchantDomainsResponse getMerchantDomains(java.lang.String accountID)
                                                      throws java.lang.Exception

Get domains registered with Apple Pay.

Read our [Apple Pay tutorial](https://docs.moov.io/guides/sources/cards/apple-pay/#register-your-domains) to learn more.

To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/apple-pay.read` scope.

Parameters:

accountID - ID of the Moov account representing the merchant.

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

createSession

public CreateApplePaySessionRequestBuilder createSession()

Create a session with Apple Pay to facilitate a payment.

Read our [Apple Pay tutorial](https://docs.moov.io/guides/sources/cards/apple-pay/#register-your-domains) to learn more. A successful response from this endpoint should be passed through to Apple Pay unchanged.

To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/apple-pay.write` scope.

Returns:

The call builder

createSession

public CreateApplePaySessionResponse createSession(java.lang.String accountID,
                                                   CreateApplePaySession createApplePaySession)
                                            throws java.lang.Exception

Create a session with Apple Pay to facilitate a payment.

Read our [Apple Pay tutorial](https://docs.moov.io/guides/sources/cards/apple-pay/#register-your-domains) to learn more. A successful response from this endpoint should be passed through to Apple Pay unchanged.

To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/apple-pay.write` scope.

Parameters:

accountID - ID of the Moov account representing the merchant.

createApplePaySession -

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

linkToken

public LinkApplePayTokenRequestBuilder linkToken()

Connect an Apple Pay token to the specified account.

Read our [Apple Pay tutorial](https://docs.moov.io/guides/sources/cards/apple-pay/#register-your-domains) to learn more. The `token` data is defined by Apple Pay and should be passed through from Apple Pay's response unmodified.

To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/cards.write` scope.

Returns:

The call builder

linkToken

public LinkApplePayTokenResponse linkToken(java.lang.String accountID,
                                           LinkApplePay linkApplePay)
                                    throws java.lang.Exception

Connect an Apple Pay token to the specified account.

Read our [Apple Pay tutorial](https://docs.moov.io/guides/sources/cards/apple-pay/#register-your-domains) to learn more. The `token` data is defined by Apple Pay and should be passed through from Apple Pay's response unmodified.

To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/cards.write` scope.

Parameters:

accountID - ID of the Moov account representing the cardholder.

linkApplePay - The JSON structure returned from Apple Pay when authorizing a payment session. Refer to [Apple's documentation](https://developer.apple.com/documentation/apple_pay_on_the_web/applepaypayment) for more information.

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails