ApplePay

(applePay())

Overview

Available Operations

registerMerchantDomains - Add domains to be registered with Apple Pay.

Any domains that will be used to accept payments must first be verified with Apple.

To access this endpoint using an access token you'll need to specify the /accounts/{accountID}/apple-pay.write scope.

updateMerchantDomains - Add or remove domains to be registered with Apple Pay.

Any domains that will be used to accept payments must first be verified with Apple.

To access this endpoint using an access token you'll need to specify the /accounts/{accountID}/apple-pay.write scope.

getMerchantDomains - Get domains registered with Apple Pay.

Read our Apple Pay tutorial to learn more.

To access this endpoint using an access token you'll need to specify the /accounts/{accountID}/apple-pay.read scope.

createSession - Create a session with Apple Pay to facilitate a payment.

Read our Apple Pay tutorial 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 you'll need to specify the /accounts/{accountID}/apple-pay.write scope.

linkToken - Connect an Apple Pay token to the specified account.

Read our Apple Pay tutorial 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 you'll need to specify the /accounts/{accountID}/cards.write scope.

registerMerchantDomains

Add domains to be registered with Apple Pay.

Any domains that will be used to accept payments must first be verified with Apple.

To access this endpoint using an access token you'll need to specify the /accounts/{accountID}/apple-pay.write scope.

Example Usage

package hello.world;

import io.moov.sdk.Moov;
import io.moov.sdk.models.components.RegisterApplePayMerchantDomains;
import io.moov.sdk.models.components.Security;
import io.moov.sdk.models.errors.GenericError;
import io.moov.sdk.models.operations.RegisterApplePayMerchantDomainsResponse;
import java.lang.Exception;
import java.util.List;

public class Application {

    public static void main(String[] args) throws GenericError, Exception {

        Moov sdk = Moov.builder()
                .security(Security.builder()
                    .username("")
                    .password("")
                    .build())
            .build();

        RegisterApplePayMerchantDomainsResponse res = sdk.applePay().registerMerchantDomains()
                .xMoovVersion("v2024.01")
                .accountID("133fed79-519d-4b63-99ec-26b95076a45b")
                .registerApplePayMerchantDomains(RegisterApplePayMerchantDomains.builder()
                    .domains(List.of(
                        "checkout.classbooker.dev"))
                    .build())
                .call();

        if (res.applePayMerchantDomains().isPresent()) {
            // handle response
        }
    }
}

Parameters

Parameter	Type	Required	Description
`xMoovVersion`	Optional<String>	➖	Specify an API version. API versioning follows the format `vYYYY.QQ.BB`, where - `YYYY` is the year - `QQ` is the two-digit month for the first month of the quarter (e.g., 01, 04, 07, 10) - `BB` is an optional build number starting at `.01` for subsequent builds in the same quarter. - If no build number is specified, the version refers to the initial release of the quarter. The `latest` version represents the most recent development state. It may include breaking changes and should be treated as a beta release.
`accountID`	String	✔️	ID of the Moov account representing the merchant.
`registerApplePayMerchantDomains`	RegisterApplePayMerchantDomains	✔️	N/A

Response

RegisterApplePayMerchantDomainsResponse

Errors

Error Type	Status Code	Content Type
models/errors/GenericError	400	application/json
models/errors/APIException	4XX, 5XX	/

updateMerchantDomains

Add or remove domains to be registered with Apple Pay.

Any domains that will be used to accept payments must first be verified with Apple.

To access this endpoint using an access token you'll need to specify the /accounts/{accountID}/apple-pay.write scope.

Example Usage

package hello.world;

import io.moov.sdk.Moov;
import io.moov.sdk.models.components.Security;
import io.moov.sdk.models.components.UpdateApplePayMerchantDomains;
import io.moov.sdk.models.errors.GenericError;
import io.moov.sdk.models.operations.UpdateApplePayMerchantDomainsResponse;
import java.lang.Exception;
import java.util.List;

public class Application {

