POST admin/pos/sale/{id}/chargecancel

No documentation available.

Request Information

Parameters

NameDescriptionAdditional information
id
No documentation available.

Define this parameter in the request URI.

inVO
No documentation available.

Define this parameter in the request body.

Request body formats

application/json, text/json

Sample:
{
  "saleId": "sample string 1",
  "registerId": "sample string 2",
  "processorPaymentId": "sample string 3",
  "amount": 1.0,
  "otherTenders": [
    {
      "type": "sample string 1",
      "amount": 2.0,
      "amountTendered": 1.0,
      "processorPaymentId": "sample string 3",
      "cardBrand": "sample string 4",
      "last4": "sample string 5",
      "authCode": "sample string 6"
    },
    {
      "type": "sample string 1",
      "amount": 2.0,
      "amountTendered": 1.0,
      "processorPaymentId": "sample string 3",
      "cardBrand": "sample string 4",
      "last4": "sample string 5",
      "authCode": "sample string 6"
    },
    {
      "type": "sample string 1",
      "amount": 2.0,
      "amountTendered": 1.0,
      "processorPaymentId": "sample string 3",
      "cardBrand": "sample string 4",
      "last4": "sample string 5",
      "authCode": "sample string 6"
    }
  ],
  "schoolId": "sample string 4",
  "networkId": "sample string 5",
  "curUserId": "sample string 6",
  "isSSO": true,
  "requestHost": "sample string 8",
  "applicationPath": "sample string 9",
  "secureApplicationPath": "sample string 10",
  "absoluteApplicationPath": "sample string 11",
  "isHttps": true,
  "isMobileDevice": true,
  "isElectron": true,
  "isFullEmbed": true,
  "clientType": 0,
  "clientVersion": "sample string 16",
  "clientOS": "sample string 17",
  "clientBuild": "sample string 18",
  "premiumAppId": "sample string 19",
  "clientWidth": 20,
  "clientHeight": 21,
  "timezone": 22
}

application/xml, text/xml

Sample:
<PosCardChargeInVO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input.Pos">
  <ClientHeight xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">21</ClientHeight>
  <ClientType xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">Site</ClientType>
  <ClientWidth xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">20</ClientWidth>
  <absoluteApplicationPath xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">sample string 11</absoluteApplicationPath>
  <applicationPath xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">sample string 9</applicationPath>
  <cachedKey xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">sample string 1</cachedKey>
  <clientBuild xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">sample string 18</clientBuild>
  <clientOS xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">sample string 17</clientOS>
  <clientVersion xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">sample string 16</clientVersion>
  <curUserId xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">sample string 6</curUserId>
  <isElectron xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">true</isElectron>
  <isFullEmbed xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">true</isFullEmbed>
  <isHttps xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">true</isHttps>
  <isMobileDevice xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">true</isMobileDevice>
  <isSSO xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">true</isSSO>
  <premiumAppId xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">sample string 19</premiumAppId>
  <requestHost xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">sample string 8</requestHost>
  <secureApplicationPath xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">sample string 10</secureApplicationPath>
  <timezone xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">22</timezone>
  <NetworkId xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">sample string 5</NetworkId>
  <SchoolId>sample string 4</SchoolId>
  <Amount>1</Amount>
  <OtherTenders>
    <PosTenderInVO>
      <Amount>2</Amount>
      <AmountTendered>1</AmountTendered>
      <AuthCode>sample string 6</AuthCode>
      <CardBrand>sample string 4</CardBrand>
      <Last4>sample string 5</Last4>
      <ProcessorPaymentId>sample string 3</ProcessorPaymentId>
      <Type>sample string 1</Type>
    </PosTenderInVO>
    <PosTenderInVO>
      <Amount>2</Amount>
      <AmountTendered>1</AmountTendered>
      <AuthCode>sample string 6</AuthCode>
      <CardBrand>sample string 4</CardBrand>
      <Last4>sample string 5</Last4>
      <ProcessorPaymentId>sample string 3</ProcessorPaymentId>
      <Type>sample string 1</Type>
    </PosTenderInVO>
    <PosTenderInVO>
      <Amount>2</Amount>
      <AmountTendered>1</AmountTendered>
      <AuthCode>sample string 6</AuthCode>
      <CardBrand>sample string 4</CardBrand>
      <Last4>sample string 5</Last4>
      <ProcessorPaymentId>sample string 3</ProcessorPaymentId>
      <Type>sample string 1</Type>
    </PosTenderInVO>
  </OtherTenders>
  <ProcessorPaymentId>sample string 3</ProcessorPaymentId>
  <RegisterId>sample string 2</RegisterId>
  <SaleId>sample string 1</SaleId>
</PosCardChargeInVO>

application/x-www-form-urlencoded

Sample:

Sample not available.

multipart/form-data

Sample:
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="cachedKey"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e--

Response Information

No documentation available.

Response body formats

application/json, text/json

Sample:
{
  "isDone": true,
  "code": 0,
  "message": "sample string 2",
  "data": {},
  "cachedKey": "sample string 4",
  "correlationId": "e8b4a0f5-c977-4273-88b1-45b68412170a",
  "jwtTokenForSPA": "sample string 6",
  "jwtTokenIndexForSPA": 1
}

application/xml, text/xml

Sample:
<ResultOutVO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Output.Common">
  <CachedKey>sample string 4</CachedKey>
  <Code>None</Code>
  <CorrelationId>e8b4a0f5-c977-4273-88b1-45b68412170a</CorrelationId>
  <Data />
  <IsDone>true</IsDone>
  <JwtTokenForSPA>sample string 6</JwtTokenForSPA>
  <JwtTokenIndexForSPA>1</JwtTokenIndexForSPA>
  <Message>sample string 2</Message>
</ResultOutVO>

multipart/form-data

Sample:

Sample not available.