Accept payments with Apple Pay

Through the Apple Pay service, buyers can make payments using the credit or debit cards stored in their Apple Pay accounts. When using the Native API method, the merchant frontend needs to directly integrate the Apple Pay SDK. After obtaining the card asset information, call Antom’s pay (One-time Payments) API to initiate the payment. For details on integrating the Apple Pay SDK, refer to Apple Pay on the Web or Apple Pay (Native).
Note: When integrating Apple Pay using the Native API method, you need to have your own Apple merchant identifier and certificate. For the Apple Pay Web integration method, merchants must complete domain verification on Apple’s side.

User experience

The following figures demonstrate the user experience of paying with Apple Pay:
Web
Mobile

Integration preparations

Before you start integrating, read the Integration Guide and API Overview documents to understand the integration steps of the server-side API and the precautions for calling the API. Furthermore, ensure that the following prerequisites are met:
  • Obtain a client ID
  • Complete the key configuration
  • Complete the configuration of paymentNotifyUrl to receive the asynchronous notification
  • Integrate the server-side SDK package, install the server-side library, and initialize a request instance. For more details, refer to Server-side SDKs.

Integration Steps

Follow these steps to start the integration:
  1. Decrypt ApplePayPaymentToken
  2. Initiate an authorized payment
  3. Obtain the authorization result
  4. Capture

Step 1: Decrypt ApplePayPaymentToken

When the buyer completes Apple Pay payment authorization using Touch ID, Face ID, or a passcode, the frontend obtains ApplePayPaymentToken in the Apple Pay authorization event. For details, refer to
onpaymentauthorized (Web)
or
paymentAuthorizationViewController:didAuthorizePayment:handler: (Native)
. After you obtain ApplePayPaymentToken, you can choose one of the following methods to decrypt the token and call the pay (One-time Payments) API to initiate an authorized payment request.
  • Hosted decryption: Antom manages certificates and performs decryption on your behalf, so you do not need to be PCI-qualified.
  • Merchant decryption: You manage your own certificates and perform decryption operations yourself, and this mode requires that you are PCI-qualified.
Note: For more information about PCI DSS compliance requirements, see PCI DSS standard.

Step 2: Initiate an authorized payment
Server-side

The parameters required for initiating an authorized payment differ depending on the decryption method used. Refer to the corresponding instructions based on the decryption method you adopt.
Hosted decryption
Merchant decryption

Step 3: Obtain the authorization result
Server-side

After the buyer completes payment or the payment times out, you can obtain the payment result either by receiving asynchronous notifications from Antom or by proactively querying the result. For detailed steps, refer to Step 3: Obtain the authorization result.

Step 4: Capture
Server-side

After successful authorization, Antom will automatically initiate capture for you, or you can choose to initiate capture manually. After capture, you can obtain the capture result either via asynchronous notification or active query. You should decide whether to ship goods based on the capture result. For specific steps, refer to Capture.

After payments

After completing the payment, you can perform the following actions:

Cancellation ​
Server-side

For successful payments, if the buyer requests cancellation or a refund on the same day, you can use Antom’s cancellation capability to cancel the order or release funds. Orders not yet completed can also be cancelled directly. For details, refer to Cancel.

Refund
Server-side

To learn about Antom refund rules and how to initiate a refund for a successful transaction, see Refund for more information.

Dispute
Server-side

Antom provides dispute resolution services for contested transactions. For more information, refer to Dispute Guidance and Dispute resolution.

Reconciliation
Server-side

After the transaction is completed, use the financial reports provided by Antom for reconciliation. For more information on how to reconcile and the settlement rules of Antom, refer to Reconciliation.

Additional content

Card payment features

Card payment features also apply to Apple Pay. The following table outlines the support status of these features for Apple Pay: