Get Payment Means

get/v1/payment-means/{payment_means_id}

Fetches a single payment instrument by its public id within the active workspace. Read only, no side effects. Returns 404 when unknown or out of scope.

Requires a bearer token: Authorization: Bearer <token>.

Path parameters

NameTypeRequiredDescription
payment_means_idstring <uuid>YesPublic UUID of the payment means.e.g. 44444444-0000-4000-8000-0000000000e1

Query parameters

NameTypeRequiredDescription
workspaceIdstring <uuid>NoExplicit workspace scope. The authenticated user must hold an active membership in this workspace. Defaults to the session workspace when omitted.e.g. a1b2c3d4-0000-4000-8000-000000000001

Request

cURL
curl -X GET https://api.wellapp.ai/v1/payment-means/{payment_means_id} \
  -H "Authorization: Bearer $WELL_API_TOKEN"

Responses

200The requested payment means.

{
  "data": {
    "type": "payment_means",
    "id": "44444444-0000-4000-8000-0000000000e1",
    "attributes": {
      "name": "Mercury Checking ****4471",
      "payment_means_external_id": "pm_mercury_4471",
      "created_at": "2026-01-12T18:02:00Z",
      "updated_at": "2026-04-27T09:15:00Z",
      "deleted_at": null
    },
    "relationships": {
      "account": {
        "data": {
          "type": "Account",
          "id": "00000000-0000-4000-8000-000000000001"
        }
      },
      "card": {
        "data": {
          "type": "Card",
          "id": "00000000-0000-4000-8000-000000000001"
        }
      },
      "check": {
        "data": {
          "type": "Check",
          "id": "00000000-0000-4000-8000-000000000001"
        }
      },
      "company": {
        "data": {
          "type": "Company",
          "id": "00000000-0000-4000-8000-000000000001"
        }
      },
      "people": {
        "data": {
          "type": "People",
          "id": "00000000-0000-4000-8000-000000000001"
        }
      },
      "sourceWorkspaceConnector": {
        "data": {
          "type": "WorkspaceConnector",
          "id": "00000000-0000-4000-8000-000000000001"
        }
      }
    }
  }
}

401Unauthorized

{
  "code": "UNAUTHORIZED",
  "status": 401,
  "title": "Unauthorized",
  "message": "See title.",
  "meta": {
    "trace_id": "a1b2c3",
    "log_id": "a1b2c3"
  }
}

404Not found

{
  "code": "NOT_FOUND",
  "status": 404,
  "title": "Not Found",
  "message": "See title.",
  "meta": {
    "trace_id": "a1b2c3",
    "log_id": "a1b2c3"
  }
}