Skip to main content
GET
List pledges

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