POST api/v2/payment/{paymentId}/void

Request Information

URI Parameters

Name	Description	Type	Additional information
paymentId		integer	Required

Body Parameters

PaymentVoid

Name	Description	Type	Additional information
Reason		string	None.
PostingDate		date	None.

Request Formats

application/json, text/json

Sample:

{
  "Reason": "sample string 1",
  "PostingDate": "2025-05-20T10:12:25.1922464-07:00"
}

application/xml, text/xml

Sample:

<PaymentVoid xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CaliberAPI">
  <PostingDate>2025-05-20T10:12:25.1922464-07:00</PostingDate>
  <Reason>sample string 1</Reason>
</PaymentVoid>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'PaymentVoid'.

Response Information

Resource Description

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.