Reclaim a holder's balance back to the issuer.
Note
Verifies the issuer has asfAllowTrustLineClawback enabled first (a ledger read), throwing a clear error if not. The flag can only be enabled before the issuer owns any trust lines, offers, or other ledger objects, which this SDK does not itself pre-check.
iou.clawback(
params: IOUClawbackParams,
options?: IOUWriteOptions,
): Promise<SubmissionResult<IOUClawbackIntent>>| Parameter | Type | Required | Description |
|---|---|---|---|
ticker | string | Yes | The currency code (3-character ISO-4217-style or 40-character hex; other codes are auto-encoded to hex). |
holder | string | Yes | The holder's r-address to claw the currency back from. |
amount | string | Yes | The amount to claw back, as a decimal string. Must be non-negative, with at most 15 significant digits. |
options is an optional second argument that sets the source account and overrides the fee.
| Option | Type | Required | Description |
|---|---|---|---|
from | AccountSelector | No | The account to act as — an r-address string, or an object { address } or { signer, account? }. Defaults to the primary signer's primary account. (For IOU operations, this is the issuer.) |
fee | FeeIntent | No | Fee override — a priority tier and/or a maxFeeDrops cap. |
idempotencyKey | string | No | A prior submission's idempotencyKey, to retry to the same intent instead of creating a duplicate. Auto-generated when omitted. |
Resolves to a SubmissionResult<IOUClawbackIntent>.
Every simpleXRPL write resolves to a SubmissionResult<T> — a union tagged by source, with the backend's raw response preserved verbatim. Its common fields are:
| Field | Type | Description |
|---|---|---|
intent | T | The operation-specific output — see the operation's own return fields. |
source | 'xrpld' | 'custody' | 'palisade' | Which backend produced the result; discriminates response. |
response | TxResponse | custody record | Palisade record | The backend's raw response, preserved verbatim. |
txHash | string (optional) | The XRPL transaction hash, once the transaction is on-ledger. |
intentId | string (optional) | The custodian intent id, when the path produced one. Hold onto this to resume via client.intent. |
idempotencyKey | string (optional) | The UUIDv7 this submission carried. Pass it back as a later call's idempotencyKey to retry to the same intent rather than creating a duplicate. |
For IOU.clawback, the intent (IOUClawbackIntent) echoes:
| Field | Type | Description |
|---|---|---|
holder | string | The holder's r-address clawed back from. |
amount | string | The amount clawed back. |
Builds and submits a single Clawback transaction.
await client.iou.clawback({
ticker: 'USD',
holder: 'rHolder...',
amount: '50',
})