Request a pay-up (exposure increase)

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 sourceWalletID unset on every asset amount.
  • Secured-party-initiated: the secured party is the proposer and supplies sourceWalletID on 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:

  1. 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.
  2. The pledgor authorizes the settlement, either through the API or mobile app signing.
  3. The secured party authorizes the settlement, selecting their own source wallet at that time.
  4. The settlement is funded from the secured party's chosen source wallet.
  5. 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.

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

The unique identifier of the collateral package to request a pay-up on.

Body Params

The details for requesting a pay-up

The request payload for requesting a pay-up (exposure increase) on a collateral package.

assetAmounts
array of objects
required
length ≥ 1

Asset types and amounts to receive from the secured party. The destination wallet is determined from each asset's exposure configuration.

assetAmounts*
string
required
length ≤ 128

Idempotency key for ensuring operation uniqueness.

boolean
Defaults to false

Whether to use gas station for fee payment. Defaults to false.

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.

Construction example:

toHex(
  ed25519Sign(
    signing_key,
    '{}{}{}{}'.format(timestamp_epoch_seconds, toUpper(httpMethod), httpRequestPath, httpBody)
  )
)
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