POST
/
public
/
v1
/
billing-service
/
vendors
/
{external-vendor-id}
/
balance
/
burn
curl --request POST \
  --url https://api.topsort.com/public/v1/billing-service/vendors/{external-vendor-id}/balance/burn \
  --header 'Content-Type: application/json' \
  --data '{
  "amount": 100,
  "description": "Vendor used the money for other ads"
}'
This response does not have an example.

Path Parameters

external-vendor-id
string
required

The External ID of the Vendor to retrieve.

Minimum 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.

Required range: x > 0
Example:

100

description
string
required

Reason given to burn the amount

Minimum length: 1
Example:

"Vendor used the money for other ads"

Response

204
_mintlify/placeholder

Successful Response