|
|
Line 13: |
Line 13: |
| * [[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=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 == |
Revision as of 14:16, 17 March 2023
Barion API: transaction history details
GET
|
/v3/TransactionHistory/GetDetail
|
The /v3/TransactionHistory/GetDetail
API endpoint is used to query the details of the specified transaction history element.
Prerequisites before use:
Authentication
Barion Wallet Authentication
Input properties
The input properties should be defined in the query string.
Property name
|
Property type
|
Limitations and constraints
|
Description
|
ItemId |
Guid |
* Required |
The identifier of the history element.
|
Input properties
Output properties
Property name
|
Property type
|
Description
|
DetailInformation |
custom structure |
The data structure depends on the history item type. The structures are linked below.
|
History item structures:
Custom structures
BankTransferPayment
Property name
|
Property type
|
Description
|
HistoryId |
Guid |
The identifier of the transaction.
|
HistoryType |
HistoryItemType |
The type of the transaction.
|
HappenedAtUtc |
DateTime |
The exact time when the transaction happened.
|
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.
|
BankTransferPaymentFee
Property name
|
Property type
|
Description
|
HistoryId |
Guid |
The identifier of the transaction.
|
HistoryType |
HistoryItemType |
The type of the transaction.
|
HappenedAtUtc |
DateTime |
The exact time when the transaction happened.
|
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.
|
BlockAmount
Property name
|
Property type
|
Description
|
HistoryId |
Guid |
The identifier of the transaction.
|
HistoryType |
HistoryItemType |
The type of the transaction.
|
HappenedAtUtc |
DateTime |
The exact time when the transaction happened.
|
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.
|
CardPayment
Property name
|
Property type
|
Description
|
HistoryId |
Guid |
The identifier of the transaction.
|
HistoryType |
HistoryItemType |
The type of the transaction.
|
HappenedAtUtc |
DateTime |
The exact time when the transaction happened.
|
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.
|
CardProcessingFee
Property name
|
Property type
|
Description
|
HistoryId |
Guid |
The identifier of the transaction.
|
HistoryType |
HistoryItemType |
The type of the transaction.
|
HappenedAtUtc |
DateTime |
The exact time when the transaction happened.
|
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.
|
CardTopUp
Property name
|
Property type
|
Description
|
HistoryId |
Guid |
The identifier of the transaction.
|
HistoryType |
HistoryItemType |
The type of the transaction.
|
HappenedAtUtc |
DateTime |
The exact time when the transaction happened.
|
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.
|
CashTopUp
Property name
|
Property type
|
Description
|
HistoryId |
Guid |
The identifier of the transaction.
|
HistoryType |
HistoryItemType |
The type of the transaction.
|
HappenedAtUtc |
DateTime |
The exact time when the transaction happened.
|
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.
|
Comission
Property name
|
Property type
|
Description
|
HistoryId |
Guid |
The identifier of the transaction.
|
HistoryType |
HistoryItemType |
The type of the transaction.
|
HappenedAtUtc |
DateTime |
The exact time when the transaction happened.
|
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.
|
Donation
Property name
|
Property type
|
Description
|
HistoryId |
Guid |
The identifier of the transaction.
|
HistoryType |
HistoryItemType |
The type of the transaction.
|
HappenedAtUtc |
DateTime |
The exact time when the transaction happened.
|
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.
|
ElectronicMoneyPayment
Property name
|
Property type
|
Description
|
HistoryId |
Guid |
The identifier of the transaction.
|
HistoryType |
HistoryItemType |
The type of the transaction.
|
HappenedAtUtc |
DateTime |
The exact time when the transaction happened.
|
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.
|
ExternalTransfer
Property name
|
Property type
|
Description
|
HistoryId |
Guid |
The identifier of the transaction.
|
HistoryType |
HistoryItemType |
The type of the transaction.
|
HappenedAtUtc |
DateTime |
The exact time when the transaction happened.
|
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.
|
GatewayFee
Property name
|
Property type
|
Description
|
HistoryId |
Guid |
The identifier of the transaction.
|
HistoryType |
HistoryItemType |
The type of the transaction.
|
HappenedAtUtc |
DateTime |
The exact time when the transaction happened.
|
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.
|
InternalTransfer
Property name
|
Property type
|
Description
|
HistoryId |
Guid |
The identifier of the transaction.
|
HistoryType |
HistoryItemType |
The type of the transaction.
|
HappenedAtUtc |
DateTime |
The exact time when the transaction happened.
|
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.
|
IssueFromCustody
Property name
|
Property type
|
Description
|
HistoryId |
Guid |
The identifier of the transaction.
|
HistoryType |
HistoryItemType |
The type of the transaction.
|
HappenedAtUtc |
DateTime |
The exact time when the transaction happened.
|
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.
|
PayeeTransaction
Property name
|
Property type
|
Description
|
HistoryId |
Guid |
The identifier of the transaction.
|
HistoryType |
HistoryItemType |
The type of the transaction.
|
HappenedAtUtc |
DateTime |
The exact time when the transaction happened.
|
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.
|
RefundToBankAccount
Property name
|
Property type
|
Description
|
HistoryId |
Guid |
The identifier of the transaction.
|
HistoryType |
HistoryItemType |
The type of the transaction.
|
HappenedAtUtc |
DateTime |
The exact time when the transaction happened.
|
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.
|
RefundToCard
Property name
|
Property type
|
Description
|
HistoryId |
Guid |
The identifier of the transaction.
|
HistoryType |
HistoryItemType |
The type of the transaction.
|
HappenedAtUtc |
DateTime |
The exact time when the transaction happened.
|
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.
|
RefundToWallet
Property name
|
Property type
|
Description
|
HistoryId |
Guid |
The identifier of the transaction.
|
HistoryType |
HistoryItemType |
The type of the transaction.
|
HappenedAtUtc |
DateTime |
The exact time when the transaction happened.
|
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.
|
RejectedWithdraw
Property name
|
Property type
|
Description
|
HistoryId |
Guid |
The identifier of the transaction.
|
HistoryType |
HistoryItemType |
The type of the transaction.
|
HappenedAtUtc |
DateTime |
The exact time when the transaction happened.
|
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.
|
RejectedWithdrawFee
Property name
|
Property type
|
Description
|
HistoryId |
Guid |
The identifier of the transaction.
|
HistoryType |
HistoryItemType |
The type of the transaction.
|
HappenedAtUtc |
DateTime |
The exact time when the transaction happened.
|
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.
|
ReleaseAmount
Property name
|
Property type
|
Description
|
HistoryId |
Guid |
The identifier of the transaction.
|
HistoryType |
HistoryItemType |
The type of the transaction.
|
HappenedAtUtc |
DateTime |
The exact time when the transaction happened.
|
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.
|
UnsuccessfulRefundToBankAccount
Property name
|
Property type
|
Description
|
HistoryId |
Guid |
The identifier of the transaction.
|
HistoryType |
HistoryItemType |
The type of the transaction.
|
HappenedAtUtc |
DateTime |
The exact time when the transaction happened.
|
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.
|
UnsuccessfulRefundToCard
Property name
|
Property type
|
Description
|
HistoryId |
Guid |
The identifier of the transaction.
|
HistoryType |
HistoryItemType |
The type of the transaction.
|
HappenedAtUtc |
DateTime |
The exact time when the transaction happened.
|
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.
|
UnsuccessfulTransfer
Property name
|
Property type
|
Description
|
HistoryId |
Guid |
The identifier of the transaction.
|
HistoryType |
HistoryItemType |
The type of the transaction.
|
HappenedAtUtc |
DateTime |
The exact time when the transaction happened.
|
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.
|
UnsuccessfulWithdraw
Property name
|
Property type
|
Description
|
HistoryId |
Guid |
The identifier of the transaction.
|
HistoryType |
HistoryItemType |
The type of the transaction.
|
HappenedAtUtc |
DateTime |
The exact time when the transaction happened.
|
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.
|
WireTopUp
Property name
|
Property type
|
Description
|
HistoryId |
Guid |
The identifier of the transaction.
|
HistoryType |
HistoryItemType |
The type of the transaction.
|
HappenedAtUtc |
DateTime |
The exact time when the transaction happened.
|
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.
|
Withdraw
Property name
|
Property type
|
Description
|
HistoryId |
Guid |
The identifier of the transaction.
|
HistoryType |
HistoryItemType |
The type of the transaction.
|
HappenedAtUtc |
DateTime |
The exact time when the transaction happened.
|
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.
|
WithdrawFee
Property name
|
Property type
|
Description
|
HistoryId |
Guid |
The identifier of the transaction.
|
HistoryType |
HistoryItemType |
The type of the transaction.
|
HappenedAtUtc |
DateTime |
The exact time when the transaction happened.
|
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.
|