Jump to

• Request
• Response

Burn Approved Tokens

post

{baseUrl}/v1/{wholesaleCbdctokenHoldableContractAddress}/burnFrom

Burns tokens from an approved account.

Request

Path Parameters

• wholesaleCbdctokenHoldableContractAddress(required): string
  Path parameter

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• account(required): string
  Example: 0x0000000000000000000000000000000000000000
• value(required): integer
  Example: 0
• walletId(required): string
  Postman variable {{walletId}}

  Example:

{
    "type":"object",
    "properties":{
        "walletId":{
            "type":"string",
            "example":"",
            "description":"Postman variable {{walletId}}"
        },
        "account":{
            "type":"string",
            "example":"0x0000000000000000000000000000000000000000"
        },
        "value":{
            "type":"integer",
            "example":0
        }
    },
    "required":[
        "walletId",
        "account",
        "value"
    ],
    "additionalProperties":false
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful rpc-proxy transaction response.

Body ()

Root Schema : RpcProxy_TransactionSuccessResponse

Type: object

Show Source

• data(required): string
  Pattern: ^0x[a-fA-F0-9]*$
• decoded: object RpcProxy_DecodedTransaction
• from(required): string
  Pattern: ^0x[a-fA-F0-9]{40}$
• nonce(required): string
• operation(required): string
  Example: NORMAL
• rawResult(required): string
  Pattern: ^0x[a-fA-F0-9]*$
• to(required): string
  Pattern: ^0x[a-fA-F0-9]{40}$
• txHash(required): string
  Pattern: ^0x[a-fA-F0-9]{64}$

{
    "type":"object",
    "required":[
        "operation",
        "from",
        "txHash",
        "rawResult",
        "to",
        "data",
        "nonce"
    ],
    "properties":{
        "operation":{
            "type":"string",
            "example":"NORMAL"
        },
        "from":{
            "type":"string",
            "pattern":"^0x[a-fA-F0-9]{40}$"
        },
        "txHash":{
            "type":"string",
            "pattern":"^0x[a-fA-F0-9]{64}$"
        },
        "rawResult":{
            "type":"string",
            "pattern":"^0x[a-fA-F0-9]*$"
        },
        "to":{
            "type":"string",
            "pattern":"^0x[a-fA-F0-9]{40}$"
        },
        "data":{
            "type":"string",
            "pattern":"^0x[a-fA-F0-9]*$"
        },
        "nonce":{
            "type":"string"
        },
        "decoded":{
            "$ref":"#/components/schemas/RpcProxy_DecodedTransaction"
        }
    }
}

Nested Schema : RpcProxy_DecodedTransaction

Type: object

Show Source

• events: array events
• function: object RpcProxy_DecodedFunction
• meta: object RpcProxy_DecodedMeta

{
    "type":"object",
    "properties":{
        "meta":{
            "$ref":"#/components/schemas/RpcProxy_DecodedMeta"
        },
        "function":{
            "$ref":"#/components/schemas/RpcProxy_DecodedFunction"
        },
        "events":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RpcProxy_DecodedEvent"
            }
        }
    }
}

Nested Schema : events

Type: array

Show Source

• Array of: object RpcProxy_DecodedEvent

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/RpcProxy_DecodedEvent"
    }
}

Nested Schema : RpcProxy_DecodedFunction

Type: object

Show Source

• name: string
• selector: string
  Pattern: ^0x[a-fA-F0-9]{8}$
• signature: string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "signature":{
            "type":"string"
        },
        "selector":{
            "type":"string",
            "pattern":"^0x[a-fA-F0-9]{8}$"
        }
    }
}

Nested Schema : RpcProxy_DecodedMeta

Type: object

Show Source

• abiSource: string
• issues: array issues

{
    "type":"object",
    "properties":{
        "abiSource":{
            "type":"string"
        },
        "issues":{
            "type":"array",
            "items":{
                "type":"object",
                "additionalProperties":true
            }
        }
    }
}

Nested Schema : RpcProxy_DecodedEvent

Type: object

Show Source

• address: string
  Pattern: ^0x[a-fA-F0-9]{40}$
• args: array args
• data: string
• logIndex: integer
• name: string
• signature: string
• topics: array topics

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "signature":{
            "type":"string"
        },
        "address":{
            "type":"string",
            "pattern":"^0x[a-fA-F0-9]{40}$"
        },
        "logIndex":{
            "type":"integer"
        },
        "topics":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "data":{
            "type":"string"
        },
        "args":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RpcProxy_DecodedValue"
            }
        }
    }
}

Nested Schema : args

Type: array

Show Source

• Array of: object RpcProxy_DecodedValue

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/RpcProxy_DecodedValue"
    }
}

Nested Schema : topics

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : RpcProxy_DecodedValue

Type: object

Show Source

• indexed: boolean
  Present for decoded event arguments.
• name(required): string
• type(required): string
  Solidity ABI type.
• value(required):
  ABI-decoded value; representation varies by Solidity type.

{
    "type":"object",
    "required":[
        "name",
        "type",
        "value"
    ],
    "properties":{
        "name":{
            "type":"string"
        },
        "type":{
            "type":"string",
            "description":"Solidity ABI type."
        },
        "indexed":{
            "type":"boolean",
            "description":"Present for decoded event arguments."
        },
        "value":{
            "description":"ABI-decoded value; representation varies by Solidity type."
        }
    }
}

Nested Schema : issues

Type: array

Show Source

• Array of: object items
  Additional Properties Allowed: true

{
    "type":"array",
    "items":{
        "type":"object",
        "additionalProperties":true
    }
}

Nested Schema : items

Type: object

Additional Properties Allowed: true

400 Response

Wrapper validation failure or rpc-proxy bad-request response.

404 Response

Unregistered endpoint or rpc-proxy not-found response.

502 Response

Wrapper-to-rpc-proxy failure or rpc-proxy gateway response.

Default Response

rpc-proxy status, content type, and response body are passed through unchanged.

Back to Top