POST api/Payment/Reverse

Request Information

URI Parameters

None.

Body Parameters

PaymentReverseVM
NameDescriptionTypeAdditional information
PaymentID

integer

None.

ReverseComment

string

None.

ReversalReasonID

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "PaymentID": 1,
  "ReverseComment": "sample string 2",
  "ReversalReasonID": 1
}

application/xml, text/xml

Sample:
<PaymentReverseVM xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.ViewModels.Payment">
  <PaymentID>1</PaymentID>
  <ReversalReasonID>1</ReversalReasonID>
  <ReverseComment>sample string 2</ReverseComment>
</PaymentReverseVM>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

PaymentReverseResponseVM
NameDescriptionTypeAdditional information
ReversalPaymentID

integer

None.

Success

boolean

None.

ErrorMessage

string

None.

Response

IResponse

None.

Response Formats

application/json, text/json

Sample:
{
  "ReversalPaymentID": 1,
  "Success": true,
  "ErrorMessage": "sample string 2",
  "Response": null
}

application/xml, text/xml

Sample:
<PaymentReverseResponseVM xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.ViewModels.Payment">
  <Response i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.ViewModels" />
  <ErrorMessage>sample string 2</ErrorMessage>
  <ReversalPaymentID>1</ReversalPaymentID>
  <Success>true</Success>
</PaymentReverseResponseVM>