v1

latestOpenAPI 3.0.32026-07-2488203535.0 KB
Apple Pay

Adding Apple Pay to a Merchant

❗️ 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>
post/v4/merchants/{gateway_id}/apple_pay

Path parameters

gateway_idstring required

The merchant ID that the request should operate on.

Headers

Content-Typestring required

The Content-Type representation header is used to indicate the original media type of the resource (prior to any content encoding applied for sending).

Authorizationstring required

Your v4 API key that was generated in the Partner portal.

Request body

domainsstring[] required

Array of domains allowed for this merchant.

Response

Success