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": "8c96c821-0dc6-4786-9a1e-a7f291c08068",
"BranchIDF": "9221283b-dd6b-43d4-ac38-b7ba7f5780d1",
"TrackingOrderID": "sample string 3",
"PaymentGatewayIDF": "8a896a27-4a8a-44a5-8080-c4dfa1f5f4a2",
"PaymentGatewaySettingIDF": "961336b1-af69-4086-83ed-4bc89fb0deb3",
"CounterIDF": "cdfe5d17-422c-4d67-ab5c-0cbf836ed1eb",
"CounterBalanceHistoryIDF": "8f1d5235-5123-42eb-b721-83116019f50f",
"UserIDF": "291fe9d6-b32b-469a-a277-f46d41220aaf",
"ReasonForRefund": "sample string 9",
"RefundedReferenceID": "sample string 10",
"RequestData": "sample string 11",
"GeneralManagerUserID": "dbce35a2-bbec-4e71-b865-9c6c9673393e",
"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>9221283b-dd6b-43d4-ac38-b7ba7f5780d1</BranchIDF> <CounterBalanceHistoryIDF>8f1d5235-5123-42eb-b721-83116019f50f</CounterBalanceHistoryIDF> <CounterIDF>cdfe5d17-422c-4d67-ab5c-0cbf836ed1eb</CounterIDF> <DueAmountCash>1</DueAmountCash> <GeneralManagerUserID>dbce35a2-bbec-4e71-b865-9c6c9673393e</GeneralManagerUserID> <PayAmountCash>1</PayAmountCash> <PaymentGatewayIDF>8a896a27-4a8a-44a5-8080-c4dfa1f5f4a2</PaymentGatewayIDF> <PaymentGatewaySettingIDF>961336b1-af69-4086-83ed-4bc89fb0deb3</PaymentGatewaySettingIDF> <ReasonForRefund>sample string 9</ReasonForRefund> <RefundedReferenceID>sample string 10</RefundedReferenceID> <RequestData>sample string 11</RequestData> <RestaurantIDF>8c96c821-0dc6-4786-9a1e-a7f291c08068</RestaurantIDF> <ReturnAmountCash>1</ReturnAmountCash> <TrackingOrderID>sample string 3</TrackingOrderID> <UserIDF>291fe9d6-b32b-469a-a277-f46d41220aaf</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. |