Skip to content
Topsort Documentation
API

Burn Vendor Balance

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

Endpoint to burn some amount of balance for a vendor.

Authentication

Topsort’s APIs are authenticated via bearer tokens. Requests must include an authorization header containing your private API key.

Don't have an API key yet? Learn how to generate one.

Authorization
required
string

The header containing a private API key. Format this header as follows:

Authorization: Bearer <YOUR-API-KEY>

Path Parameters

object
external-vendor-id
required

The External ID of the Vendor to retrieve.

string
>= 1 characters

The External ID of the Vendor to retrieve.

Request Body

Basic request payload for Burning Balance.

application/json
object
amount
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.

number
description
required

Reason given to burn the amount

string
>= 1 characters

Responses

Successful Response