    public static void main(String[] args) throws GenericError, Exception {

        Moov sdk = Moov.builder()
                .security(Security.builder()
                    .username("")
                    .password("")
                    .build())
            .build();

        UpdateApplePayMerchantDomainsResponse res = sdk.applePay().updateMerchantDomains()
                .xMoovVersion("v2024.01")
                .accountID("b7d68fce-1dbc-4562-93aa-d9ad030c78e6")
                .updateApplePayMerchantDomains(UpdateApplePayMerchantDomains.builder()
                    .addDomains(List.of(
                        "pay.classbooker.dev"))
                    .removeDomains(List.of(
                        "checkout.classbooker.dev"))
                    .build())
                .call();

        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
`xMoovVersion`	Optional<String>	➖	Specify an API version. API versioning follows the format `vYYYY.QQ.BB`, where - `YYYY` is the year - `QQ` is the two-digit month for the first month of the quarter (e.g., 01, 04, 07, 10) - `BB` is an optional build number starting at `.01` for subsequent builds in the same quarter. - If no build number is specified, the version refers to the initial release of the quarter. The `latest` version represents the most recent development state. It may include breaking changes and should be treated as a beta release.
`accountID`	String	✔️	ID of the Moov account representing the merchant.
`updateApplePayMerchantDomains`	UpdateApplePayMerchantDomains	✔️	N/A

Response

UpdateApplePayMerchantDomainsResponse

Errors

Error Type	Status Code	Content Type
models/errors/GenericError	400	application/json
models/errors/APIException	4XX, 5XX	/

getMerchantDomains

Get domains registered with Apple Pay.

Read our Apple Pay tutorial to learn more.

To access this endpoint using an access token you'll need to specify the /accounts/{accountID}/apple-pay.read scope.

Example Usage

package hello.world;

import io.moov.sdk.Moov;
import io.moov.sdk.models.components.Security;
import io.moov.sdk.models.operations.GetApplePayMerchantDomainsResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws Exception {

        Moov sdk = Moov.builder()
                .security(Security.builder()
                    .username("")
                    .password("")
                    .build())
            .build();

        GetApplePayMerchantDomainsResponse res = sdk.applePay().getMerchantDomains()
                .xMoovVersion("v2024.01")
                .accountID("cd0931b0-e02f-47b3-87fc-0789a05479e9")
                .call();

        if (res.applePayMerchantDomains().isPresent()) {
            // handle response
        }
    }
}

Parameters

Parameter	Type	Required	Description
`xMoovVersion`	Optional<String>	➖	Specify an API version. API versioning follows the format `vYYYY.QQ.BB`, where - `YYYY` is the year - `QQ` is the two-digit month for the first month of the quarter (e.g., 01, 04, 07, 10) - `BB` is an optional build number starting at `.01` for subsequent builds in the same quarter. - If no build number is specified, the version refers to the initial release of the quarter. The `latest` version represents the most recent development state. It may include breaking changes and should be treated as a beta release.
`accountID`	String	✔️	ID of the Moov account representing the merchant.

Response

GetApplePayMerchantDomainsResponse

Errors

Error Type	Status Code	Content Type
models/errors/APIException	4XX, 5XX	/

createSession

Create a session with Apple Pay to facilitate a payment.

Read our Apple Pay tutorial 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 you'll need to specify the /accounts/{accountID}/apple-pay.write scope.

Example Usage

package hello.world;

import io.moov.sdk.Moov;
import io.moov.sdk.models.components.CreateApplePaySession;
import io.moov.sdk.models.components.Security;
import io.moov.sdk.models.errors.GenericError;
import io.moov.sdk.models.operations.CreateApplePaySessionResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws GenericError, Exception {

        Moov sdk = Moov.builder()
                .security(Security.builder()
                    .username("")
                    .password("")
                    .build())
            .build();

        CreateApplePaySessionResponse res = sdk.applePay().createSession()
                .xMoovVersion("v2024.01")
                .accountID("1d911f27-36e5-4497-8e9e-c3ecff1a8ae0")
                .createApplePaySession(CreateApplePaySession.builder()
                    .domain("checkout.classbooker.dev")
                    .displayName("Lillie.Abbott74")
                    .build())
                .call();

        if (res.applePaySession().isPresent()) {
            // handle response
        }
    }
}

Parameters

Parameter	Type	Required	Description
`xMoovVersion`	Optional<String>	➖	Specify an API version. API versioning follows the format `vYYYY.QQ.BB`, where - `YYYY` is the year - `QQ` is the two-digit month for the first month of the quarter (e.g., 01, 04, 07, 10) - `BB` is an optional build number starting at `.01` for subsequent builds in the same quarter. - If no build number is specified, the version refers to the initial release of the quarter. The `latest` version represents the most recent development state. It may include breaking changes and should be treated as a beta release.
`accountID`	String	✔️	ID of the Moov account representing the merchant.
`createApplePaySession`	CreateApplePaySession	✔️	N/A

