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": "4250a51d-5518-4371-bec7-ab9f5b35be8d",
"BranchIDF": "3443d623-61fe-472b-a083-f9f5b8790e1b",
"TrackingOrderID": "sample string 3",
"PaymentGatewayIDF": "fa012b35-1d48-4ed0-a959-a223e7ea5811",
"PaymentGatewaySettingIDF": "7181feba-f3d2-45bd-a53a-3b876e34411c",
"CounterIDF": "4c788f6e-be03-4948-b14e-74ca6cc6f8fe",
"CounterBalanceHistoryIDF": "b09c672d-edd2-4cf2-94c2-4c892a354fc3",
"UserIDF": "7a7eb0ad-42d3-45da-a350-588b1ddc0b16",
"ReasonForRefund": "sample string 9",
"RefundedReferenceID": "sample string 10",
"RequestData": "sample string 11",
"GeneralManagerUserID": "eadb87da-10f5-426d-ad72-53351a1a8424",
"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>3443d623-61fe-472b-a083-f9f5b8790e1b</BranchIDF> <CounterBalanceHistoryIDF>b09c672d-edd2-4cf2-94c2-4c892a354fc3</CounterBalanceHistoryIDF> <CounterIDF>4c788f6e-be03-4948-b14e-74ca6cc6f8fe</CounterIDF> <DueAmountCash>1</DueAmountCash> <GeneralManagerUserID>eadb87da-10f5-426d-ad72-53351a1a8424</GeneralManagerUserID> <PayAmountCash>1</PayAmountCash> <PaymentGatewayIDF>fa012b35-1d48-4ed0-a959-a223e7ea5811</PaymentGatewayIDF> <PaymentGatewaySettingIDF>7181feba-f3d2-45bd-a53a-3b876e34411c</PaymentGatewaySettingIDF> <ReasonForRefund>sample string 9</ReasonForRefund> <RefundedReferenceID>sample string 10</RefundedReferenceID> <RequestData>sample string 11</RequestData> <RestaurantIDF>4250a51d-5518-4371-bec7-ab9f5b35be8d</RestaurantIDF> <ReturnAmountCash>1</ReturnAmountCash> <TrackingOrderID>sample string 3</TrackingOrderID> <UserIDF>7a7eb0ad-42d3-45da-a350-588b1ddc0b16</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. |