Skip to main content
POST
/
v1
/
pledges
/
{id}
/
items
Add pledge items
curl --request POST \
  --url https://api.sandbox.busha.so/v1/pledges/{id}/items \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "reference": "topup_7af2",
  "items": [
    {
      "asset": "BTC",
      "amount": "100"
    }
  ],
  "reason": "beneficiary_requested_top_up",
  "meta": {}
}
'
import requests

url = "https://api.sandbox.busha.so/v1/pledges/{id}/items"

payload = {
"reference": "topup_7af2",
"items": [
{
"asset": "BTC",
"amount": "100"
}
],
"reason": "beneficiary_requested_top_up",
"meta": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
reference: 'topup_7af2',
items: [{asset: 'BTC', amount: '100'}],
reason: 'beneficiary_requested_top_up',
meta: {}
})
};

fetch('https://api.sandbox.busha.so/v1/pledges/{id}/items', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sandbox.busha.so/v1/pledges/{id}/items",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'reference' => 'topup_7af2',
'items' => [
[
'asset' => 'BTC',
'amount' => '100'
]
],
'reason' => 'beneficiary_requested_top_up',
'meta' => [

]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.sandbox.busha.so/v1/pledges/{id}/items"

payload := strings.NewReader("{\n \"reference\": \"topup_7af2\",\n \"items\": [\n {\n \"asset\": \"BTC\",\n \"amount\": \"100\"\n }\n ],\n \"reason\": \"beneficiary_requested_top_up\",\n \"meta\": {}\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.sandbox.busha.so/v1/pledges/{id}/items")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"reference\": \"topup_7af2\",\n \"items\": [\n {\n \"asset\": \"BTC\",\n \"amount\": \"100\"\n }\n ],\n \"reason\": \"beneficiary_requested_top_up\",\n \"meta\": {}\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.sandbox.busha.so/v1/pledges/{id}/items")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"reference\": \"topup_7af2\",\n \"items\": [\n {\n \"asset\": \"BTC\",\n \"amount\": \"100\"\n }\n ],\n \"reason\": \"beneficiary_requested_top_up\",\n \"meta\": {}\n}"

response = http.request(request)
puts response.read_body
{
  "status": "success",
  "message": "message for success",
  "data": {
    "id": "PLG_01HX...",
    "items": [
      {
        "id": "PLI_01HX...",
        "asset": "BTC",
        "locked_amount": "100",
        "released_amount": "100",
        "liquidated_amount": "100",
        "available_to_release": "100"
      }
    ],
    "event_id": "PLE_01HZ..."
  }
}

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

Add pledge items request

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

"topup_7af2"

items
object[]
required
Minimum array length: 1
reason
string
Maximum string length: 255
Example:

"beneficiary_requested_top_up"

meta
object

Optional non-query-critical pledge context.

Response

Successful add pledge items response

General response Values

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

"success"

message
string
required
Example:

"message for success"

data
object
required