Skip to main content
POST
/
v1
/
balances.finalize
Typescript (SDK)
import { Autumn } from 'autumn-js'

const autumn = new Autumn()

const result = await autumn.balances.finalize({
  lockId: "lock_abc123",
  action: "confirm",
});
{
  "success": true
}

​
Body Parameters

​
Response

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
x-api-version
string
default:2.1
required

Body

application/json
​
lock_id
string
required

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

​
action
enum<string>
required

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

Available options:
confirm,
release
​
override_value
number

Additional properties to attach to this finalize lock event.

​
properties
object

Additional properties to attach to this finalize lock event.

Response

200 - application/json

OK

​
success
boolean
required