Object

ApplePayEndpoints

URLs for the endpoints dictionary.

Properties

fallbackUrl
string

A URL that opens in a web browser so the customer can complete the purchase if their device is unable to make payments using Apple Pay.

orderTrackingUrl
string

Called by Business Chat after completing the order; provides you with an opportunity to update the order information in your system. For more information, see Tracking Orders.

paymentGatewayUrl
string
(Required)

Called by Apple Pay to process the payment through the payment provider. The URL should match the URL in the initiativeContext field of the payment session. For more information, see Processing Payment Requests.

paymentMethodUpdateUrl
string

Called by Apple Pay when the customer changes the payment method. If you don’t implement this endpoint and you include this key in the dictionary, the customer sees an error message. For more information, see Updating Payment Methods.

shippingContactUpdateUrl
string

Called by Apple Pay when the customer changes their shipping address information. If you don’t implement this endpoint and you include this key in the dictionary, the customer sees an error message. For more information, see Updating Shipping Contacts.

shippingMethodUpdateUrl
string

Called by Apple Pay when the customer changes the shipping method. If you don’t implement this endpoint and you include this key in the dictionary, the customer sees an error message. For more information, see Updating Shipping Methods.

Discussion

The endpoints dictionary contains a list of URLs that Apple Pay calls during the payment process. Apple Pay requires the paymentGatewayUrl endpoint for use in asking the payment provider to process the payment; all other endpoints are optional.

See Also

Dictionaries

object ApplePayData

Dictionary keys for making an Apple Pay payment request.

object ApplePayContactFieldItem

Field names used for requesting contact information in a payment request.

object ApplePayItem

Keys for Apple Pay dictionary.

object ApplePayLineItem

A set of line items that explain recurring payments and additional charges and discounts.

object ApplePayPaymentRequest

Keys for the paymentRequest dictionary.

object ApplePayShippingMethodItem

The itemized shipping method for delivering physical goods.