Sign in

v1

latestOpenAPI 3.1.02026-07-265817860.8 KB
balances

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

post/v1/balances.finalize

Headers

x-api-versionstring required

Request body

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.

Example request

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

Response

OK

successboolean required