Burn Vendor Balance

Endpoint to burn some amount of balance for a vendor.

POST /public/v1/billing-service/vendors/{external-vendor-id}/balance/burn

Burn Vendor Balance

cURL

curl --request POST \
  --url https://api.topsort.com/public/v1/billing-service/vendors/{external-vendor-id}/balance/burn \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": 123,
  "description": "<string>"
}
'

import requests

url = "https://api.topsort.com/public/v1/billing-service/vendors/{external-vendor-id}/balance/burn"

payload = {
    "amount": 123,
    "description": "<string>"
}
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({amount: 123, description: '<string>'})
};

fetch('https://api.topsort.com/public/v1/billing-service/vendors/{external-vendor-id}/balance/burn', 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.topsort.com/public/v1/billing-service/vendors/{external-vendor-id}/balance/burn",
  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([
    'amount' => 123,
    'description' => '<string>'
  ]),
  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.topsort.com/public/v1/billing-service/vendors/{external-vendor-id}/balance/burn"

	payload := strings.NewReader("{\n  \"amount\": 123,\n  \"description\": \"<string>\"\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.topsort.com/public/v1/billing-service/vendors/{external-vendor-id}/balance/burn")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"amount\": 123,\n  \"description\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.topsort.com/public/v1/billing-service/vendors/{external-vendor-id}/balance/burn")

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  \"amount\": 123,\n  \"description\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

422

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

Authorization · string · header · required

A valid API key generated in Topsort's UI. Use the TSE API key if calling auctions or events API, otherwise use the TSC API key.

Path Parameters

external-vendor-id · string · required

The External ID of the Vendor to retrieve.

Minimum string length: 1

Body

application/json

Basic request payload for Burning Balance.

amount · number · required

Amount to Burn. The value must be greater or equal to the minimum currency units. For example, for USD you cannot specify 0.009, as that's less than 1 cent.

Example:

100

description · string · required

Reason given to burn the amount

Minimum string length: 1

Example:

"Vendor used the money for other ads"

Response

204

Successful Response