Skip to main content
GET
/
v1
/
pledges
List pledges
curl --request GET \
  --url https://api.sandbox.busha.so/v1/pledges \
  --header 'Authorization: Bearer <token>'
{
  "status": "success",
  "message": "message for success",
  "pagination": {
    "current_entries_size": 20,
    "next_cursor": "MjAyNC0xMC0xNVQxMTowNTo1My45NTkxNDErMDE6MDA=",
    "previous_cursor": "MjAyNC0xMC0xNVQxMDowNTo1My45NTIxQjE3MDE6MDA="
  },
  "data": [
    {
      "id": "PLG_01HX...",
      "reference": "credit_agreement_93b7",
      "mandate_hash": "sha256:...",
      "items": [
        {
          "id": "PLI_01HX...",
          "asset": "BTC",
          "locked_amount": "100",
          "released_amount": "100",
          "liquidated_amount": "100",
          "available_to_release": "100"
        }
      ],
      "customer_profile_id": "PRF_customer...",
      "beneficiary_profile_id": "BUS_beneficiary...",
      "activated_at": "2023-10-15T12:15:30Z",
      "expires_at": "2023-10-15T12:15:30Z",
      "released_at": "2023-10-15T12:15:30Z",
      "liquidated_at": "2023-10-15T12:15:30Z",
      "events": [
        {
          "id": "PLE_01HX...",
          "type": "pledge.activated",
          "actor_type": "beneficiary",
          "created_at": "2023-10-15T12:15:30Z",
          "reference": "activation_disb_9f1"
        }
      ]
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer Authentication

Headers

​
X-BU-PROFILE-ID
string

User profile header

Example:

"BUS_YOK8tp5Zga01qOKEsqp07"

Query Parameters

​
status
enum<string>[]

Filter by pledge status

Available options:
authorized,
active,
liquidation_pending,
released,
liquidated,
expired,
cancelled
​
asset
string<string>[]

Filter by pledged asset

A valid currency

Required string length: 1 - 10
​
reference
string

Filter by beneficiary-supplied pledge reference

​
cursor
string<string>

The cursor

​
sort
enum<string>

The order to sort the results

Available options:
asc,
desc
Example:

"asc"

​
limit
integer

The number of items to return

Example:

10

Response

Successful pledge list response

General response Values

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

"success"

​
message
string
required
Example:

"message for success"

​
pagination
object
required
​
data
object[]
required