Skip to content
Topsort Documentation
API

Add Vendor Balance

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

Endpoint to add some balance for a vendor.

Will truncate the input to its minimum denomination, e.g. USD 1,000.234 is USD 1,000.23 , as there is no fraction of a cent.

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 Data for Adding Balance

application/json
object
balance
required

Amount to add in the marketplace currency

number
description

Reason given to add the amount

string
>= 1 characters

Responses

Successful Response

This is the result of the Balance Adding. returns True if the operation was executed correctly.

application/json
object
result
required
boolean