POST api/Bonus/Check/Void

This API will allow the user to void a paid check by providing the check number and Rep associated to the check or by submitting just the payout transaction ID, which is a unique identifier for each paid check (payout transaction). Additional, the function will reset the check amount to back to zero when the void process is completed.

Request Information

URI Parameters

None.

Body Parameters

List of CheckInputViewModel

CheckInputViewModel
NameDescriptionTypeAdditional information
CheckNumber

The Check Number that user wants to void. To be used with RepDID.

 integer

None.
RepDID

The RepDID associated with the Check Number provided. To be used with CheckNumber.

 string

None.
Amount

decimal number

None.
TransactionId

integer

None.

Request Formats

application/xml, text/xml

Sample: 
<CheckInputViewModel>
  <CheckNumber>1</CheckNumber>
  <RepID>1</RepID>
  <RepDID>sample string 2</RepDID>
  <Amount>1</Amount>
  <TransactionId>3</TransactionId>
  <Message>sample string 4</Message>
</CheckInputViewModel>

application/json, text/json

Sample: 
{
  "CheckNumber": 1,
  "RepDID": "sample string 2",
  "Amount": 1.0,
  "TransactionId": 3
}

application/x-www-form-urlencoded

Sample:

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

Response Information

Resource Description

Success or Error message

IHttpActionResult

None.

Response Formats

application/xml, text/xml, application/json, text/json

Sample:

Sample not available.