POST pos/payment/cancel

Authorized only.

Request Information

URI Parameters

None.

Body Parameters

ApiProcessPaymentRequest
NameDescriptionTypeAdditional information
Type

ProcessPaymentType

None.
CompanyId

integer

None.
CustomerId

integer

None.
CustomPaymentMethodId

integer

None.
OrderTotal

decimal number

None.
Amount

decimal number

None.
IsRefund

boolean

None.
AllowPartial

boolean

None.
Params

Dictionary of string [key] and Object [value]

None.

Request Formats

application/json, text/json

Sample: 
{
  "Type": 1,
  "CompanyId": 1,
  "CustomerId": 1,
  "CustomPaymentMethodId": 1,
  "OrderTotal": 1.0,
  "Amount": 2.0,
  "IsRefund": true,
  "AllowPartial": true,
  "Params": {
    "sample string 1": {},
    "sample string 3": {}
  }
}

application/xml, text/xml

Sample: 
<ApiProcessPaymentRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IConnect.Domain.Mobile.Api">
  <AllowPartial>true</AllowPartial>
  <Amount>2</Amount>
  <CompanyId>1</CompanyId>
  <CustomPaymentMethodId>1</CustomPaymentMethodId>
  <CustomerId>1</CustomerId>
  <IsRefund>true</IsRefund>
  <OrderTotal>1</OrderTotal>
  <Params xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringanyType>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value />
    </d2p1:KeyValueOfstringanyType>
    <d2p1:KeyValueOfstringanyType>
      <d2p1:Key>sample string 3</d2p1:Key>
      <d2p1:Value />
    </d2p1:KeyValueOfstringanyType>
  </Params>
  <Type>GiftCard</Type>
</ApiProcessPaymentRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.
Content

HttpContent

None.
StatusCode

HttpStatusCode

None.
ReasonPhrase

string

None.
Headers

Collection of Object

None.
RequestMessage

HttpRequestMessage

None.
IsSuccessStatusCode

boolean

None.