UserHistory-GetHistory-v2: Difference between revisions
Jump to navigation
Jump to search
Line 71: | Line 71: | ||
|- | |- | ||
| SourceAccount || [[ | | SourceAccount || [[UserHistoryParticipant]] || The user who initiated the transaction or from whom the money originated. | ||
|- | |- | ||
| TargetAccount || [[ | | TargetAccount || [[UserHistoryParticipant]] || The user who will receive the amount of the transaction. | ||
|- | |- |
Revision as of 13:17, 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.
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. |
LastRequestTime | DateTime |
|
The exact time of the last request. |
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 | 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 | 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. |