Skip to content

Latest commit

 

History

History
63 lines (45 loc) · 2.05 KB

apple-pay.md

File metadata and controls

63 lines (45 loc) · 2.05 KB

Apple Pay

const applePayApi = client.applePayApi;

Class Name

ApplePayApi

Register Domain

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.

Note: The SqPaymentForm library is deprecated as of May 13, 2021, and will only receive critical security updates until it is retired on October 31, 2022. You must migrate your payment form code to the Web Payments SDK to continue using your domain for Apple Pay. For more information on migrating to the Web Payments SDK, see Migrate to the Web Payments SDK.

To learn more about the Web Payments SDK and how to add Apple Pay, see Take an Apple Pay Payment.

async registerDomain(
  body: RegisterDomainRequest,
  requestOptions?: RequestOptions
): Promise<ApiResponse<RegisterDomainResponse>>

Parameters

Parameter Type Tags Description
body RegisterDomainRequest Body, Required An object containing the fields to POST for the request.

See the corresponding object definition for field details.
requestOptions RequestOptions | undefined Optional Pass additional request options.

Response Type

RegisterDomainResponse

Example Usage

const contentType = null;
const body: RegisterDomainRequest = {
  domainName: 'example.com',
};

try {
  const { result, ...httpResponse } = await applePayApi.registerDomain(body);
  // Get more response info...
  // const { statusCode, headers } = httpResponse;
} catch(error) {
  if (error instanceof ApiError) {
    const errors = error.result;
    // const { statusCode, headers } = error;
  }
}