Skip to main content
POST
/
api
/
v1
/
escrow
/
{transaction_id}
/
release
curl --request POST \
  --url https://hpay-api.host-sl.com/api/v1/escrow/b1f2c3d4-.../release \
  --header 'api-key: YOUR_API_KEY' \
  --header 'secret-key: YOUR_SECRET_KEY' \
  --header 'Idempotency-Key: order-1234-release' \
  --header 'Content-Type: application/json' \
  --data '{
    "recipient_wallet_id": "7c6d5e4f-...",
    "amount": 200.00
  }'

{
  "id": "c2d3e4f5-...",
  "wallet_id": "9a8b7c6d-...",
  "escrow_wallet_id": "5e4f3a2b-...",
  "recipient_wallet_id": "7c6d5e4f-...",
  "application_wallet_id": "3a2b1c0d-...",
  "amount": 198.0,
  "escrow_amount": 0.0,
  "application_fee": 2.0,
  "transaction_type": "escrow_release",
  "status": "completed",
  "description": "Escrow released",
  "created_at": "2025-01-16T12:00:00Z",
  "updated_at": "2025-01-16T12:00:00Z"
}
Releases funds held by an escrow hold to a recipient wallet. You can release the full held amount or a partial amount. If your application has an escrow fee configured, it is deducted from the released amount and routed to your fee wallet; the recipient receives the net.

​
Path Parameters

​
transaction_id
string
required
The ID of the escrow transaction (returned by the hold endpoint) to release from. Must be in held status.

​
Headers

​
Idempotency-Key
string
Optional but recommended for this money-moving call. Retries with the same key within 24 hours return the original result instead of releasing the funds twice.

​
Request Body

​
recipient_wallet_id
string
required
The unique identifier of the wallet to release the funds to.
​
amount
number
The amount to release. Defaults to the full held amount if omitted. Must be greater than 0 and not exceed the held amount.

​
Response

​
id
string
The unique identifier of the release transaction.
​
recipient_wallet_id
string
The ID of the wallet the funds were released to.
​
amount
number
The net amount credited to the recipient (after any escrow fee).
​
application_fee
number
The escrow fee collected on the release, if any.
​
status
string
The current status of the release transaction (e.g., completed).
​
created_at
string
ISO 8601 timestamp of the release.
{
  "id": "c2d3e4f5-...",
  "wallet_id": "9a8b7c6d-...",
  "escrow_wallet_id": "5e4f3a2b-...",
  "recipient_wallet_id": "7c6d5e4f-...",
  "application_wallet_id": "3a2b1c0d-...",
  "amount": 198.0,
  "escrow_amount": 0.0,
  "application_fee": 2.0,
  "transaction_type": "escrow_release",
  "status": "completed",
  "description": "Escrow released",
  "created_at": "2025-01-16T12:00:00Z",
  "updated_at": "2025-01-16T12:00:00Z"
}

curl --request POST \
  --url https://hpay-api.host-sl.com/api/v1/escrow/b1f2c3d4-.../release \
  --header 'api-key: YOUR_API_KEY' \
  --header 'secret-key: YOUR_SECRET_KEY' \
  --header 'Idempotency-Key: order-1234-release' \
  --header 'Content-Type: application/json' \
  --data '{
    "recipient_wallet_id": "7c6d5e4f-...",
    "amount": 200.00
  }'