List Payment Accounts

Retrieve configured payment accounts for the current workspace (optionally filtered by provider).

Method

GET /v1/payments/accounts

Query Parameters

provider · string

Filter by provider slug (e.g. netopia).

product · uuid

If the workspace context is missing, derive it from a product ID.

Headers

Authorization · string

Bearer token (requires payments:read).

Request Example

cURL

curl "https://api.voyantcloud.com/v1/payments/accounts?provider=netopia" \
  -H "Authorization: Bearer $VOYANT_API_KEY"

Response

200 OK

{
  "data": [
    {
      "id": "payacct_123",
      "workspaceId": "ws_abc",
      "provider": "netopia",
      "displayName": "Voyant Netopia Live",
      "liveMode": true,
      "status": "active",
      "configEncrypted": { "enc": "gcpkms:AAAA..." },
      "createdAt": "2025-01-10T09:12:45.000Z",
      "updatedAt": "2025-01-12T18:03:02.000Z"
    }
  ]
}

If no workspace is associated with the API key, provide a product query parameter so the API can derive the workspace from the product’s owner.