Skip to main content
POST
Returns unsigned approve calldata letting the custody contract deliver the security from a seller’s wallet at settlement. Sellers need this only when the security uses TRANSFER delivery. The custody contract then moves the security with transferFrom, and the token runs its own transfer rules. Without an allowance a sell order’s tradable balance reads as zero, because the venue reports the lesser of the unfrozen balance and the allowance. A security under AGENT delivery moves by forced transfer and ignores this allowance. See Delivery modes. The transaction is signed by the seller and targets the security token. Prepare Order reports the amount a sell order needs in approval.required, which covers the order and the seller’s other resting sell orders together. The custody contract can only use the allowance to settle a sell order the seller signed.

Path Parameters

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

Body Parameters

string
required
Allowance to set, in the security’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 securityAllowance on Get Security Status.

Error Codes