balances

POST /v1/balances.finalize

Finalize a previously locked balance. Use 'confirm' to commit the deduction, or 'release' to return the held balance.

Request

Base URL
https://api.useautumn.com
Auth
HTTP bearer
TypeScript
https://skmtc.dev/useautumn/apis/autumn-api/docs/v1/balances.finalize/post.ts
A function with typed inputs. Its response is checked against the schema.

x-api-versionstring required

lock_idstring required

The lock ID that was passed into the previous check call.

action'confirm' | 'release' required

Use 'confirm' to commit the deduction, or 'release' to return the held balance.

override_valuenumber

Additional properties to attach to this finalize lock event.

propertiesobject

Additional properties to attach to this finalize lock event.

{
  "lock_id": "lock_abc123",
  "action": "confirm"
}

successboolean required

No recorded changes to this operation across all 1 revision of this API.