POST api/SRAI/RefundPayment

Request Information

URI Parameters

None.

Body Parameters

RefundRequest
NameDescriptionTypeAdditional information
ChargeId

string

None.

ProviderId

integer

None.

RefundAmount

decimal number

None.

Reason

string

None.

RequestedBy

string

None.

RefundId

string

None.

Currency

string

None.

RefundStatus

string

None.

FailureReason

string

None.

serializedRefund

string

None.

PlanId

integer

None.

IsFullRefund

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "chargeId": "sample string 1",
  "providerId": 2,
  "refundAmount": 1.0,
  "reason": "sample string 3",
  "requestedBy": "sample string 4",
  "refundId": "sample string 5",
  "currency": "sample string 6",
  "refundStatus": "sample string 7",
  "failureReason": "sample string 8",
  "serializedRefund": "sample string 9",
  "planId": 10,
  "isFullRefund": true
}

application/xml, text/xml

Sample:
<RefundRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ScribingSoftware.Model.DTO">
  <ChargeId>sample string 1</ChargeId>
  <Currency>sample string 6</Currency>
  <FailureReason>sample string 8</FailureReason>
  <IsFullRefund>true</IsFullRefund>
  <PlanId>10</PlanId>
  <ProviderId>2</ProviderId>
  <Reason>sample string 3</Reason>
  <RefundAmount>1</RefundAmount>
  <RefundId>sample string 5</RefundId>
  <RefundStatus>sample string 7</RefundStatus>
  <RequestedBy>sample string 4</RequestedBy>
  <serializedRefund>sample string 9</serializedRefund>
</RefundRequest>

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 'RefundRequest'.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

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

Sample:

Sample not available.