Skip to main content
POST
/
v1
/
pledges
/
{id}
/
release
Release pledge items
curl --request POST \
  --url https://api.sandbox.busha.so/v1/pledges/{id}/release \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "reference": "release_rel_901",
  "full_release": false,
  "reason": "partial_repayment",
  "items": [
    {
      "pledge_item_id": "PLI_01HX...",
      "amount": "100"
    }
  ],
  "meta": {}
}
'
{
  "status": "success",
  "message": "message for success",
  "data": {
    "id": "PLG_01HX...",
    "released_items": [
      {
        "pledge_item_id": "PLI_01HX...",
        "asset": "BTC",
        "released_amount": "100",
        "remaining_locked_amount": "100"
      }
    ],
    "event_id": "PLE_01JA..."
  }
}

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 release request

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

"release_rel_901"

​
full_release
boolean
required

Release all remaining pledged assets when true.

Example:

false

​
reason
string
Maximum string length: 255
Example:

"partial_repayment"

​
items
object[]
​
meta
object

Optional non-query-critical pledge context.

Response

Successful pledge release response

General response Values

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

"success"

​
message
string
required
Example:

"message for success"

​
data
object
required