32 lines
993 B
Plaintext
32 lines
993 B
Plaintext
---
|
|
title: "Finalize Lock"
|
|
openapi: "openapi POST /v1/balances.finalize"
|
|
---
|
|
|
|
import { DynamicParamField } from "/snippets/dynamic-param-field.jsx";
|
|
import { DynamicResponseField } from "/snippets/dynamic-response-field.jsx";
|
|
import { DynamicResponseExample } from "/snippets/dynamic-response-example.jsx";
|
|
|
|
### Body Parameters
|
|
|
|
<DynamicParamField body="lock_id" type="string" required>
|
|
The lock ID that was passed into the previous check call.
|
|
</DynamicParamField>
|
|
|
|
<DynamicParamField body="action" type="'confirm' | 'release'" required>
|
|
Use 'confirm' to commit the deduction, or 'release' to return the held balance.
|
|
</DynamicParamField>
|
|
|
|
<DynamicParamField body="override_value" type="number">
|
|
Additional properties to attach to this finalize lock event.
|
|
</DynamicParamField>
|
|
|
|
<DynamicParamField body="properties" type="object">
|
|
Additional properties to attach to this finalize lock event.
|
|
</DynamicParamField>
|
|
|
|
|
|
### Response
|
|
|
|
<DynamicResponseField name="success" type="boolean" />
|