Zum Hauptinhalt springen
POST
/
public
/
v1
/
billing-service
/
vendors
/
{external-vendor-id}
/
balance
/
burn
Burn Vendor Balance
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>"
}
'
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Autorisierungen

Authorization
string
header
erforderlich

A valid API key generated in Topsort's UI.

Pfadparameter

external-vendor-id
string
erforderlich

The External ID of the Vendor to retrieve.

Minimum string length: 1

Body

application/json

Basic request payload for Burning Balance.

amount
number
erforderlich

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.

Beispiel:

100

description
string
erforderlich

Reason given to burn the amount

Minimum string length: 1
Beispiel:

"Vendor used the money for other ads"

Antwort

Successful Response