UserHistory-GetHistory-v3: Difference between revisions

From Barion Documentation
Jump to navigation Jump to search
VisualWikitext
m (Added link to error codes section for this endpoint, made output properties more accurate.)
 
(4 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{PageTitle|title=Barion API: transaction history}}
{{PageTitle|title=Barion API: transaction history}}
{{TableOfContents}}
{{TableOfContents}}
{{api_callmethod
{{api_callmethod
|method=GET
|method=GET
|uri=/v3/UserHistory/GetHistory
|uri=/v3/UserHistory/GetHistory
}}
}}
 
The <code>/v3/UserHistory/GetHistory</code> API endpoint is used to query the transaction history from the Barion system for the authenticated wallet. The [[TransactionHistory-GetDetail-v3|/v3/TransactionHistory/GetDetail]] endpoint can be used to query the details of the history item.
The <code>/v3/UserHistory/GetHistory</code> API endpoint is used to query the transaction history from the Barion system for the authenticated wallet.


Prerequisites before use:
Prerequisites before use:
* [[Creating_an_account|Creating an account in Barion]]
* [[Creating_an_account|Creating an account in Barion]]
* [[Calling_the_API|Calling the Barion API]]
* [[Calling_the_API|Calling the Barion API]]
{{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=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 through GUI or downloaded with[[Statement-Download-v2 | statement API]].|color=#FF7A3D}}
{{NotificationBox|title=IMPORTANT|text=The item type of history elements does not correlate with the type of transactions exported through GUI or downloaded with[[Statement-Download-v2 | statement API]].|color=#FF7A3D}}
== Authentication ==
== Authentication ==
[[Barion Wallet Authentication]]
[[Barion Wallet Authentication]]
== Input properties ==
== Input properties ==
The input properties should be defined in the query string.
The input properties should be defined in the query string.
{{api_input_table_header}}
{{api_input_table_header}}
|-
|-
Line 37: Line 29:
*Universal Time Coordinated (UTC)
*Universal Time Coordinated (UTC)
||  
||  
The exact time of the last request. Only transactions after the defined request time will be included in the response.
The exact time of the last request. Only transactions after or at the defined request time will be included in the response.
|-
|-


Line 61: Line 53:


== Output properties ==
== Output properties ==
 
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}}
{{api_output_table_header}}
|-
|-
| Id || Guid || The identifier of the transaction.
| Id || Guid || The identifier of the history item.
|-
|-
| Type || [[HistoryItemType]] || The type of the transaction.
| Type || [[HistoryItemType]] || The type of the history item.
|-
|-
| HappenedAtUtc || DateTime || The exact time when the transaction happened.
| 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.
| 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.
Line 88: Line 79:
* '''Credit''': the account's balance has increased after the transaction
* '''Credit''': the account's balance has increased after the transaction
* '''Debit''': the account's balance has decreased after the transaction<br>
* '''Debit''': the account's balance has decreased after the transaction<br>
''Note: this property is only available in the TEST environment at the moment''
 
|-
|-
|}
|}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:

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 through GUI or downloaded with statement API.

Authentication

Barion Wallet Authentication

Input properties

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 oldest transaction. Only transactions before the defined transaction will be included in the response.

LastRequestTime DateTime
  • Optional
  • Universal Time Coordinated (UTC)

The exact time of the last request. Only transactions after or at the defined request time will be included in the response.

Limit int
  • 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
  • Must be supplied in ISO 4217 format

Accepted values:

  • "CZK" (Czech crown)
  • "EUR" (Euro)
  • "HUF" (Hungarian forint)
  • "USD" (U.S. dollar)
 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.
  • NoChange: the account's balance did not change after the transaction
  • Credit: the account's balance has increased after the transaction
  • Debit: the account's balance has decreased after the transaction

To find out which errors this endpoint can produce, visit the Error codes page.

Retrieved from "https://docs.barion.com/index.php?title=UserHistory-GetHistory-v3&oldid=4184"