Register a domain for Apple Pay

Registers a domain for Apple Pay.

To use this operation:

  1. Download the Rebilly Apple Pay merchant domain verification file, and host it on your domain at https://{DOMAIN}/.well-known/apple-developer-merchantid-domain-association.
  2. Use this endpoint to register the domain with Apple Pay, or to check if it is already registered. When the domain is registered, you can use Apple Pay with FramePay.
SecuritySecretApiKey or JWT
Request
Request Body schema: application/json

Apple pay domain registration request.

domain
required
string

Domain to register.

Responses
200

Action executed without error.

Response Schema: application/json
domain
required
string

Domain to register.

status
string

Status of Apple Pay domain registration.

Enum: "failed" "registered" "already-registered"
201

Domain registered with Apple Pay.

Response Headers
Location
string <uri>

Location of the related resource.

Example: "https://api.rebilly.com/example"
Response Schema: application/json
domain
required
string

Domain to register.

status
string

Status of Apple Pay domain registration.

Enum: "failed" "registered" "already-registered"
401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

422

Invalid data sent.

post/digital-wallets/onboarding/apple-pay
Request samples
application/json
{
  • "domain": "string"
}
Response samples
application/json
{
  • "domain": "string",
  • "status": "failed"
}