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": "90e6fb12-617a-418b-af79-67020f6be746",
"BranchIDF": "701d9bbd-55ae-421a-86e5-60a00bd5c85f",
"TrackingOrderID": "sample string 3",
"PaymentGatewayIDF": "cef8c365-8c3e-4d3b-96b5-fbd0b77d6e4f",
"PaymentGatewaySettingIDF": "9c3d1314-4793-49a9-8cbf-2b0630342e25",
"CounterIDF": "83289cd6-029e-4b0c-a820-4eb97841082e",
"CounterBalanceHistoryIDF": "4f397b67-ddb7-4b79-872f-3f27f8c24757",
"UserIDF": "61ed95e9-92c0-408f-aa0f-c9b561f0702a",
"ReasonForRefund": "sample string 9",
"RefundedReferenceID": "sample string 10",
"RequestData": "sample string 11",
"GeneralManagerUserID": "5fabf87c-7808-4cfe-839b-f8f75c6b85fd",
"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>701d9bbd-55ae-421a-86e5-60a00bd5c85f</BranchIDF> <CounterBalanceHistoryIDF>4f397b67-ddb7-4b79-872f-3f27f8c24757</CounterBalanceHistoryIDF> <CounterIDF>83289cd6-029e-4b0c-a820-4eb97841082e</CounterIDF> <DueAmountCash>1</DueAmountCash> <GeneralManagerUserID>5fabf87c-7808-4cfe-839b-f8f75c6b85fd</GeneralManagerUserID> <PayAmountCash>1</PayAmountCash> <PaymentGatewayIDF>cef8c365-8c3e-4d3b-96b5-fbd0b77d6e4f</PaymentGatewayIDF> <PaymentGatewaySettingIDF>9c3d1314-4793-49a9-8cbf-2b0630342e25</PaymentGatewaySettingIDF> <ReasonForRefund>sample string 9</ReasonForRefund> <RefundedReferenceID>sample string 10</RefundedReferenceID> <RequestData>sample string 11</RequestData> <RestaurantIDF>90e6fb12-617a-418b-af79-67020f6be746</RestaurantIDF> <ReturnAmountCash>1</ReturnAmountCash> <TrackingOrderID>sample string 3</TrackingOrderID> <UserIDF>61ed95e9-92c0-408f-aa0f-c9b561f0702a</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. |