Lock Payment Group
The API is utilized to lock a group and block any additional payments from being included.
PATCH
/payments/groups/{id}/lock
Body parameters Request
Name | Location | Type | Description | Required |
---|---|---|---|---|
id | url path | string | Group ID | Yes |
Body Parameters Response
Name | Title | Type | Description |
---|---|---|---|
description | description | string | Extended description of group |
id | id | string | Unique id of group |
locked |
| boolean | When locked, no new actions can be made |
name | name | string | Visual name of group |
type |
| string | entity type (group) |
user_tags |
| object | A set of K/v pairs of tags set for the group |
wallet | id | string | The id of the owning wallet this group is associated with |
Request Example
Response Examples
Last updated