POST fp/refundOrVoid
Request Information
URI Parameters
None.
Body Parameters
RefundVoidRequestName | Description | Type | Additional information |
---|---|---|---|
orderRequestId | string |
None. |
|
purchaseTotals | PurchaseTotals |
None. |
|
ccCreditService | CcCreditService |
None. |
|
voidService | VoidService |
None. |
|
clientMetadata | ClientMetadata |
None. |
|
invoiceHeader | InvoiceHeader |
None. |
|
merchantReferenceCode | string |
None. |
|
comments | string |
None. |
|
billTo | BillTo |
None. |
|
esKey | string |
None. |
|
storeId | string |
None. |
|
terminalId | string |
None. |
|
apiEndPoint | string |
None. |
Request Formats
application/json, text/json
Sample:
{ "orderRequestId": "sample string 1", "purchaseTotals": { "taxDetail": { "type": "sample string 1", "amount": "sample string 2" }, "chargeAmount": "sample string 1", "taxTotal": "sample string 2", "discountTotal": "sample string 3", "tipAmount": "sample string 4", "dutyTotal": "sample string 5", "freightTotal": "sample string 6", "debitSurcharge": "sample string 7", "cashBackAmount": "sample string 8", "overtender": "sample string 9", "invoiceTotal": "sample string 10", "serviceCharge": "sample string 11", "eidAmount": "sample string 12" }, "ccCreditService": { "run": "sample string 1", "transType": "sample string 2" }, "voidService": { "taxDetail": { "type": "sample string 1", "amount": "sample string 2" }, "reason": "sample string 1", "offline": "sample string 2", "offlineCode": "sample string 3", "run": "sample string 4" }, "clientMetadata": { "sellingSystemName": "sample string 1", "sellingSystemVersion": "sample string 2", "sellingMiddlewareName": "sample string 3", "sellingMiddlewareVersion": "sample string 4" }, "invoiceHeader": { "purchaserCode": "sample string 1", "invoiceNumber": "sample string 2", "invoiceDate": "sample string 3", "merchantDescriptor": "sample string 4", "merchantDescriptorContact": "sample string 5", "merchantDescriptorUrl": "sample string 6", "purchaserOrderDate": "sample string 7", "goodsIndicator": "sample string 8", "customerPO": "sample string 9", "productCodeStandard": "sample string 10", "eidIndicator": "sample string 11" }, "merchantReferenceCode": "sample string 2", "comments": "sample string 3", "billTo": { "ipAddress": "sample string 1", "customerID": "sample string 2", "dateOfBirth": "sample string 3", "driversLicenseNumber": "sample string 4", "driversLicenseState": "sample string 5", "company": "sample string 6", "title": "sample string 7", "firstName": "sample string 8", "middleName": "sample string 9", "lastName": "sample string 10", "suffix": "sample string 11", "street1": "sample string 12", "street2": "sample string 13", "street3": "sample string 14", "street4": "sample string 15", "city": "sample string 16", "state": "sample string 17", "postalCode": "sample string 18", "country": "sample string 19", "phoneNumber": "sample string 20", "faxNumber": "sample string 21", "email": "sample string 22", "ssn": "sample string 23" }, "esKey": "sample string 4", "storeId": "sample string 5", "terminalId": "sample string 6", "apiEndPoint": "sample string 7" }
application/xml, text/xml
Sample:
<RefundVoidRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NCR.FreedomPay.DTO.Models"> <apiEndPoint>sample string 7</apiEndPoint> <esKey>sample string 4</esKey> <storeId>sample string 5</storeId> <terminalId>sample string 6</terminalId> <billTo xmlns:d2p1="http://schemas.datacontract.org/2004/07/NCR.FreedomPay.DTO.Types.RequestMessage"> <d2p1:city>sample string 16</d2p1:city> <d2p1:company>sample string 6</d2p1:company> <d2p1:country>sample string 19</d2p1:country> <d2p1:email>sample string 22</d2p1:email> <d2p1:faxNumber>sample string 21</d2p1:faxNumber> <d2p1:firstName>sample string 8</d2p1:firstName> <d2p1:lastName>sample string 10</d2p1:lastName> <d2p1:middleName>sample string 9</d2p1:middleName> <d2p1:phoneNumber>sample string 20</d2p1:phoneNumber> <d2p1:postalCode>sample string 18</d2p1:postalCode> <d2p1:ssn>sample string 23</d2p1:ssn> <d2p1:state>sample string 17</d2p1:state> <d2p1:street1>sample string 12</d2p1:street1> <d2p1:street2>sample string 13</d2p1:street2> <d2p1:street3>sample string 14</d2p1:street3> <d2p1:street4>sample string 15</d2p1:street4> <d2p1:suffix>sample string 11</d2p1:suffix> <d2p1:title>sample string 7</d2p1:title> <d2p1:customerID>sample string 2</d2p1:customerID> <d2p1:dateOfBirth>sample string 3</d2p1:dateOfBirth> <d2p1:driversLicenseNumber>sample string 4</d2p1:driversLicenseNumber> <d2p1:driversLicenseState>sample string 5</d2p1:driversLicenseState> <d2p1:ipAddress>sample string 1</d2p1:ipAddress> </billTo> <ccCreditService xmlns:d2p1="http://schemas.datacontract.org/2004/07/NCR.FreedomPay.DTO.Types.RequestMessage"> <d2p1:run>sample string 1</d2p1:run> <d2p1:transType>sample string 2</d2p1:transType> </ccCreditService> <clientMetadata xmlns:d2p1="http://schemas.datacontract.org/2004/07/NCR.FreedomPay.DTO.Types.RequestMessage"> <d2p1:sellingMiddlewareName>sample string 3</d2p1:sellingMiddlewareName> <d2p1:sellingMiddlewareVersion>sample string 4</d2p1:sellingMiddlewareVersion> <d2p1:sellingSystemName>sample string 1</d2p1:sellingSystemName> <d2p1:sellingSystemVersion>sample string 2</d2p1:sellingSystemVersion> </clientMetadata> <comments>sample string 3</comments> <invoiceHeader xmlns:d2p1="http://schemas.datacontract.org/2004/07/NCR.FreedomPay.DTO.Types.RequestMessage"> <d2p1:customerPO>sample string 9</d2p1:customerPO> <d2p1:eidIndicator>sample string 11</d2p1:eidIndicator> <d2p1:goodsIndicator>sample string 8</d2p1:goodsIndicator> <d2p1:invoiceDate>sample string 3</d2p1:invoiceDate> <d2p1:invoiceNumber>sample string 2</d2p1:invoiceNumber> <d2p1:merchantDescriptor>sample string 4</d2p1:merchantDescriptor> <d2p1:merchantDescriptorContact>sample string 5</d2p1:merchantDescriptorContact> <d2p1:merchantDescriptorUrl>sample string 6</d2p1:merchantDescriptorUrl> <d2p1:productCodeStandard>sample string 10</d2p1:productCodeStandard> <d2p1:purchaserCode>sample string 1</d2p1:purchaserCode> <d2p1:purchaserOrderDate>sample string 7</d2p1:purchaserOrderDate> </invoiceHeader> <merchantReferenceCode>sample string 2</merchantReferenceCode> <orderRequestId>sample string 1</orderRequestId> <purchaseTotals xmlns:d2p1="http://schemas.datacontract.org/2004/07/NCR.FreedomPay.DTO.Types.RequestMessage"> <d2p1:cashBackAmount>sample string 8</d2p1:cashBackAmount> <d2p1:chargeAmount>sample string 1</d2p1:chargeAmount> <d2p1:debitSurcharge>sample string 7</d2p1:debitSurcharge> <d2p1:discountTotal>sample string 3</d2p1:discountTotal> <d2p1:dutyTotal>sample string 5</d2p1:dutyTotal> <d2p1:eidAmount>sample string 12</d2p1:eidAmount> <d2p1:freightTotal>sample string 6</d2p1:freightTotal> <d2p1:invoiceTotal>sample string 10</d2p1:invoiceTotal> <d2p1:overtender>sample string 9</d2p1:overtender> <d2p1:serviceCharge>sample string 11</d2p1:serviceCharge> <d2p1:taxDetail> <d2p1:amount>sample string 2</d2p1:amount> <d2p1:type>sample string 1</d2p1:type> </d2p1:taxDetail> <d2p1:taxTotal>sample string 2</d2p1:taxTotal> <d2p1:tipAmount>sample string 4</d2p1:tipAmount> </purchaseTotals> <voidService xmlns:d2p1="http://schemas.datacontract.org/2004/07/NCR.FreedomPay.DTO.Types.RequestMessage"> <d2p1:offline>sample string 2</d2p1:offline> <d2p1:offlineCode>sample string 3</d2p1:offlineCode> <d2p1:reason>sample string 1</d2p1:reason> <d2p1:run>sample string 4</d2p1:run> <d2p1:taxDetail> <d2p1:amount>sample string 2</d2p1:amount> <d2p1:type>sample string 1</d2p1:type> </d2p1:taxDetail> </voidService> </RefundVoidRequest>
Response Information
Resource Description
HttpResponseMessageName | 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. |