/closeCashbox

1 min

POST

/closeCashbox

Call this endpoint to close a Cashbox. This endpoint requires the Cashbox ID and the fee index. Closing a cashbox returns all assets remaining in the Cashbox to the Cold Vault. Run /getCashboxes to get the values beforehand.

return: JSON object containing details of the created transaction.

closeCashbox(123, 0, "Closing primary cashbox")

cashbox_idintegerThe ID of the Cashbox to be closed. Run /getCashboxes to get the value beforehand.

fee_indexintegerThe fee index to use for the closing transaction. Run /getCashboxes to get the values beforehand.

user_descriptionstringA user-provided description.

acceptstringGenerated from available response content types

bodyobjectRequest data for closing a Cashbox.

200success

curl --request POST \
     --url '/closeCashbox?cashbox_id=1&fee_index=1&user_description=Closing%20primary%20cashbox' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
     "FunctionData": {
     "CashboxId": 1,
     "FeeIndex": 1
     },
     "Meta": {
     "FunctionName": "closeCashbox",
     "RandomData": "288cd49d4b8bf00e7d6114b78d5668d5581d6b953fafef779133caa844cd4229",
     "Destination": "b9cb8afe52f1d52521cf2b62dfe12146156ad5328f83c62c20c7da81b263356a61340de745c858998544c041798b01c2f4fac31bebe52a19280a32cd57d6d374ea",
     "Time": "2021-02-07T18:37:46.948Z",
     "Source": "048b99461a70a49abe63fd585cb224177a22a92d2e9e4ddfbc0027887bee9d1843388f42a3eb2e740565e115ad8b7981abf59e3b03b771f4b063b53c517d7a9d99",
     "AccessToken": "51311c84d2c8fd2fafbe56ceb1fb30a99d3417abfc55769577338ab286798087"
     }
     }'