---
title: "Adding Apple Pay to a Merchant"
method: POST
path: "/v4/merchants/{gateway_id}/apple_pay"
tags: ["Apple Pay"]
---

# Adding Apple Pay to a Merchant

`POST /v4/merchants/{gateway_id}/apple_pay`

> ❗️ Never Use Real API Keys
>
> Never use real API Keys when testing. The gateway allows Partners to create Test Merchant Accounts. Testing should always use keys from the Test Accounts and never keys from a Standard Account.


This API allows partners to opt their merchants into Apple Pay and allow Collect.js to generate Apple Pay buttons on specific domains for these merchants.

<details>
<summary>Usage</summary>
<p>&nbsp;</p>

The `gateway_id` in the POST URL refers to the "gateway ID" for the merchant you are updating, so this will change with each new merchant. This is accessible from the Merchant Details page in the partner portal, as well as returned in the Merchant Boarding API when creating a merchant account.

<p>&nbsp;</p>

The `domains` value is expected to be an array of domains the merchant would like to be allowed to use Apple Pay.

<p>&nbsp;</p>

> Please be aware that the domains posted to this endpoint should be the full list of domains allowed for this merchant. For example, if you made the same example request again, but only included abc.com as a domain, then example.com and store.acme.com would be removed.
</details>

## Path parameters

- `gateway_id` string, required

## Headers

- `Content-Type` string, required
- `Authorization` string, required

## Request body

- AddingApplePayToAMerchantRequest
  - `domains` string[], required — Array of domains allowed for this merchant.

## Response `200`

Success

- AddingApplePayToAMerchantResponse
  - `domains` object[] — Array of applePayDomain objects.
    - `objectType` string — The type of object that was returned as a result of the request.
    - `domain` string — The domain for which Apple Pay was added.
    - `created` string — The date and time of when the domain was added.

---

[API](https://skmtc.net/nmi/apis/embedded-components-api.md) · [All operations](https://skmtc.net/nmi/apis/embedded-components-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/nmi/embedded-components-api/revisions/45c2ecda3685/schema)