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 .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
Content-Type: application/json
Content-Length: length

{"TransId":0,"start":"\/Date(1638625149530+0300)\/","DeviceUUID":"String","APIKey":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"TransactionBrief":{"TransId":0,"StoreId":0,"StatementId":0,"BuyerId":0,"Status":0,"PaymentStatus":0,"BuyerName":"String","TransDate":"\/Date(-62135596800000-0000)\/","ApproveDate":"\/Date(-62135596800000-0000)\/","CancelDate":"\/Date(-62135596800000-0000)\/","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":"\/Date(-62135596800000-0000)\/","PaymentDate":"\/Date(-62135596800000-0000)\/","Amount":0}]},"Result":false,"ResMessage":"String","Error":{"ErrorYn":false,"ErrorCode":"String","ErrorDescription":"String"},"PageInfo":{"TotalRecordCount":0,"TotalPageCount":0,"CurrentPage":0}}