UserHistory-GetHistory-v3: Difference between revisions
m (Added link to error codes section for this endpoint, made output properties more accurate.) |
|||
Line 53: | Line 53: | ||
== Output properties == | == Output properties == | ||
{{api_output_table_header}} | The response object contains an array named <code>UserHistory</code>, each element of the array is an object of the following structure:{{api_output_table_header}} | ||
|- | |- | ||
| Id || Guid || The identifier of the history item. | | Id || Guid || The identifier of the history item. | ||
Line 81: | Line 81: | ||
|- | |- | ||
|} | |}To find out which errors this endpoint can produce, visit the [[Error codes notifications#Possible error responses for getting user history (v3)|Error codes]] page. |
Latest revision as of 14:07, 2 February 2024
Barion API: transaction history
GET | /v3/UserHistory/GetHistory |
---|
The /v3/UserHistory/GetHistory
API endpoint is used to query the transaction history from the Barion system for the authenticated wallet. The /v3/TransactionHistory/GetDetail endpoint can be used to query the details of the history item.
Prerequisites before use:
Authentication
Input properties
The input properties should be defined in the query string.
Property name | Property type | Limitations and constraints | Description |
---|---|---|---|
LastVisibleItemId | Guid |
|
The identifier of the oldest transaction. Only transactions before the defined transaction will be included in the response. |
LastRequestTime | DateTime |
|
The exact time of the last request. Only transactions after or at the defined request time will be included in the response. |
Limit | int |
|
The expected number of transactions in the response. |
Currency | string |
Accepted values:
|
The currency of the transaction. If the currency is defined, then only transactions in the same currency will be included in the response. |
Output properties
The response object contains an array named UserHistory
, each element of the array is an object of the following structure:
Property name | Property type | Description |
---|---|---|
Id | Guid | The identifier of the history item. |
Type | HistoryItemType | The type of the history item. |
HappenedAtUtc | DateTime | The exact time when the item happened. |
ConcurrencyOrder | int | The order of the transaction when more than one transaction happened at the same time. When only one transaction happened at a given timestamp, this value can be ignored. |
SourceAccount | UserHistoryParticipant | The user who initiated the transaction or from whom the money originated. |
TargetAccount | UserHistoryParticipant | 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. |
BalanceChangeType | BalanceChangeType | Indicates the direction of change regarding the account's available balance.
|
To find out which errors this endpoint can produce, visit the Error codes page.