Skip to main content
POST
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

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

Headers

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

string
required
The unique identifier of the wallet to release the funds to.
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

string
The unique identifier of the release transaction.
string
The ID of the wallet the funds were released to.
number
The net amount credited to the recipient (after any escrow fee).
number
The escrow fee collected on the release, if any.
string
The current status of the release transaction (e.g., completed).
string
ISO 8601 timestamp of the release.