Skip to main content
POST
/
public
/
v1
/
billing-service
/
vendors
/
{external-vendor-id}
/
balance
Add Vendor Balance
curl --request POST \
  --url https://api.topsort.com/public/v1/billing-service/vendors/{external-vendor-id}/balance \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "balance": 123,
  "description": "Free credits added to the account"
}
'
{
  "result": true
}

Authorizations

​
Authorization
string
header
required

A valid API key generated in Topsort's UI.

Path Parameters

​
external-vendor-id
string
required

The External ID of the Vendor to retrieve.

Minimum string length: 1

Body

application/json

Basic request Data for Adding Balance

​
balance
number
required

Amount to add in the marketplace currency

​
description
string | null

Reason given to add the amount

Minimum string length: 1
Example:

"Free credits added to the account"

Response

Successful Response

Result of the Balance Adding. Returns True if the operation was executed correctly.

​
result
boolean
required