Get Payment Defaults

Return effective payment configuration for the workspace (with optional product overrides).

Method

GET /v1/payments/defaults

Query Parameters

product · uuid

Optional product ID. When provided, product-level overrides supersede workspace defaults.

Headers

Authorization · string

Bearer token (workspace API key).

Request Example

cURL

curl "https://api.voyantcloud.com/v1/payments/defaults?product=1f4df0f4-58fa-4f6d-8fb8-8a8a23f8d2c7" \
  -H "Authorization: Bearer $VOYANT_API_KEY"

Response

200 OK

{
  "payments": {
    "methods": {
      "card": { "enabled": true },
      "bank_transfer": { "enabled": true, "dueDays": 5 }
    },
    "provider": {
      "preferred": "netopia",
      "fallback": null
    },
    "checkout": {
      "currency": "EUR",
      "collectBillingAddress": true
    }
  }
}

If no workspace can be resolved (for example, when the API key is missing and no product is provided), the response contains payments: null instead of an error.