Skip to main content
POST
Build funding instructions for a settlement leg

Authorizations

Authorization
string
header
required

Auth0 JWT access token. See Authentication for details.

Path Parameters

settlement_id
string<uuid>
required
leg_id
string<uuid>
required

Response

Successful Response

kind
string
required
Allowed value: "escrow_deposit"
settlement_id
string<uuid>
required
leg_id
string<uuid>
required
leg_index
integer
required

The canonical ordinal the contract keys the leg by.

chain_id
integer
required
escrow_address
string
required

The KeystoneSettlement contract holding the registration.

token_address
string
required
sender
string
required

The wallet the deposit commitment binds. Both transactions must be sent from it.

amount
string
required

The registered leg amount, in base units.

depositor_fee
string
required

The additive fee registered on the leg, in base units; the depositor pays it on top.

total
string
required

amount plus depositor_fee: what depositLeg pulls and what the approval covers.

transactions
FundingTransactionRead · object[]
required

In submission order.

deadline
FundingDeadlineRead · object
required
observation
EscrowObservationRead · object
required
wait_for
WaitStepRead · object[]
required

What to wait for after submitting, in order.

constructed_only
boolean
required

Always true: a 200 constructs, it submits nothing.

meaning
string
required