Cdn API

<back to all web services

RefundRequest

Cdn.Api

The following routes are available for this service:
GET,POST/RefundRequest
RefundRequest Parameters:
NameParameterData TypeRequiredDescription
CustomerIdbodylongNo
PaymentIdbodylongNo
RefundAmountbodydecimalNo
RefundReasonbodystringNo
IsSendEmailbodyboolNo
BaseRequest<T> Parameters:
NameParameterData TypeRequiredDescription
Idformlong?No
OrderByformstring[]No
OrderDirectionsformSortOrders[]No
RefundResponse Parameters:
NameParameterData TypeRequiredDescription
DataformList<RefundDto>No
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
TotalformintNo
OpCodeformintNo
ErrorTextformstringNo
RequestTimeformstringNo
ResponseTimeformstringNo
TotalExecutionTimeformstringNo
CachedResponseformboolNo
RefundDto Parameters:
NameParameterData TypeRequiredDescription
RefundAmountformdecimalNo
RefundAmountDisplayformstringNo
RefundDateformDateTimeNo
RefundDateDisplayformstringNo
RefundReasonformstringNo
CcProcessorRefundedformboolNo
PaymentIdformlongNo
CustomerIdformlongNo
CcTransactionLogIdformlongNo
DtoBase Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
ActiveformboolNo
LastModformDateTimeNo
LastModByformstringNo
RefundResponse Parameters:
NameParameterData TypeRequiredDescription
DataformList<RefundDto>No

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

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	CustomerId: 0,
	PaymentId: 0,
	RefundAmount: 0,
	RefundReason: String,
	IsSendEmail: False,
	Id: 0,
	OrderBy: 
	[
		String
	],
	OrderDirections: 
	[
		Asc
	]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Data: 
	[
		{
			RefundAmount: 0,
			RefundAmountDisplay: String,
			RefundDate: 0001-01-01,
			RefundDateDisplay: String,
			RefundReason: String,
			CcProcessorRefunded: False,
			PaymentId: 0,
			CustomerId: 0,
			CcTransactionLogId: 0,
			Id: 0,
			Active: False,
			LastMod: 0001-01-01,
			LastModBy: String
		}
	],
	Total: 0,
	OpCode: 0,
	ErrorText: String,
	RequestTime: String,
	ResponseTime: String,
	TotalExecutionTime: String,
	CachedResponse: False
}