Skip to main content
POST
Returns unsigned approve calldata letting the custody contract pull the settlement asset from a buyer’s wallet at settlement. Buyers need this; sellers do not. The cash leg moves by transferFrom against an allowance, while the security leg moves by a forced transfer the custody contract is already authorized to make. Without an allowance a buy order’s tradable balance reads as zero, because the venue reports the lesser of balance and allowance. The transaction is signed by the buyer, targets the settlement asset, and is not specific to one order. Approve once for the size you intend to trade rather than per order.

Path Parameters

string
required
Order book whose settlement asset and custody contract the approval is for. Must be ACTIVE and reachable from your instance.

Body Parameters

string
required
Allowance to set, in the settlement asset’s base units, as a digit-only string. This replaces any existing allowance rather than adding to it.

Response Fields

object
Read the current allowance from quoteAllowance on Get Security Status. Some settlement assets refuse to move a non-zero allowance straight to another non-zero value; where that applies, approve zero first.

Error Codes