Needio.Services

<back to all web services

GetTransactionBriefRequest

Requires Authentication
Required role:Approved
The following routes are available for this service:
All Verbs/GetMyTransactionBrief/
GetTransactionBriefRequest Parameters:
NameParameterData TypeRequiredDescription
TransIdqueryintNo
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
startformDateTimeNo
DeviceUUIDformstringNo
APIKeyformstringNo
GetTransactionBriefResponse Parameters:
NameParameterData TypeRequiredDescription
TransactionBriefformTransactionBriefDetailDTONo
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformboolNo
ResMessageformstringNo
ErrorformErrorNo
PageInfoformBasePageInfoNo
Error Parameters:
NameParameterData TypeRequiredDescription
ErrorYnformboolNo
ErrorCodeformstringNo
ErrorDescriptionformstringNo
BasePageInfo Parameters:
NameParameterData TypeRequiredDescription
TotalRecordCountformintNo
TotalPageCountformintNo
CurrentPageformintNo
TransactionBriefDTO Parameters:
NameParameterData TypeRequiredDescription
TransIdformintNo
StoreIdformintNo
StatementIdformintNo
BuyerIdformintNo
StatusformTransactionStatusesNo
PaymentStatusformPaymentStatusesNo
BuyerNameformstringNo
TransDateformDateTimeNo
ApproveDateformDateTimeNo
CancelDateformDateTimeNo
SaleAmountformdecimalNo
RefundTotalformdecimalNo
NetAmountformdecimalNo
MerchantPayoutformdecimalNo
MerchantPayoutCCAmountformdecimalNo
MerchantPayoutOtherCostAmountformdecimalNo
CommisionAmountformdecimalNo
CargoAmountformdecimalNo
OtherCostsAmountformdecimalNo
TransactionSummariesformList<TransactionSummaryDTO>No
TransactionStatuses Enum:
NameValue
Draft0
InProgress1
SalerApproved11
SalerRejected12
BuyerCancelled13
SalerStartShippment16
ShipmentStarted17
ShipmentCanceled19
BuyerApproved21
BuyerRejected22
AdminApproved41
AdminRejected42
Completed101
ReturnedItem102
SalerFirstNotification201
SalerSecondNotification202
BuyerFirstNotification203
BuyerSecondNotification204
PaymentStatuses Enum:
NameValue
Unknown0
InProgress1
Approved2
Refunded3
Cancelled4
TransactionSummaryDTO Parameters:
NameParameterData TypeRequiredDescription
AccountTransactionIdformintNo
TransIdformintNo
PaymentIdformint?No
StatementIdformintNo
AccountIdformintNo
AccountNameformstringNo
AccountTransactionTypeIdformshortNo
AccountTransactionTypeNameformstringNo
DescriptionformstringNo
TransactionDateformDateTimeNo
PaymentDateformDateTimeNo
AmountformdecimalNo
GetTransactionBriefResponse Parameters:
NameParameterData TypeRequiredDescription
TransactionBriefformTransactionBriefDetailDTONo

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 /GetMyTransactionBrief/ HTTP/1.1 
Host: baseservices.needion.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	TransId: 0,
	start: 2021-12-01T09:08:48.1187198+03:00,
	DeviceUUID: String,
	APIKey: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	TransactionBrief: 
	{
		TransId: 0,
		StoreId: 0,
		StatementId: 0,
		BuyerId: 0,
		Status: 0,
		PaymentStatus: 0,
		BuyerName: String,
		TransDate: 0001-01-01,
		ApproveDate: 0001-01-01,
		CancelDate: 0001-01-01,
		SaleAmount: 0,
		RefundTotal: 0,
		NetAmount: 0,
		MerchantPayout: 0,
		MerchantPayoutCCAmount: 0,
		MerchantPayoutOtherCostAmount: 0,
		CommisionAmount: 0,
		CargoAmount: 0,
		OtherCostsAmount: 0,
		TransactionSummaries: 
		[
			{
				AccountTransactionId: 0,
				TransId: 0,
				PaymentId: 0,
				StatementId: 0,
				AccountId: 0,
				AccountName: String,
				AccountTransactionTypeId: 0,
				AccountTransactionTypeName: String,
				Description: String,
				TransactionDate: 0001-01-01,
				PaymentDate: 0001-01-01,
				Amount: 0
			}
		]
	},
	Result: False,
	ResMessage: String,
	Error: 
	{
		ErrorYn: False,
		ErrorCode: String,
		ErrorDescription: String
	},
	PageInfo: 
	{
		TotalRecordCount: 0,
		TotalPageCount: 0,
		CurrentPage: 0
	}
}