Send native XRP from one account to another.
xrp.transfer(
params: XrpTransferParams,
options?: XrpTransferOptions,
): Promise<SubmissionResult<XrpTransferIntent>>| Parameter | Type | Required | Description |
|---|---|---|---|
to | string | Yes | Destination account XRPL address. |
amount | string | Yes | Amount to send, as a decimal string in XRP (e.g. '10', '0.25'). Must be non-negative, with at most 6 decimal places (1 drop, XRP's smallest unit). |
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<XrpTransferIntent>.
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 XRP.transfer, the intent (XrpTransferIntent) carries:
| Field | Type | Description |
|---|---|---|
to | string | Destination r-address. |
amount | string | Amount sent, in XRP. |
Builds and submits a single Payment transaction.
const result = await client.xrp.transfer({
to: 'rDestination...',
amount: '10',
})
console.log(result.txHash)