Burn Vendor Balance

Endpoint to burn some amount of balance for a vendor.

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

description

string

required

Reason given to burn the amount

Minimum length: 1