Escrow

Hold and release an account’s funds before settlement.

Park a virtual account's funds so the settlement worker won't sweep them until you release the hold — useful for marketplaces, deliveries, and disputes.

One active hold per account

Calling hold again while a hold is active returns the existing hold rather than stacking. Release before the next sweep can settle.

Release before you expect settlement

An account can be fully paid but will not settle while held. Remember to release once your condition (e.g. delivery) is met.

post/api/v1/settlements/{accountRef}/hold

Place an escrow hold on an account so it is not settled until released.

Requires Bearer token

Path parameters

accountRefstringrequired

Body parameters

releaseConditionstringoptional

Responses

200OK

POST /api/v1/settlements/{accountRef}/hold

curl -X POST "https://api.xental.online/api/v1/settlements/inv_001/hold" \
  -H "Authorization: Bearer <API_TOKEN>"

post/api/v1/settlements/{accountRef}/release

Release the active escrow hold so the account can settle on the next sweep.

Requires Bearer token

Path parameters

accountRefstringrequired

Responses

204No Content

POST /api/v1/settlements/{accountRef}/release

curl -X POST "https://api.xental.online/api/v1/settlements/inv_001/release" \
  -H "Authorization: Bearer <API_TOKEN>"