Add an Apple Pay domain

post/merchants/{merchantId}/paymentMethodSettings/{paymentMethodId}/addApplePayDomains

Adds the new domain to the list of Apple Pay domains that are registered with the merchant account and the payment method identified in the path. For more information, see Apple Pay documentation.

To make this request, your API credential must have the following role:

  • Management API—Payment methods read and write
Endpoint destination URL
https://management-test.adyen.com/v3/merchants/{merchantId}/paymentMethodSettings/{paymentMethodId}/addApplePayDomains
Click to copy

Path Parameters

paymentMethodIdstringRequired

The unique identifier of the payment method.

merchantIdstringRequired

The unique identifier of the merchant account.

Request Parameters

domainsarray[string]Required

The list of merchant domains. Maximum: 99 domains per request.

For more information, see Apple Pay documentation.

Response parameters

After submitting a call, you receive a response message to inform you that your request was received and processed.

Depending on the HTTP status code of the response message, it is helpful to build some logic to handle any errors that a request or the system may return.

HTTP Responses

  • 204 - No Content

    Look at the actual response code for the status of the request.

  • 400 - Bad Request

    A problem reading or understanding the request.

    Show moreShow less
  • 401 - Unauthorized

    Authentication required.

    Show moreShow less
  • 403 - Forbidden

    Insufficient permissions to process the request.

    Show moreShow less
  • 422 - Unprocessable Entity

    A request validation error.

    Show moreShow less
  • 429

    Show moreShow less
  • 500 - Internal Server Error

    The server could not process the request.

    Show moreShow less