Propose settling assets out of a delegation

Permissions required: Propose and Accept settlements

As either party to a delegation, propose settling delegated assets out of the delegation or into it, using wallets owned by your organization. The delegation's settle rights can limit which party may propose.

Positive quantities indicate funds your wallets receive; negative quantities indicate funds they send. Every wallet amount must point the same way; an asset may be sent from several wallets but received into only one. Funds settled into the delegation land in the pledgor's wallet for that asset in the delegation's vault, and the delegation grows by them.

The settlement requires the delegator's approval before any assets move. The request is accepted for processing and can be tracked via the returned settlementRequestId.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
length ≥ 1

ID of the delegation to settle assets out of or into

Body Params

Settlement request

string
length ≤ 128

Optional reference memo recorded on the settlement and visible to both parties.

string
required
length ≤ 128
walletAmounts
array of objects
required
length ≥ 1

The assets to settle and the wallets that receive or send them. A received asset can appear only once; a sent asset can come from several wallets, each listed once per asset.

walletAmounts*
Headers
string
required
^[0-9A-Fa-f]{128,160}$

A hex-encoded Ed25519 signature of timestamp_epoch_seconds + uppercase(http_method) + request_path + request_body.

int64
required

Current timestamp, represented as unix epoch seconds

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json