Settlements
Last updated
Last updated
In the general case, each settlement has four steps, allowing the API to accommodate a wide variety of methods.
POST https://partners.liquid.com /api/v1/settlement/method
Creates the settlement for the side of the transaction specified by direction.
As a shortcut, method can be supplied when initiating the /intent_to_trade request.
POST https://partners.liquid.com/api/v1/settlement/parameters
Set input parameter values. Should only be called if there are required input parameters.
For settlement methods where no setup parameters are provided by the server, input parameters and can be optionally supplied when specifying the settlement method.
POST https://partners.liquid.com/api/v1/settlement/method
As a shortcut both method and input parameters can be supplied in the /intent_to_trade endpoints where there are no setup parameters.
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
transaction_id
string
direction
string
method
string
api_key
string
settlement_instruction_id
string
input_parameters
string
api_key
string
transaction_id
string
method
string
direction
string
input_parameters
object
Status
Description
PARAMETERS_REQUIRED
Information is required. Must be specified through /input_parameters
READY
All information for the settlement has been received. Waiting for the other settlement to be READY or COMPLETE
WAITING_USER
Waiting for the user to take some action not related to the API (eg initiate a blockchain transfer for funding)
WAITING_EXTERNAL
Waiting for some external process.
WAITING_INTERNAL
Waiting for some internal process.
COMPLETE
Settlement is complete
MANUAL_INTERVENTION_REQUIRED
Some error has occoured and the transaction has started in some way (ie funds are locked).
CANCELLED
Some error has occoured or the transaction has timed out and no funds are locked.
