Permissions required: Manage Collateral Packages and Read vault activity
Initiate a pay-up: an increase in exposure on a collateral package by sending additional loan funds from the secured party to the pledgor's preconfigured disbursement wallet for each requested exposure asset. The package must be in HEALTHY or MARGIN_RETURN state, and the increase must not push the package's projected state out of those two states.
A pay-up is fulfilled by creating a two-way Atlas settlement. In both cases below, the pledgor's destination wallet is not supplied by the caller — it is resolved from each requested asset's exposure configuration.
Either the pledgor or the secured party may initiate a pay-up:
- Pledgor-initiated: the pledgor is the settlement proposer; the secured party is the acceptor and endorses the settlement, picking their own source wallet at that time. Leave
sourceWalletIDunset on every asset amount. - Secured-party-initiated: the secured party is the proposer and supplies
sourceWalletIDon every asset amount — the wallet the funds are drawn from. This is a one-way send; no pledgor endorsement is required.
{
"assetAmounts": [
{ "assetTypeID": "BTC", "value": "1.1" }
],
"idempotencyKey": "my-unique-request-id-001",
"useGasStation": false
}The steps to complete a pledgor-initiated pay-up are:
- The pledgor requests the pay-up via this endpoint, specifying assets and amounts. The pledgor's destination wallet is resolved automatically from the exposure's disbursement wallet configuration.
- The pledgor authorizes the settlement, either through the API or mobile app signing.
- The secured party authorizes the settlement, selecting their own source wallet at that time.
- The settlement is funded from the secured party's chosen source wallet.
- The assets are transferred on-chain to the pledgor's disbursement wallet.
A secured-party-initiated pay-up skips steps 2-3: the settlement is created already funded from the caller-supplied sourceWalletID and requires no pledgor endorsement.
A pledgor-initiated settlement stays in the ActionNeeded state until the secured party authorizes it, then enters Executing. A secured-party-initiated settlement enters Executing immediately. Both reach one of the final states after that.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||