Burn

Burns currency tokens. The sender must be a token manager and the account supplying the tokens to burn must additionally sign the transaction.

The expected flow is that the token manager will have its designated burn account which customers would transfer the tokens to before they are burnt. Alternatively, the customers could directly sign the transaction in which case it would act as an atomic "transfer-and-burn" transaction.

JSON representation 
{
  "burnAmount": {
    object (CurrencyValue)
  },
  "payer": {
    object (Entity)
  },
  "payerId": string
}
Fields
burnAmount

object (CurrencyValue)

Required. The amount to burn.
payer
(deprecated)

object (Entity)

Optional. Deprecated: Use payerId instead. The account supplying the tokens to burn. The account must have the ROLE_PAYER enabled on it.
payerId

string

Optional. The ID of the account supplying the tokens to burn. The payer account must have the ROLE_PAYER enabled on it. One of payer or payerId must be specified.