Gets a list of registered domains for the provided Entity with Apple Pay

GET 
/entities/{entity-id}/domains

Gets a list of registered domains for the provided Entity with Apple Pay

Request

Path Parameters

entity-id uuidrequired

NCP Processing Entity ID

Responses

200

OK

application/json

Schema

Schema

partnerMerchantName Partner Merchant Name (string)

Possible values: <= 1024 characters

domainNames Domain Name (string)[]

Possible values: >= 1, <= 99

merchantUrl Domain Name (string)

Possible values: <= 2000 characters

result

object

required

status stringrequired

Possible values: <= 50 characters, [error, success]

errors

object

code stringrequired

Possible values: <= 11 characters

Example: 7000.1000

reason string

Possible values: <= 400 characters

Example: Internal Processing Error

Example (from schema)

{
  "partnerMerchantName": "string",
  "domainNames": [
    "string"
  ],
  "merchantUrl": "string",
  "result": {
    "status": "error",
    "errors": {
      "code": "7000.1000",
      "reason": "Internal Processing Error"
    }
  }
}

Example

{
  "partnerMerchantName": "ACME Anvils & Explosives",
  "domainNames": [
    "acme.com"
  ],
  "result": {
    "status": "success"
  }
}

400

Bad request

application/json

Schema

Schema

partnerMerchantName Partner Merchant Name (string)

Possible values: <= 1024 characters

domainNames Domain Name (string)[]

Possible values: >= 1, <= 99

merchantUrl Domain Name (string)

Possible values: <= 2000 characters

result

object

required

status stringrequired

Possible values: <= 50 characters, [error, success]

errors

object

code stringrequired

Possible values: <= 11 characters

Example: 7000.1000

reason string

Possible values: <= 400 characters

Example: Internal Processing Error

Example (from schema)

{
  "partnerMerchantName": "string",
  "domainNames": [
    "string"
  ],
  "merchantUrl": "string",
  "result": {
    "status": "error",
    "errors": {
      "code": "7000.1000",
      "reason": "Internal Processing Error"
    }
  }
}

401

Unauthorized

application/json

Schema

Schema

partnerMerchantName Partner Merchant Name (string)

Possible values: <= 1024 characters

domainNames Domain Name (string)[]

Possible values: >= 1, <= 99

merchantUrl Domain Name (string)

Possible values: <= 2000 characters

result

object

required

status stringrequired

Possible values: <= 50 characters, [error, success]

errors

object

code stringrequired

Possible values: <= 11 characters

Example: 7000.1000

reason string

Possible values: <= 400 characters

Example: Internal Processing Error

Example (from schema)

{
  "partnerMerchantName": "string",
  "domainNames": [
    "string"
  ],
  "merchantUrl": "string",
  "result": {
    "status": "error",
    "errors": {
      "code": "7000.1000",
      "reason": "Internal Processing Error"
    }
  }
}

403

Forbidden

application/json

Schema

Schema

partnerMerchantName Partner Merchant Name (string)

Possible values: <= 1024 characters

domainNames Domain Name (string)[]

Possible values: >= 1, <= 99

merchantUrl Domain Name (string)

Possible values: <= 2000 characters

result

object

required

status stringrequired

Possible values: <= 50 characters, [error, success]

errors

object

code stringrequired

Possible values: <= 11 characters

Example: 7000.1000

reason string

Possible values: <= 400 characters

Example: Internal Processing Error

Example (from schema)

{
  "partnerMerchantName": "string",
  "domainNames": [
    "string"
  ],
  "merchantUrl": "string",
  "result": {
    "status": "error",
    "errors": {
      "code": "7000.1000",
      "reason": "Internal Processing Error"
    }
  }
}

404

Not Found

application/json

Schema

Schema

partnerMerchantName Partner Merchant Name (string)

Possible values: <= 1024 characters

domainNames Domain Name (string)[]

Possible values: >= 1, <= 99

merchantUrl Domain Name (string)

Possible values: <= 2000 characters

result

object

required

status stringrequired

Possible values: <= 50 characters, [error, success]

errors

object

code stringrequired

Possible values: <= 11 characters

Example: 7000.1000

reason string

Possible values: <= 400 characters

Example: Internal Processing Error

Example (from schema)

{
  "partnerMerchantName": "string",
  "domainNames": [
    "string"
  ],
  "merchantUrl": "string",
  "result": {
    "status": "error",
    "errors": {
      "code": "7000.1000",
      "reason": "Internal Processing Error"
    }
  }
}

500

Internal Server Error

application/json

Schema

Schema

partnerMerchantName Partner Merchant Name (string)

Possible values: <= 1024 characters

domainNames Domain Name (string)[]

Possible values: >= 1, <= 99

merchantUrl Domain Name (string)

Possible values: <= 2000 characters

result

object

required

status stringrequired

Possible values: <= 50 characters, [error, success]

errors

object

code stringrequired

Possible values: <= 11 characters

Example: 7000.1000

reason string

Possible values: <= 400 characters

Example: Internal Processing Error

Example (from schema)

{
  "partnerMerchantName": "string",
  "domainNames": [
    "string"
  ],
  "merchantUrl": "string",
  "result": {
    "status": "error",
    "errors": {
      "code": "7000.1000",
      "reason": "Internal Processing Error"
    }
  }
}

Example

{
  "resilt": {
    "status": "error",
    "errors": {
      "code": "7000.1000",
      "reason": "Internal system error"
    }
  }
}

Loading...