POST v1/PaymentSession/Void

Void any transaction related to an iFrame session

URI template

v1/PaymentSession/Void

Request Information

URI Parameters

None.

Body Parameters

The details of the void request being made

InVoidSessionRequest

Name	Description	Type	Additional information
SiteId	Get or set the SiteId property	integer	Required
PreAuthReferenceId	The preauth reference Id corresponding to the session transaction	string	Required
ChargedAmount	The amount used in the transaction	decimal number	Required
MaskedCardNumber	The masked card number used in the transaction	string	Required
ExpirationDate	The expiration date of the card used in the transaction	string	Required
TokenType	The token type for the transaction	string	Required
TokenValue	The token value for the transaction	string	Required

Request Formats

application/json, text/json

Sample:

{
  "SiteId": 1,
  "PreAuthReferenceId": "sample string 2",
  "ChargedAmount": 3.0,
  "MaskedCardNumber": "sample string 4",
  "ExpirationDate": "sample string 5",
  "TokenType": "sample string 6",
  "TokenValue": "sample string 7"
}

application/xml, text/xml

Sample:

<InVoidSessionRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OnlineOrderingAPI.Inbound">
  <ChargedAmount>3</ChargedAmount>
  <ExpirationDate>sample string 5</ExpirationDate>
  <MaskedCardNumber>sample string 4</MaskedCardNumber>
  <PreAuthReferenceId>sample string 2</PreAuthReferenceId>
  <SiteId>1</SiteId>
  <TokenType>sample string 6</TokenType>
  <TokenValue>sample string 7</TokenValue>
</InVoidSessionRequest>

Response Information

Resource Description

A <see cref="T:Radiant.Order.Shared.Contracts.ServiceEntities.Requests.VoidSessionResponse" /> instance when successful, an error code and description when an error occurs.

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.