UserHistory-GetHistory-v2: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
|||
| Line 8: | Line 8: | ||
}} | }} | ||
The <code>/v2/UserHistory/GetHistory</code> API endpoint is used to query the transaction history from the Barion system. | The <code>/v2/UserHistory/GetHistory</code> API endpoint is used to query the transaction history from the Barion system. | ||
{{NotificationBox|title=IMPORTANT|text=This API should not be used for reconciliation, use the [[Statement-Download-v2 | statement API]] instead.|color=#FF7A3D}} | |||
{{NotificationBox|title=IMPORTANT|text=The item type of history elements does not correlate with the type of transactions exported from GUI or downloaded from [[Statement-Download-v2 | statement API]].|color=#FF7A3D}} | |||
== Input properties == | == Input properties == | ||
Revision as of 10:43, 14 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.
IMPORTANT
This API should not be used for reconciliation, use the statement API instead.
IMPORTANT
The item type of history elements does not correlate with the type of transactions exported from GUI or downloaded from statement API.
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 most recent transaction. Only transactions after the defined transaction will be included in the response. |
| LastRequestTime | DateTime |
|
The exact time of the last request. Only transactions after the defined request time will be included in the response. |
| Limit | number |
|
The expected number of transactions in the response. |
| Currency | string |
Accepted values:
|
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. |
Output properties
| Property name | Property type | Description |
|---|---|---|
| Id | Guid | The identifier of the transaction. |
| Type | HistoryItemType | 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 | 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. |