POST/v1/payment_method_domains/{payment_method_domain}/validate

Validate a payment method domain

Validates an existing payment method domain after you complete the registration steps required for specific payment methods. Use payment_method_domain to identify the domain and optionally provide expand values for additional response fields. Validation activates eligible payment methods that satisfy their registration requirements.

RetriesRetries up to 2×, 500ms backoff, 30s timeout.
IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 1 body field

payment_method_domainstringrequired

The unique identifier of the payment method domain to validate. Maximum 5000 characters.

Optional fields used when validating a payment method domain.

expandarray<string>optional

Specifies which fields in the response should be expanded.

2 status codes

200Returns the validated payment method domain, including its enabled state and the current status of each supported payment method.

amazon_payobjectrequired

Indicates the status of a specific payment method on a payment method domain.

apple_payobjectrequired

Indicates the status of a specific payment method on a payment method domain.

createdintegerrequired

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

domain_namestringrequired

The domain name that this payment method domain object represents.

enabledbooleanrequired

Whether this payment method domain is enabled. If the domain is not enabled, payment methods that require a payment method domain will not appear in Elements.

google_payobjectrequired

Indicates the status of a specific payment method on a payment method domain.

idstringrequired

Unique identifier for the object.

klarnaobjectrequired

Indicates the status of a specific payment method on a payment method domain.

linkobjectrequired

Indicates the status of a specific payment method on a payment method domain.

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:payment_method_domain

paypalobjectrequired

Indicates the status of a specific payment method on a payment method domain.

defaultError response.

errorobjectrequired

Error handling

payment_method_domain must identify the payment method domain to validate and must not exceed 5000 characters. Complete the required payment-method registration steps before validation, and ensure each expand value does not exceed 5000 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.validate.create({
  paymentMethodDomain: "example",
  expand: [],
});

{
  "amazon_pay": {
    "status": "active",
    "status_details": {
      "error_message": "example_value"
    }
  },
  "apple_pay": {
    "status": "active",
    "status_details": {
      "error_message": "example_value"
    }
  },
  "created": 1,
  "domain_name": "Example Name",
  "enabled": true,
  "google_pay": {
    "status": "active",
    "status_details": {
      "error_message": "example_value"
    }
  },
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "klarna": {
    "status": "active",
    "status_details": {
      "error_message": "example_value"
    }
  },
  "link": {
    "status": "active",
    "status_details": {
      "error_message": "example_value"
    }
  },
  "livemode": true,
  "object": "payment_method_domain",
  "paypal": {
    "status": "active",
    "status_details": {
      "error_message": "example_value"
    }
  }
}

Request

Response

Errors