Cdn API - CPG Source

RefundRequest

Cdn.Api

The following routes are available for this service:
GET,POST	/RefundRequest

**RefundRequest** Parameters:
Name	Parameter	Data Type	Required
CustomerId	body	long	No
PaymentId	body	long	No
RefundAmount	body	decimal	No
RefundReason	body	string	No
IsSendEmail	body	bool	No

**BaseRequest<T>** Parameters:
Name	Parameter	Data Type	Required
Id	form	long?	No
OrderBy	form	string[]	No
OrderDirections	form	SortOrders[]	No

**RefundResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Data	form	List<RefundDto>	No

**BaseResponse** Parameters:
Name	Parameter	Data Type	Required
Total	form	int	No
OpCode	form	int	No
ErrorText	form	string	No
RequestTime	form	string	No
ResponseTime	form	string	No
TotalExecutionTime	form	string	No
CachedResponse	form	bool	No

**RefundDto** Parameters:
Name	Parameter	Data Type	Required
RefundAmount	form	decimal	No
RefundAmountDisplay	form	string	No
RefundDate	form	DateTime	No
RefundDateDisplay	form	string	No
RefundReason	form	string	No
CcProcessorRefunded	form	bool	No
PaymentId	form	long	No
CustomerId	form	long	No
CcTransactionLogId	form	long	No

**DtoBase** Parameters:
Name	Parameter	Data Type	Required
Id	form	long	No
Active	form	bool	No
LastMod	form	DateTime	No
LastModBy	form	string	No

**RefundResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Data	form	List<RefundDto>	No

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /RefundRequest HTTP/1.1 
Host: cdnapidev.greysheet.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<RefundRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cdn.Api.RequestObjects">
  <Id>0</Id>
  <OrderBy xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </OrderBy>
  <OrderDirections>
    <SortOrders>Asc</SortOrders>
  </OrderDirections>
  <CustomerId>0</CustomerId>
  <IsSendEmail>false</IsSendEmail>
  <PaymentId>0</PaymentId>
  <RefundAmount>0</RefundAmount>
  <RefundReason>String</RefundReason>
</RefundRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<RefundResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cdn.Api.ResponseObjects">
  <CachedResponse>false</CachedResponse>
  <ErrorText>String</ErrorText>
  <OpCode>0</OpCode>
  <RequestTime>String</RequestTime>
  <ResponseTime>String</ResponseTime>
  <Total>0</Total>
  <TotalExecutionTime>String</TotalExecutionTime>
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/Cdn.Api.Dto">
    <d2p1:RefundDto>
      <d2p1:_x003C_Active_x003E_k__BackingField>false</d2p1:_x003C_Active_x003E_k__BackingField>
      <d2p1:_x003C_Id_x003E_k__BackingField>0</d2p1:_x003C_Id_x003E_k__BackingField>
      <d2p1:_x003C_LastModBy_x003E_k__BackingField>String</d2p1:_x003C_LastModBy_x003E_k__BackingField>
      <d2p1:_x003C_LastMod_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_LastMod_x003E_k__BackingField>
      <d2p1:CcProcessorRefunded>false</d2p1:CcProcessorRefunded>
      <d2p1:CcTransactionLogId>0</d2p1:CcTransactionLogId>
      <d2p1:CustomerId>0</d2p1:CustomerId>
      <d2p1:PaymentId>0</d2p1:PaymentId>
      <d2p1:RefundAmount>0</d2p1:RefundAmount>
      <d2p1:RefundAmountDisplay>String</d2p1:RefundAmountDisplay>
      <d2p1:RefundDate>0001-01-01T00:00:00</d2p1:RefundDate>
      <d2p1:RefundDateDisplay>String</d2p1:RefundDateDisplay>
      <d2p1:RefundReason>String</d2p1:RefundReason>
    </d2p1:RefundDto>
  </Data>
</RefundResponse>