Purpose

Removes prepayments in the specified order

Request typeasynchronous/synchronous
Supported agent version, SH

WSA v2.8.5.8

PluggetSystemTypeRKMid

Request format

{
    "taskType": "RemovePrepayOrder",
    "params": {
        "sync": {
            "objectId": number,
            "timeout": number
        },
        "orderGuid": "string"
    }
}

Parameter

Type

Mandatory

Description

taskTypestring+Task type (RemovePrepayOrder)
sync

Synchronous method call (either synchronous or asynchronous)
|-timeoutint-Agent response timeout in seconds, default is 120 seconds
|-objectIdint+Restaurant code in the licensing system
orderGuidguid+Order guid in r_keeper

Response format

// Successful response {
    "taskResponse": {},
    "responseCommon": {
        "taskGuid": "string",
        "taskType": "RemovePrepayOrder",
        "objectId": number,
        "agentGuid": "string"
    }
}
  
// Response with error
{
  "responseCommon": {
    "taskGuid": "string",
    "taskType": "RemovePrepayOrder",
    "objectId": number
  },
  "error": {
    "wsError": {
      "code": "string",
      "desc": "string"
    },
    "agentError": {
      "code": "string",
      "desc": "string"
    }
  }
}



Example request

{
    "taskType": "RemovePrepayOrder",
    "params": {
        "sync": {
            "objectId": "199990246",
            "timeout": 120
        },
        "orderGuid": "8fcf1323-a26c-4afc-a8a4-7023372b4ebb"
    }
}



Example response

{
    "taskResponse": {},
    "responseCommon": {
        "taskGuid": "3bc26173-c9a8-486b-9f7a-e68b4159b5c8",
        "taskType": "RemovePrepayOrder",
        "objectId": 199990246,
        "agentGuid": "d564619a-50c3-3d87-0816-de67ed9c8e18"
    }
}