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": "ce04abf3-a98c-4cea-a505-1e12ce837a9c",
"BranchIDF": "4d291755-7828-41b3-b0ad-eb1e80ec3fa3",
"TrackingOrderID": "sample string 3",
"PaymentGatewayIDF": "253426a2-6852-4d2d-8998-9271d4f69d4e",
"PaymentGatewaySettingIDF": "7f3fb14d-de29-484b-b58f-053bd33e1b04",
"CounterIDF": "ba6ff6bd-644d-4b9b-a1da-9d4c04a96101",
"CounterBalanceHistoryIDF": "a40e307f-4f5c-427c-8483-b9b53a02d1c5",
"RefundedAmount": 8.0,
"IsFullRefund": true,
"UserIDF": "6b8b873c-302a-43e8-8bfa-60df8ff9801f",
"ReasonForRefund": "sample string 11",
"RefundedReferenceID": "sample string 12",
"RequestData": "sample string 13",
"GeneralManagerUserID": "97447eec-137f-40d8-ac35-7021f01052eb",
"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>4d291755-7828-41b3-b0ad-eb1e80ec3fa3</BranchIDF> <CounterBalanceHistoryIDF>a40e307f-4f5c-427c-8483-b9b53a02d1c5</CounterBalanceHistoryIDF> <CounterIDF>ba6ff6bd-644d-4b9b-a1da-9d4c04a96101</CounterIDF> <DueAmountCash>1</DueAmountCash> <GeneralManagerUserID>97447eec-137f-40d8-ac35-7021f01052eb</GeneralManagerUserID> <IsFullRefund>true</IsFullRefund> <PayAmountCash>1</PayAmountCash> <PaymentGatewayIDF>253426a2-6852-4d2d-8998-9271d4f69d4e</PaymentGatewayIDF> <PaymentGatewaySettingIDF>7f3fb14d-de29-484b-b58f-053bd33e1b04</PaymentGatewaySettingIDF> <ReasonForRefund>sample string 11</ReasonForRefund> <RefundedAmount>8</RefundedAmount> <RefundedReferenceID>sample string 12</RefundedReferenceID> <RequestData>sample string 13</RequestData> <RestaurantIDF>ce04abf3-a98c-4cea-a505-1e12ce837a9c</RestaurantIDF> <ReturnAmountCash>1</ReturnAmountCash> <TrackingOrderID>sample string 3</TrackingOrderID> <UserIDF>6b8b873c-302a-43e8-8bfa-60df8ff9801f</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. |