Skip to main content
POST
Request pledge liquidation

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