Retrieve an Apple Pay domain | Sample

2 parameters

domainstringrequired

The unique identifier of the Apple Pay domain to retrieve. Maximum 5,000 characters.

expandarray<string>optional

Fields to expand in the response.

2 status codes

200Returns the Apple Pay domain object with its identifier, domain name, creation time, live-mode status, and object type `apple_pay_domain`.

createdintegerrequired

Time at which the object was created. Measured in seconds since the Unix epoch.

domain_namestringrequired

idstringrequired

Unique identifier for the object.

livemodebooleanrequired

If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.

objectstringrequired

String representing the object's type. Objects of the same type share the same value.

Allowed:apple_pay_domain

defaultError response.

errorobjectrequired

Error handling

domain must be no longer than 5,000 characters and must identify an existing Apple Pay domain. Values in expand must be field names no longer than 5,000 characters.

import { Client } from "acme-sdk";

const client = new Client({
  baseUrl: "https://api.acme.com",
  auth: { bearer: process.env.API_TOKEN },
  retry: {
    maxAttempts: 3,
    retryOn: [
      408,
      425,
      429,
      500,
      502,
      503,
      504,
    ],
    backoffMs: 500,
    maxBackoffMs: 8000,
  },
  timeoutMs: 30000,
});

const result = await client.domains.get({
  domain: "example",
  expand: "example",
});

{
  "created": 1,
  "domain_name": "Example Name",
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "livemode": true,
  "object": "apple_pay_domain"
}

Request

Response

Errors