Retrieve the Apple Pay domain association file

​

Retrieves the Apple Pay verification file to host on a storefront before registering its Payment Method Domain. The response is JSON: publish the content string unchanged at path on your domain over public HTTPS, using the returned content_type. Then register the domain with POST /v1/payment_method_domains. Retrieving the file does not register or verify the domain.

Use your API key for the account and test/live mode you are registering. For a connected account, include the Paypercut-Account header.

Include domain_name for the exact storefront hostname. This selects the file for its existing or pending registration, or the account's default for a new domain, and checks for incompatible outstanding verification in the other mode. Omitting domain_name returns the account/mode default without checking a particular hostname.

HTTP 409 with apple_pay_domain_association_conflict means verification requires incompatible or ambiguous files. Complete or reconcile existing verification before retrying. HTTP 503 with apple_pay_domain_association_unavailable means the required file is unavailable; contact support rather than substituting the static file.

See Apple Pay setup for the dynamic-file workflow. The static download remains available during the gradual rollout.

Query Parameters

  • domain_name
    Type: string
    min length:  
    1
    max length:  
    253

    Bare storefront hostname, such as shop.example.com, without a scheme, port, or path. Include it when retrieving the file to publish for a domain. An empty value, repeated parameter, or unsupported query parameter is rejected.

Headers

  • Paypercut-Account
    Type: string

    Optional account ID to act on. Use the same test/live mode as the API key. Omit to use the key's account. X-Paypercut-Account is accepted as a compatibility alias.

Responses

  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
Request Example for get/v1/apple-pay/domain-association
curl 'https://api.paypercut.io/v1/apple-pay/domain-association?domain_name=shop.example.com' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
File for a storefront (illustrative content)
{
  "object": "apple_pay_domain_association",
  "domain_name": "shop.example.com",
  "path": "/.well-known/apple-developer-merchantid-domain-association",
  "content_type": "text/plain",
  "content": "EXAMPLE_ASSOCIATION_FILE_CONTENT\n"
}

Verification-file content and publication details. The API response has Cache-Control: no-store.

Previous
Payment Method Domains
Next
List all Payment Method Domain