POST api/POSPayment/ProcessRefund
Request Information
URI Parameters
None.
Body Parameters
POSRefundRequestClass| 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. |
|
| 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": "89c58d20-ba44-402a-af5b-c17b6c75a001",
"BranchIDF": "e88b01be-c29b-412e-b2ab-aa804e2b3f85",
"TrackingOrderID": "sample string 3",
"PaymentGatewayIDF": "287eaa40-51d9-49b9-9c69-fb10568d7a6b",
"PaymentGatewaySettingIDF": "5caadf26-d323-4a38-a1c8-b32dc79b8230",
"CounterIDF": "3f64018c-e7fc-4900-848f-25aeb5272a83",
"CounterBalanceHistoryIDF": "c853fccc-9f45-404d-ba8d-59334bfac14f",
"UserIDF": "8da7c90a-7e74-40a4-958f-eebf2fc70400",
"ReasonForRefund": "sample string 9",
"RefundedReferenceID": "sample string 10",
"RequestData": "sample string 11",
"GeneralManagerUserID": "0b900fc6-44dd-4afc-9dcb-5a3618afbe9c",
"PayAmountCash": 1.0,
"DueAmountCash": 1.0,
"ReturnAmountCash": 1.0
}
application/xml, text/xml
Sample:
<POSRefundRequestClass xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SQLClass"> <BranchIDF>e88b01be-c29b-412e-b2ab-aa804e2b3f85</BranchIDF> <CounterBalanceHistoryIDF>c853fccc-9f45-404d-ba8d-59334bfac14f</CounterBalanceHistoryIDF> <CounterIDF>3f64018c-e7fc-4900-848f-25aeb5272a83</CounterIDF> <DueAmountCash>1</DueAmountCash> <GeneralManagerUserID>0b900fc6-44dd-4afc-9dcb-5a3618afbe9c</GeneralManagerUserID> <PayAmountCash>1</PayAmountCash> <PaymentGatewayIDF>287eaa40-51d9-49b9-9c69-fb10568d7a6b</PaymentGatewayIDF> <PaymentGatewaySettingIDF>5caadf26-d323-4a38-a1c8-b32dc79b8230</PaymentGatewaySettingIDF> <ReasonForRefund>sample string 9</ReasonForRefund> <RefundedReferenceID>sample string 10</RefundedReferenceID> <RequestData>sample string 11</RequestData> <RestaurantIDF>89c58d20-ba44-402a-af5b-c17b6c75a001</RestaurantIDF> <ReturnAmountCash>1</ReturnAmountCash> <TrackingOrderID>sample string 3</TrackingOrderID> <UserIDF>8da7c90a-7e74-40a4-958f-eebf2fc70400</UserIDF> </POSRefundRequestClass>
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. |