POST pos/payment/creditcard/void

Authorized only.

Request Information

URI Parameters

None.

Body Parameters

ApiProcessCreditCardVoidRequest
NameDescriptionTypeAdditional information
TemporaryOrderId

globally unique identifier

None.
CustomerId

integer

None.
ExternalTransactionData

string

None.
CreditCardProvider

CreditCardProvider

None.
RefundIfFails

boolean

None.
Amount

decimal number

None.
Params

Dictionary of string [key] and Object [value]

None.

Request Formats

application/json, text/json

Sample: 
{
  "TemporaryOrderId": "5706189c-2400-4e66-98b8-71a686b31440",
  "CustomerId": 2,
  "ExternalTransactionData": "sample string 3",
  "CreditCardProvider": 0,
  "RefundIfFails": true,
  "Amount": 1.0,
  "Params": {
    "sample string 1": {},
    "sample string 3": {}
  }
}

application/xml, text/xml

Sample: 
<ApiProcessCreditCardVoidRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IConnect.Domain.Mobile.Api">
  <Amount>1</Amount>
  <CreditCardProvider>NotSelected</CreditCardProvider>
  <CustomerId>2</CustomerId>
  <ExternalTransactionData>sample string 3</ExternalTransactionData>
  <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>
  <RefundIfFails>true</RefundIfFails>
  <TemporaryOrderId>5706189c-2400-4e66-98b8-71a686b31440</TemporaryOrderId>
</ApiProcessCreditCardVoidRequest>

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.