Response

CreateApplePaySessionResponse

Errors

Error Type	Status Code	Content Type
models/errors/GenericError	400, 409, 422	application/json
models/errors/APIException	4XX, 5XX	/

linkToken

Connect an Apple Pay token to the specified account.

Read our Apple Pay tutorial 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 you'll need to specify the /accounts/{accountID}/cards.write scope.

Example Usage

package hello.world;

import io.moov.sdk.Moov;
import io.moov.sdk.models.components.AppleBillingContact;
import io.moov.sdk.models.components.ApplePayHeader;
import io.moov.sdk.models.components.LinkApplePay;
import io.moov.sdk.models.components.LinkApplePayToken;
import io.moov.sdk.models.components.LinkApplePaymentData;
import io.moov.sdk.models.components.LinkApplePaymentMethod;
import io.moov.sdk.models.components.Security;
import io.moov.sdk.models.errors.GenericError;
import io.moov.sdk.models.errors.LinkApplePayError;
import io.moov.sdk.models.operations.LinkApplePayTokenResponse;
import java.lang.Exception;
import java.util.List;

public class Application {

    public static void main(String[] args) throws GenericError, LinkApplePayError, Exception {

        Moov sdk = Moov.builder()
                .security(Security.builder()
                    .username("")
                    .password("")
                    .build())
            .build();

        LinkApplePayTokenResponse res = sdk.applePay().linkToken()
                .xMoovVersion("v2024.01")
                .accountID("f4d3b593-6370-42f3-acf5-eab4393e2a01")
                .linkApplePay(LinkApplePay.builder()
                    .token(LinkApplePayToken.builder()
                        .paymentData(LinkApplePaymentData.builder()
                            .version("EC_v1")
                            .data("3+f4oOTwPa6f1UZ6tG...CE=")
                            .signature("MIAGCSqGSIb3DQ.AAAA==")
                            .header(ApplePayHeader.builder()
                                .publicKeyHash("l0CnXdMv...D1I=")
                                .transactionId("32b...4f3")
                                .ephemeralPublicKey("MFkwEK...Md==")
                                .build())
                            .build())
                        .paymentMethod(LinkApplePaymentMethod.builder()
                            .displayName("Visa 1234")
                            .network("Visa")
                            .type("debit")
                            .build())
                        .transactionIdentifier("32b...4f3")
                        .build())
                    .billingContact(AppleBillingContact.builder()
                        .addressLines(List.of(
                            "123 Sesame Street"))
                        .locality("Phoenix")
                        .postalCode("30345")
                        .administrativeArea("AZ")
                        .countryCode("US")
                        .build())
                    .build())
                .call();

        if (res.linkedApplePayPaymentMethod().isPresent()) {
            // handle response
        }
    }
}

Parameters

Parameter	Type	Required	Description
`xMoovVersion`	Optional<String>	➖	Specify an API version. API versioning follows the format `vYYYY.QQ.BB`, where - `YYYY` is the year - `QQ` is the two-digit month for the first month of the quarter (e.g., 01, 04, 07, 10) - `BB` is an optional build number starting at `.01` for subsequent builds in the same quarter. - If no build number is specified, the version refers to the initial release of the quarter. The `latest` version represents the most recent development state. It may include breaking changes and should be treated as a beta release.
`accountID`	String	✔️	ID of the Moov account representing the cardholder.
`linkApplePay`	LinkApplePay	✔️	N/A

Response

LinkApplePayTokenResponse

Errors

Error Type	Status Code	Content Type
models/errors/GenericError	400, 409	application/json
models/errors/LinkApplePayError	422	application/json
models/errors/APIException	4XX, 5XX	/

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

README.md

README.md

ApplePay

Overview

Available Operations

registerMerchantDomains

Example Usage

Parameters

Response

Errors

updateMerchantDomains

Example Usage

Parameters

Response

Errors

getMerchantDomains

Example Usage

Parameters

Response

Errors

createSession

Example Usage

Parameters

Response

Errors

linkToken

Example Usage

Parameters

Response

Errors

Files

README.md

Latest commit

History

README.md

File metadata and controls

ApplePay

Overview

Available Operations

registerMerchantDomains

Example Usage

Parameters

Response

Errors

updateMerchantDomains

Example Usage

Parameters

Response

Errors

getMerchantDomains

Example Usage

Parameters

Response

Errors

createSession

Example Usage

Parameters

Response

Errors

linkToken

Example Usage

Parameters

Response

Errors