Skip to main content
POST
/
v1
/
pledges
/
{id}
/
liquidations
Request pledge liquidation
curl --request POST \
  --url https://api.sandbox.busha.so/v1/pledges/{id}/liquidations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "reference": "default_case_348",
  "reason": "default_under_beneficiary_terms",
  "beneficiary_due": {
    "amount": "100",
    "currency": "BTC"
  },
  "items": [
    {
      "pledge_item_id": "PLI_01HX...",
      "amount": "100"
    }
  ],
  "evidence": {},
  "meta": {}
}
'
{
  "status": "success",
  "message": "message for success",
  "data": {
    "id": "PLR_01JB...",
    "pledge_id": "PLG_01HX...",
    "status": "pending_execution",
    "notice_period_seconds": 86400,
    "execute_after": "2023-10-15T12:15:30Z",
    "beneficiary_due": {
      "amount": "100",
      "currency": "BTC"
    },
    "created_at": "2023-10-15T12:15:30Z"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer Authentication

Headers

​
X-BU-PROFILE-ID
string

User profile header

Example:

"BUS_YOK8tp5Zga01qOKEsqp07"

Path Parameters

​
id
string
required

Pledge ID

Example:

"PLG_01HX..."

Body

application/json

Pledge liquidation request

​
reference
string
required
Required string length: 1 - 255
Example:

"default_case_348"

​
reason
string
required
Required string length: 1 - 255
Example:

"default_under_beneficiary_terms"

​
beneficiary_due
object
required

Amount with currency

​
items
object[]
required
Minimum array length: 1
​
evidence
object
required

Beneficiary evidence supporting the liquidation request.

​
meta
object

Optional non-query-critical pledge context.

Response

Successful pledge liquidation response

General response Values

​
status
enum<string>
required
Available options:
success,
error
Example:

"success"

​
message
string
required
Example:

"message for success"

​
data
object
required