Skip to content

Lists payment methods, optionally enabled only; remains readable while the module is disabled.

GET
/api/workspace/community-memberships/payment-methods
curl --request GET \
--url 'https://example.com/api/workspace/community-memberships/payment-methods?enabledOnly=false' \
--header 'Authorization: Bearer <token>'
enabledOnly
boolean

Exclude disabled methods when true; false by default.

access_token
string

Optional access token for clients that cannot set Authorization headers. Prefer Authorization: Bearer <token> when possible.

OK

Media typeapplication/json
object
Data
object
Data
Array<object>
nullable

Public payment-method read model (UC-CM-49); contains no financial relationships.

object
Id

Stable payment-method identifier.

string
nullable
DisplayName

Operator-facing name.

string
nullable
Description

Optional operator guidance.

string
nullable
IsEnabled

Whether the method is available for new external movements.

boolean
RowVersion

Stored version for later compare-and-replace commands.

string format: uuid
Permissions

Community Memberships permissions the caller holds in the scope of a response: the Workspace for a list, one community for that community. The client offers an action only when its permission is granted; the server still checks every command.

object
Granted

Granted manifest permission keys, for example community.create, in manifest order.

Array<string>
nullable
Errors
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Warnings
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Success
boolean
Example
{
"Errors": [
{
"Type": 0,
"Severity": 0
}
],
"Warnings": [
{
"Type": 0,
"Severity": 0
}
]
}

Forbidden

Media typeapplication/json
object
Data
object
Data
Array<object>
nullable

Public payment-method read model (UC-CM-49); contains no financial relationships.

object
Id

Stable payment-method identifier.

string
nullable
DisplayName

Operator-facing name.

string
nullable
Description

Optional operator guidance.

string
nullable
IsEnabled

Whether the method is available for new external movements.

boolean
RowVersion

Stored version for later compare-and-replace commands.

string format: uuid
Permissions

Community Memberships permissions the caller holds in the scope of a response: the Workspace for a list, one community for that community. The client offers an action only when its permission is granted; the server still checks every command.

object
Granted

Granted manifest permission keys, for example community.create, in manifest order.

Array<string>
nullable
Errors
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Warnings
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Success
boolean
Example
{
"Errors": [
{
"Type": 0,
"Severity": 0
}
],
"Warnings": [
{
"Type": 0,
"Severity": 0
}
]
}