Revision as of 13:11, 11 November 2022

Barion API: transaction history

GET	/v2/UserHistory/GetHistory

The /v2/UserHistory/GetHistory API endpoint is used to query the transaction history from the Barion system.

The input properties should be defined in the query string.

Property name	Property type	Limitations and constraints	Description
LastVisibleItemId	Guid	Optional	The identifier of the most recent transaction.
LastRequestTime	DateTime	Optional Universal Time Coordinated (UTC)	The exact time of the last request.
Limit	number	Optional If not defined the default value is 20 If the defined value is greater than 20 the default value will be used	The expected number of transactions in the response.
Currency	string	Optional Required length: 3 characters Accepted values: "CZK" (Czech crown) "EUR" (Euro) "HUF" (Hungarian forint) "USD" (U.S. dollar)	The currency of the payment. Must be supplied in ISO 4217 format. This affects all transactions included in the payment; it is not possible to define multiple transactions in different currencies.

Property name	Property type	Description
Id	Guid	The identifier of the transaction.
Type	TransactionType	The type of the transaction.
HappenedAtUtc	DateTime	The exact time when the transaction happened.
ConcurrencyOrder	int	The order of the transaction when more than one transaction happened at the same time. The default value is 0.
SourceAccount	UserHistoryAccount	The user who initiated the transaction or from whom the money originated.
TargetAccount	UserHistoryAccount	The user who will receive the amount of the transaction.
Amount	decimal	The amount of the transaction.
Currency	string	The 3-character ISO 4217 currency code of the payment.
Description	string	Description of the transaction. Max:640 characters.
IsInProgress	bool	This flag indicates that the transaction is not in the final state.

@@ Line 55: / Line 55: @@
 |-
-| Id || ||
+| Id || Guid || The identifier of the transaction.
 |-
-| Type || ||
+| Type || [[TransactionType]] || The type of the transaction.
 |-
-| HappenedAtUtc || ||
+| HappenedAtUtc || DateTime || The exact time when the transaction happened.
 |-
-| ConcurrencyOrder || ||
+| ConcurrencyOrder || int || The order of the transaction when more than one transaction happened at the same time. The default value is 0.
 |-
-| SourceAccount || ||
+| SourceAccount || [[UserHistoryAccount]] || The user who initiated the transaction or from whom the money originated.
 |-
-| TargetAccount || ||
+| TargetAccount || [[UserHistoryAccount]] || The user who will receive the amount of the transaction.
 |-
-| Amount || ||
+| Amount || decimal || The amount of the transaction.
 |-
-| Currency || ||
+| Currency || string || The 3-character ISO 4217 currency code of the payment.
 |-
-| Description || ||
+| Description || string || Description of the transaction. Max:640 characters.
 |-
-| IsInProgress || ||
+| IsInProgress || bool || This flag indicates that the transaction is not in the final state.
 |-
 |}