POST api/POSPayment/ProcessRefundV1
Request Information
URI Parameters
None.
Body Parameters
POSRefundRequestClassV1| Name | Description | Type | Additional information |
|---|---|---|---|
| RestaurantIDF | globally unique identifier |
None. |
|
| BranchIDF | globally unique identifier |
None. |
|
| TrackingOrderID | string |
None. |
|
| PaymentGatewayIDF | globally unique identifier |
None. |
|
| PaymentGatewaySettingIDF | globally unique identifier |
None. |
|
| CounterIDF | globally unique identifier |
None. |
|
| CounterBalanceHistoryIDF | globally unique identifier |
None. |
|
| RefundedAmount | decimal number |
None. |
|
| IsFullRefund | boolean |
None. |
|
| UserIDF | globally unique identifier |
None. |
|
| ReasonForRefund | string |
None. |
|
| RefundedReferenceID | string |
None. |
|
| RequestData | string |
None. |
|
| GeneralManagerUserID | globally unique identifier |
None. |
|
| PayAmountCash | decimal number |
None. |
|
| DueAmountCash | decimal number |
None. |
|
| ReturnAmountCash | decimal number |
None. |
Request Formats
application/json, text/json
Sample:
{
"RestaurantIDF": "43e7b059-4c01-4c3a-8aa0-3ac5fd0e595e",
"BranchIDF": "efbe5f13-84f1-4926-bfdb-acfb2f013273",
"TrackingOrderID": "sample string 3",
"PaymentGatewayIDF": "64121aa6-9e6b-4e8e-a874-b2d1e5ba56cd",
"PaymentGatewaySettingIDF": "1302ce6d-541c-40a2-8b6a-4be1702faab8",
"CounterIDF": "b574721f-37f7-40d5-bd1d-9cd9588690ee",
"CounterBalanceHistoryIDF": "a95d9aed-2cb3-430c-853a-cb68abf391e9",
"RefundedAmount": 8.0,
"IsFullRefund": true,
"UserIDF": "8a74254e-ad21-4b94-b1db-64afc2d9f26f",
"ReasonForRefund": "sample string 11",
"RefundedReferenceID": "sample string 12",
"RequestData": "sample string 13",
"GeneralManagerUserID": "93da829e-ad79-4b79-ae5a-406f24c7fa8b",
"PayAmountCash": 1.0,
"DueAmountCash": 1.0,
"ReturnAmountCash": 1.0
}
application/xml, text/xml
Sample:
<POSRefundRequestClassV1 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SQLClass"> <BranchIDF>efbe5f13-84f1-4926-bfdb-acfb2f013273</BranchIDF> <CounterBalanceHistoryIDF>a95d9aed-2cb3-430c-853a-cb68abf391e9</CounterBalanceHistoryIDF> <CounterIDF>b574721f-37f7-40d5-bd1d-9cd9588690ee</CounterIDF> <DueAmountCash>1</DueAmountCash> <GeneralManagerUserID>93da829e-ad79-4b79-ae5a-406f24c7fa8b</GeneralManagerUserID> <IsFullRefund>true</IsFullRefund> <PayAmountCash>1</PayAmountCash> <PaymentGatewayIDF>64121aa6-9e6b-4e8e-a874-b2d1e5ba56cd</PaymentGatewayIDF> <PaymentGatewaySettingIDF>1302ce6d-541c-40a2-8b6a-4be1702faab8</PaymentGatewaySettingIDF> <ReasonForRefund>sample string 11</ReasonForRefund> <RefundedAmount>8</RefundedAmount> <RefundedReferenceID>sample string 12</RefundedReferenceID> <RequestData>sample string 13</RequestData> <RestaurantIDF>43e7b059-4c01-4c3a-8aa0-3ac5fd0e595e</RestaurantIDF> <ReturnAmountCash>1</ReturnAmountCash> <TrackingOrderID>sample string 3</TrackingOrderID> <UserIDF>8a74254e-ad21-4b94-b1db-64afc2d9f26f</UserIDF> </POSRefundRequestClassV1>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
HttpResponseMessage| Name | Description | 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. |