Skip to main content
POST
/
v1
/
pledges
/
quotes
Create pledge quote
curl --request POST \
  --url https://api.sandbox.busha.so/v1/pledges/quotes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "reference": "credit_agreement_93b7",
  "items": [
    {
      "asset": "BTC",
      "amount": "100"
    }
  ],
  "expires_at": "2023-10-15T12:15:30Z",
  "meta": {}
}
'
{ "status": "success", "message": "message for success", "data": { "id": "PLQ_01HX...", "status": "quoted", "expires_at": "2023-10-15T12:15:30Z", "reference": "credit_agreement_93b7", "can_create": true, "items": [ { "asset": "BTC", "amount": "100", "can_lock": true } ] } }

Authorizations

Authorization
string
header
required

Bearer Authentication

Headers

X-BU-PROFILE-ID
string

User profile header

Example:

"BUS_YOK8tp5Zga01qOKEsqp07"

Body

application/json

Pledge quote request

reference
string
required

Beneficiary-supplied credit agreement or case reference.

Required string length: 1 - 255
Example:

"credit_agreement_93b7"

items
object[]
required
Minimum array length: 1
expires_at
string<date-time>
Example:

"2023-10-15T12:15:30Z"

meta
object

Optional non-query-critical pledge context.

Response

Successful pledge quote response

General response Values

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

"success"

message
string
required
Example:

"message for success"

data
object
required