Skip to content

Creates an enabled payment method with typed history and an exactly-once receipt.

POST
/api/workspace/community-memberships/payment-methods
curl --request POST \
--url https://example.com/api/workspace/community-memberships/payment-methods \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "OperationId": "example", "DisplayName": "example", "Description": "example" }'
access_token
string

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

Display values and operation identity; creation requires no reason.

HTTP body for payment-method creation (UC-CM-46); the application checks every field.

object
OperationId

Client-chosen identity of this submission. A retry with the same identity and the same values returns the first result; the same identity with other values is rejected.

string
nullable
DisplayName

Required display name, at most 128 characters and unique in the Workspace.

string
nullable
Description

Optional description, at most 1024 characters; blank means none.

string
nullable
Examplegenerated
{
"OperationId": "example",
"DisplayName": "example",
"Description": "example"
}

OK

Media typeapplication/json
object
Data

HTTP result of a Community Memberships command that creates, changes or deletes one record.

object
Id

Identifier of the created, changed or deleted record.

string
nullable
RowVersion

Version after the command, which a later change sends back to detect concurrent changes; after a deletion, the version the record had when it was deleted.

string format: uuid
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
}
]
}

Bad Request

Media typeapplication/json
object
Data

HTTP result of a Community Memberships command that creates, changes or deletes one record.

object
Id

Identifier of the created, changed or deleted record.

string
nullable
RowVersion

Version after the command, which a later change sends back to detect concurrent changes; after a deletion, the version the record had when it was deleted.

string format: uuid
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

HTTP result of a Community Memberships command that creates, changes or deletes one record.

object
Id

Identifier of the created, changed or deleted record.

string
nullable
RowVersion

Version after the command, which a later change sends back to detect concurrent changes; after a deletion, the version the record had when it was deleted.

string format: uuid
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
}
]
}

Conflict

Media typeapplication/json
object
Data

HTTP result of a Community Memberships command that creates, changes or deletes one record.

object
Id

Identifier of the created, changed or deleted record.

string
nullable
RowVersion

Version after the command, which a later change sends back to detect concurrent changes; after a deletion, the version the record had when it was deleted.

string format: uuid
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
}
]
}