WePay logo
      Nothing Found

Register account for Apple Pay

post/accounts/{id}/method_of_payments/apple_pay/register

The POST /accounts/{id}/method_of_payments/apple_pay/register is used to register accounts to Apple Pay.

SecurityappIdAuth and appTokenAuth
Request
path Parameters
id
required
string [ 1 .. 255 ] characters

ID of the merchant account, generated by WePay when the account is created.

header Parameters
Api-Version
required
string
Example: 3.0
Content-Type
required
stringapplication/json
Example: application/json
Unique-Key
string
WePay-Risk-Token
string

This header is required when tokenizing Payment Methods, Legal Entities, and Payout Methods when the tokenization JS library is not being used.

Client-IP
string

This header is required when tokenizing Payment Methods, Legal Entities, and Payout Methods when the tokenization JS library is not being used.

Request Body schema: application/json
domain_names
required
Array of strings [ 1 .. 99 ] items

A list of fully qualified domain names for Apple Pay merchant registration.

partner_merchant_name
required
string <= 1024 characters

A human-readable name for the merchant to register with Apple.

merchant_url
string

An optional field in which you provide the website’s top-level domain.

Responses
200
Response Schema: application/json
domain_names
required
Array of strings

A list of fully qualified domain names for Apple Pay merchant registration.

partner_merchant_name
required
string <= 1024 characters

A human-readable name for the merchant to register with Apple.

api_version
string
id
string or null [ 1 .. 255 ] characters

A reference number your platform assigns to an Item.

merchant_url
string

An optional field in which you provide the website’s top-level domain.

object

Details the owner resource and owner path.

path
string

The HTTP path of the resource. The path can be used to retrieve details about the resource and perform actions on it.

resource
string

Helps organize information by identifying the resource type of the object data.

Value: Description
method_of_payments

Payment methods registration

400

INVALID_PARAMS

403

NOT_AUTHORIZED

500

UNEXPECTED_ERROR

Request samples
application/json
{
  • "domain_names": [
    • "checkoutA.merchant1.myplatform.com",
    • "checkoutB.merchant1.myplatform.com"
    ],
  • "merchant_url": "merchant1.myplatform.com",
  • "partner_merchant_name": "Merchant 1"
}
Response samples
application/json
{
  • "domain_names": [
    • "checkoutA.merchant1.myplatform.com",
    • "checkoutB.merchant1.myplatform.com"
    ],
  • "merchant_url": "merchant1.myplatform.com",
  • "partner_merchant_name": "Merchant 1",
  • "id": null,
  • "owner": {
    • "id": "9647b114-55ca-4c58-8072-d424d879ac06",
    • "path": "/accounts/9647b114-55ca-4c58-8072-d424d879ac06",
    • "resource": "accounts"
    },
  • "path": "/accounts/9647b114-55ca-4c58-8072-d424d879ac06/method_of_payments/apple_pay",
  • "resource": "method_of_payments",
  • "api_version": "3.1"
}