Skip to main content
POST
/
api
/
wallets
/
holds
/
{hold_id}
/
confirm
Confirm a hold
curl --request POST \
  --url http://localhost/api/wallets/holds/{hold_id}/confirm \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": 100,
  "final": true
}
'
{
  "errorCode": "VALIDATION",
  "errorMessage": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.formance.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

Idempotency-Key
string

Use an idempotency key

Path Parameters

hold_id
string
required

Body

application/json
amount
integer<bigint>

Define the amount to transfer.

Example:

100

final
boolean

Define a final confirmation. Remaining funds will be returned to the wallet.

Example:

true

Response

Hold successfully confirmed, funds moved back to initial destination